Docs Home
We recommend using Azure Native.
azure.portal.PortalDashboard
Explore with Pulumi AI
Import
Dashboards can be imported using the resource id, e.g.
$ pulumi import azure:portal/portalDashboard:PortalDashboard my-board /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Portal/dashboards/00000000-0000-0000-0000-000000000000
Note the URI in the above sample can be found using the Resource Explorer tool in the Azure Portal.
Create PortalDashboard Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PortalDashboard(name: string, args: PortalDashboardArgs, opts?: CustomResourceOptions);@overload
def PortalDashboard(resource_name: str,
args: PortalDashboardArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PortalDashboard(resource_name: str,
opts: Optional[ResourceOptions] = None,
dashboard_properties: Optional[str] = None,
resource_group_name: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)func NewPortalDashboard(ctx *Context, name string, args PortalDashboardArgs, opts ...ResourceOption) (*PortalDashboard, error)public PortalDashboard(string name, PortalDashboardArgs args, CustomResourceOptions? opts = null)
public PortalDashboard(String name, PortalDashboardArgs args)
public PortalDashboard(String name, PortalDashboardArgs args, CustomResourceOptions options)
type: azure:portal:PortalDashboard
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PortalDashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PortalDashboardArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PortalDashboardArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PortalDashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PortalDashboardArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var portalDashboardResource = new Azure.Portal.PortalDashboard("portalDashboardResource", new()
{
DashboardProperties = "string",
ResourceGroupName = "string",
Location = "string",
Name = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := portal.NewPortalDashboard(ctx, "portalDashboardResource", &portal.PortalDashboardArgs{
DashboardProperties: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var portalDashboardResource = new PortalDashboard("portalDashboardResource", PortalDashboardArgs.builder()
.dashboardProperties("string")
.resourceGroupName("string")
.location("string")
.name("string")
.tags(Map.of("string", "string"))
.build());
portal_dashboard_resource = azure.portal.PortalDashboard("portalDashboardResource",
dashboard_properties="string",
resource_group_name="string",
location="string",
name="string",
tags={
"string": "string",
})
const portalDashboardResource = new azure.portal.PortalDashboard("portalDashboardResource", {
dashboardProperties: "string",
resourceGroupName: "string",
location: "string",
name: "string",
tags: {
string: "string",
},
});
type: azure:portal:PortalDashboard
properties:
dashboardProperties: string
location: string
name: string
resourceGroupName: string
tags:
string: string
PortalDashboard Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PortalDashboard resource accepts the following input properties:
- Dashboard
Properties string - JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
- Resource
Group stringName - The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
Note: You can specify a tag with the key
hidden-titleto set a more user-friendly title for this Dashboard.- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Dashboard
Properties string - JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
- Resource
Group stringName - The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
Note: You can specify a tag with the key
hidden-titleto set a more user-friendly title for this Dashboard.- map[string]string
- A mapping of tags to assign to the resource.
- dashboard
Properties String - JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
- resource
Group StringName - The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
Note: You can specify a tag with the key
hidden-titleto set a more user-friendly title for this Dashboard.- Map<String,String>
- A mapping of tags to assign to the resource.
- dashboard
Properties string - JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
- resource
Group stringName - The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
- location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name string
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
Note: You can specify a tag with the key
hidden-titleto set a more user-friendly title for this Dashboard.- {[key: string]: string}
- A mapping of tags to assign to the resource.
- dashboard_
properties str - JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
- resource_
group_ strname - The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
- location str
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name str
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
Note: You can specify a tag with the key
hidden-titleto set a more user-friendly title for this Dashboard.- Mapping[str, str]
- A mapping of tags to assign to the resource.
- dashboard
Properties String - JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
- resource
Group StringName - The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
Note: You can specify a tag with the key
hidden-titleto set a more user-friendly title for this Dashboard.- Map<String>
- A mapping of tags to assign to the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the PortalDashboard resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing PortalDashboard Resource
Get an existing PortalDashboard resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PortalDashboardState, opts?: CustomResourceOptions): PortalDashboard@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
dashboard_properties: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None) -> PortalDashboardfunc GetPortalDashboard(ctx *Context, name string, id IDInput, state *PortalDashboardState, opts ...ResourceOption) (*PortalDashboard, error)public static PortalDashboard Get(string name, Input<string> id, PortalDashboardState? state, CustomResourceOptions? opts = null)public static PortalDashboard get(String name, Output<String> id, PortalDashboardState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Dashboard
Properties string - JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
Note: You can specify a tag with the key
hidden-titleto set a more user-friendly title for this Dashboard.- Resource
Group stringName - The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Dashboard
Properties string - JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
Note: You can specify a tag with the key
hidden-titleto set a more user-friendly title for this Dashboard.- Resource
Group stringName - The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
- map[string]string
- A mapping of tags to assign to the resource.
- dashboard
Properties String - JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
Note: You can specify a tag with the key
hidden-titleto set a more user-friendly title for this Dashboard.- resource
Group StringName - The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
- Map<String,String>
- A mapping of tags to assign to the resource.
- dashboard
Properties string - JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
- location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name string
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
Note: You can specify a tag with the key
hidden-titleto set a more user-friendly title for this Dashboard.- resource
Group stringName - The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- dashboard_
properties str - JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
- location str
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name str
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
Note: You can specify a tag with the key
hidden-titleto set a more user-friendly title for this Dashboard.- resource_
group_ strname - The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
- Mapping[str, str]
- A mapping of tags to assign to the resource.
- dashboard
Properties String - JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
Note: You can specify a tag with the key
hidden-titleto set a more user-friendly title for this Dashboard.- resource
Group StringName - The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
- Map<String>
- A mapping of tags to assign to the resource.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.