Microsoft.Portal dashboards 2018-10-01-preview

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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

Resource format

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

resource symbolicname 'Microsoft.Portal/dashboards@2018-10-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    lenses: {
      {customized property}: {
        metadata: {
          {customized property}: any(...)
        }
        order: int
        parts: {
          {customized property}: {
            metadata: {
              {customized property}: any(...)
            }
            position: {
              colSpan: int
              metadata: {
                {customized property}: any(...)
              }
              rowSpan: int
              x: int
              y: int
            }
          }
        }
      }
    }
    metadata: {
      {customized property}: any(...)
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Portal/dashboards

DashboardLens

DashboardLensMetadata

DashboardLensParts

DashboardPartMetadata

DashboardParts

DashboardPartsPosition

DashboardPartsPositionMetadata

DashboardProperties

DashboardPropertiesLenses

DashboardPropertiesMetadata

DashboardTags

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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

Resource format

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

{
  "type": "Microsoft.Portal/dashboards",
  "apiVersion": "2018-10-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "lenses": {
      "{customized property}": {
        "metadata": {
          "{customized property}": {}
        },
        "order": "int",
        "parts": {
          "{customized property}": {
            "metadata": {
              "{customized property}": {}
            },
            "position": {
              "colSpan": "int",
              "metadata": {
                "{customized property}": {}
              },
              "rowSpan": "int",
              "x": "int",
              "y": "int"
            }
          }
        }
      }
    },
    "metadata": {
      "{customized property}": {}
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Portal/dashboards

DashboardLens

DashboardLensMetadata

DashboardLensParts

DashboardPartMetadata

DashboardParts

DashboardPartsPosition

DashboardPartsPositionMetadata

DashboardProperties

DashboardPropertiesLenses

DashboardPropertiesMetadata

DashboardTags

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Create an Azure ML monitoring dashboard	This template creates an AML dashboard on top of existing Log Analytics workspaces diagnostics data
Create an Azure portal dashboard	This template creates an example dashboard in the Azure portal, showing performance of an existing virtual machine in your subscription, as well as some static information and links.
Deploy a simple Azure Spring Apps microservice application	This template deploys a simple Azure Spring Apps microservice application to run on Azure.
Shared default dashboard	In order to make an application operational it helps to have a shared dashboard view of the services that make up the system. This dashboard provides a quickstart for customizing and sharing that with others on the team.

Terraform (AzAPI provider) resource definition

The dashboards 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.Portal/dashboards resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Portal/dashboards@2018-10-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      lenses = {
        {customized property} = {
          metadata = {
            {customized property} = ?
          }
          order = int
          parts = {
            {customized property} = {
              metadata = {
                {customized property} = ?
              }
              position = {
                colSpan = int
                metadata = {
                  {customized property} = ?
                }
                rowSpan = int
                x = int
                y = int
              }
            }
          }
        }
      }
      metadata = {
        {customized property} = ?
      }
    }
  }
}

Property Values

Microsoft.Portal/dashboards

DashboardLens

DashboardLensMetadata

DashboardLensParts

DashboardPartMetadata

DashboardParts

DashboardPartsPosition

DashboardPartsPositionMetadata

DashboardProperties

DashboardPropertiesLenses

DashboardPropertiesMetadata

DashboardTags

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.