Microsoft.Dashboard grafana 2021-09-01-preview

  • Article

Bicep resource definition

The grafana 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/grafana resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Dashboard/grafana@2021-09-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    autoGeneratedDomainNameLabelScope: 'TenantReuse'
    provisioningState: 'string'
    zoneRedundancy: 'string'
  }
}

Property values

grafana

Name Description Value
name The resource name string (required)
location The geo-location where the grafana resource lives string
tags The tags for grafana resource. Dictionary of tag names and values. See Tags in templates
sku The Sku of the grafana resource. ResourceSku
identity The managed identity of the grafana resource. ManagedIdentity
properties Properties specific to the grafana resource. ManagedGrafanaProperties

ManagedIdentity

Name Description Value
type The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the resource. 'None'
'SystemAssigned'
userAssignedIdentities Dictionary of user assigned identities. ManagedIdentityUserAssignedIdentities

ManagedIdentityUserAssignedIdentities

Name Description Value
{customized property} UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ManagedGrafanaProperties

Name Description Value
autoGeneratedDomainNameLabelScope 'TenantReuse'
provisioningState Provisioning state of the resource. 'Accepted'
'Canceled'
'Creating'
'Deleted'
'Deleting'
'Failed'
'NotSpecified'
'Succeeded'
'Updating'
zoneRedundancy 'Disabled'
'Enabled'

ResourceSku

Name Description Value
name string (required)

ARM template resource definition

The grafana 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/grafana resource, add the following JSON to your template.

{
  "type": "Microsoft.Dashboard/grafana",
  "apiVersion": "2021-09-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "autoGeneratedDomainNameLabelScope": "TenantReuse",
    "provisioningState": "string",
    "zoneRedundancy": "string"
  }
}

Property values

grafana

Name Description Value
type The resource type 'Microsoft.Dashboard/grafana'
apiVersion The resource api version '2021-09-01-preview'
name The resource name string (required)
location The geo-location where the grafana resource lives string
tags The tags for grafana resource. Dictionary of tag names and values. See Tags in templates
sku The Sku of the grafana resource. ResourceSku
identity The managed identity of the grafana resource. ManagedIdentity
properties Properties specific to the grafana resource. ManagedGrafanaProperties

ManagedIdentity

Name Description Value
type The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the resource. 'None'
'SystemAssigned'
userAssignedIdentities Dictionary of user assigned identities. ManagedIdentityUserAssignedIdentities

ManagedIdentityUserAssignedIdentities

Name Description Value
{customized property} UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ManagedGrafanaProperties

Name Description Value
autoGeneratedDomainNameLabelScope 'TenantReuse'
provisioningState Provisioning state of the resource. 'Accepted'
'Canceled'
'Creating'
'Deleted'
'Deleting'
'Failed'
'NotSpecified'
'Succeeded'
'Updating'
zoneRedundancy 'Disabled'
'Enabled'

ResourceSku

Name Description Value
name string (required)

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Dashboard/grafana@2021-09-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      autoGeneratedDomainNameLabelScope = "TenantReuse"
      provisioningState = "string"
      zoneRedundancy = "string"
    }
    sku = {
      name = "string"
    }
  })
}

Property values

grafana

Name Description Value
type The resource type "Microsoft.Dashboard/grafana@2021-09-01-preview"
name The resource name string (required)
location The geo-location where the grafana resource lives string
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags The tags for grafana resource. Dictionary of tag names and values.
sku The Sku of the grafana resource. ResourceSku
identity The managed identity of the grafana resource. ManagedIdentity
properties Properties specific to the grafana resource. ManagedGrafanaProperties

ManagedIdentity

Name Description Value
type The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the resource. "SystemAssigned"
identity_ids Dictionary of user assigned identities. Array of user identity IDs.

ManagedIdentityUserAssignedIdentities

Name Description Value
{customized property} UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ManagedGrafanaProperties

Name Description Value
autoGeneratedDomainNameLabelScope "TenantReuse"
provisioningState Provisioning state of the resource. "Accepted"
"Canceled"
"Creating"
"Deleted"
"Deleting"
"Failed"
"NotSpecified"
"Succeeded"
"Updating"
zoneRedundancy "Disabled"
"Enabled"

ResourceSku

Name Description Value
name string (required)