Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. portal
  5. PortalDashboard

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

azure.portal.PortalDashboard

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

    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

    The PortalDashboard resource accepts the following input properties:

    DashboardProperties string
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    ResourceGroupName string
    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-title to set a more user-friendly title for this Dashboard.

    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    DashboardProperties string
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    ResourceGroupName string
    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-title to set a more user-friendly title for this Dashboard.

    Tags map[string]string
    A mapping of tags to assign to the resource.
    dashboardProperties String
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    resourceGroupName String
    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-title to set a more user-friendly title for this Dashboard.

    tags Map<String,String>
    A mapping of tags to assign to the resource.
    dashboardProperties string
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    resourceGroupName string
    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-title to set a more user-friendly title for this Dashboard.

    tags {[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_name str
    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-title to set a more user-friendly title for this Dashboard.

    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    dashboardProperties String
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    resourceGroupName String
    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-title to set a more user-friendly title for this Dashboard.

    tags 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) -> PortalDashboard
    func 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.
    The following state arguments are supported:
    DashboardProperties 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-title to set a more user-friendly title for this Dashboard.

    ResourceGroupName string
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    DashboardProperties 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-title to set a more user-friendly title for this Dashboard.

    ResourceGroupName string
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    dashboardProperties 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-title to set a more user-friendly title for this Dashboard.

    resourceGroupName String
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    dashboardProperties 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-title to set a more user-friendly title for this Dashboard.

    resourceGroupName string
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    tags {[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-title to set a more user-friendly title for this Dashboard.

    resource_group_name str
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    dashboardProperties 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-title to set a more user-friendly title for this Dashboard.

    resourceGroupName String
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    tags 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 azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure