Microsoft.Dashboard dashboards/dashboardDefinitions

Bicep resource definition

The dashboards/dashboardDefinitions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Dashboard/dashboards/dashboardDefinitions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Dashboard/dashboards/dashboardDefinitions@2025-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    serializedData: 'string'
  }
}

Property Values

Microsoft.Dashboard/dashboards/dashboardDefinitions

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-zA-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: dashboards
properties Properties specific to the dashboard definition resource. DashboardDefinitionProperties

DashboardDefinitionProperties

Name Description Value
serializedData The dashboard definition data in JSON format. string

ARM template resource definition

The dashboards/dashboardDefinitions resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.Dashboard/dashboards/dashboardDefinitions resource, add the following JSON to your template.

{
  "type": "Microsoft.Dashboard/dashboards/dashboardDefinitions",
  "apiVersion": "2025-09-01-preview",
  "name": "string",
  "properties": {
    "serializedData": "string"
  }
}

Property Values

Microsoft.Dashboard/dashboards/dashboardDefinitions

Name Description Value
apiVersion The api version '2025-09-01-preview'
name The resource name string

Constraints:
Pattern = ^[a-zA-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]$ (required)
properties Properties specific to the dashboard definition resource. DashboardDefinitionProperties
type The resource type 'Microsoft.Dashboard/dashboards/dashboardDefinitions'

DashboardDefinitionProperties

Name Description Value
serializedData The dashboard definition data in JSON format. string

Terraform (AzAPI provider) resource definition

The dashboards/dashboardDefinitions resource type can be deployed with operations that target:

  • Resource groups For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Dashboard/dashboards/dashboardDefinitions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Dashboard/dashboards/dashboardDefinitions@2025-09-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      serializedData = "string"
    }
  }
}

Property Values

Microsoft.Dashboard/dashboards/dashboardDefinitions

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-zA-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: dashboards
properties Properties specific to the dashboard definition resource. DashboardDefinitionProperties
type The resource type "Microsoft.Dashboard/dashboards/dashboardDefinitions@2025-09-01-preview"

DashboardDefinitionProperties

Name Description Value
serializedData The dashboard definition data in JSON format. string
  • Last updated on