1. Packages
  2. Azure Native
  3. API Docs
  4. dashboard
  5. getDashboardDefinition
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi

    Get the properties of a specific dashboard definition.

    Uses Azure REST API version 2025-09-01-preview.

    Using getDashboardDefinition

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDashboardDefinition(args: GetDashboardDefinitionArgs, opts?: InvokeOptions): Promise<GetDashboardDefinitionResult>
    function getDashboardDefinitionOutput(args: GetDashboardDefinitionOutputArgs, opts?: InvokeOptions): Output<GetDashboardDefinitionResult>
    def get_dashboard_definition(dashboard_name: Optional[str] = None,
                                 definition_name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetDashboardDefinitionResult
    def get_dashboard_definition_output(dashboard_name: Optional[pulumi.Input[str]] = None,
                                 definition_name: Optional[pulumi.Input[str]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetDashboardDefinitionResult]
    func LookupDashboardDefinition(ctx *Context, args *LookupDashboardDefinitionArgs, opts ...InvokeOption) (*LookupDashboardDefinitionResult, error)
    func LookupDashboardDefinitionOutput(ctx *Context, args *LookupDashboardDefinitionOutputArgs, opts ...InvokeOption) LookupDashboardDefinitionResultOutput

    > Note: This function is named LookupDashboardDefinition in the Go SDK.

    public static class GetDashboardDefinition 
    {
        public static Task<GetDashboardDefinitionResult> InvokeAsync(GetDashboardDefinitionArgs args, InvokeOptions? opts = null)
        public static Output<GetDashboardDefinitionResult> Invoke(GetDashboardDefinitionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDashboardDefinitionResult> getDashboardDefinition(GetDashboardDefinitionArgs args, InvokeOptions options)
    public static Output<GetDashboardDefinitionResult> getDashboardDefinition(GetDashboardDefinitionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:dashboard:getDashboardDefinition
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DashboardName string
    The name of the Azure Managed Dashboard.
    DefinitionName string
    The name of the Dashboard Definition.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    DashboardName string
    The name of the Azure Managed Dashboard.
    DefinitionName string
    The name of the Dashboard Definition.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    dashboardName String
    The name of the Azure Managed Dashboard.
    definitionName String
    The name of the Dashboard Definition.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    dashboardName string
    The name of the Azure Managed Dashboard.
    definitionName string
    The name of the Dashboard Definition.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    dashboard_name str
    The name of the Azure Managed Dashboard.
    definition_name str
    The name of the Dashboard Definition.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    dashboardName String
    The name of the Azure Managed Dashboard.
    definitionName String
    The name of the Dashboard Definition.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getDashboardDefinition Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.Dashboard.Outputs.DashboardDefinitionPropertiesResponse
    Properties specific to the dashboard definition resource.
    SystemData Pulumi.AzureNative.Dashboard.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    Properties DashboardDefinitionPropertiesResponse
    Properties specific to the dashboard definition resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    properties DashboardDefinitionPropertiesResponse
    Properties specific to the dashboard definition resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    properties DashboardDefinitionPropertiesResponse
    Properties specific to the dashboard definition resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    properties DashboardDefinitionPropertiesResponse
    Properties specific to the dashboard definition resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    properties Property Map
    Properties specific to the dashboard definition resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    DashboardDefinitionPropertiesResponse

    ProvisioningState string
    The provisioning state of the dashboard definition resource.
    SerializedData string
    The dashboard definition data in JSON format.
    ProvisioningState string
    The provisioning state of the dashboard definition resource.
    SerializedData string
    The dashboard definition data in JSON format.
    provisioningState String
    The provisioning state of the dashboard definition resource.
    serializedData String
    The dashboard definition data in JSON format.
    provisioningState string
    The provisioning state of the dashboard definition resource.
    serializedData string
    The dashboard definition data in JSON format.
    provisioning_state str
    The provisioning state of the dashboard definition resource.
    serialized_data str
    The dashboard definition data in JSON format.
    provisioningState String
    The provisioning state of the dashboard definition resource.
    serializedData String
    The dashboard definition data in JSON format.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate