Azure Classic v5.38.0, Mar 21 23

azure.portal.PortalDashboard

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

new PortalDashboard(name: string, args: PortalDashboardArgs, opts?: CustomResourceOptions);

@overload
def PortalDashboard(resource_name: 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)
@overload
def PortalDashboard(resource_name: str,
                    args: PortalDashboardArgs,
                    opts: Optional[ResourceOptions] = 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.

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.

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:

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

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

resourceGroupName String: The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
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.
tags Map<String,String>: A mapping of tags to assign to the resource.

resourceGroupName string: The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
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.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

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.
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.
tags Mapping[str, str]: A mapping of tags to assign to the resource.

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