Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The grafana 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.Dashboard/grafana resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Dashboard/grafana@2022-05-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
apiKey: 'string'
autoGeneratedDomainNameLabelScope: 'string'
deterministicOutboundIP: 'string'
publicNetworkAccess: 'string'
zoneRedundancy: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
ManagedGrafanaProperties
| Name | Description | Value |
|---|---|---|
| apiKey | The api key setting of the Grafana instance. | 'Disabled' 'Enabled' |
| autoGeneratedDomainNameLabelScope | Scope for dns deterministic name hash calculation. | 'TenantReuse' |
| deterministicOutboundIP | Whether a Grafana instance uses deterministic outbound IPs. | 'Disabled' 'Enabled' |
| publicNetworkAccess | Indicate the state for enable or disable traffic over the public interface. | 'Disabled' 'Enabled' |
| zoneRedundancy | The zone redundancy setting of the Grafana instance. | 'Disabled' 'Enabled' |
ManagedGrafanaTags
| Name | Description | Value |
|---|
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
Microsoft.Dashboard/grafana
| Name | Description | Value |
|---|---|---|
| identity | The managed identity of the grafana resource. | ManagedServiceIdentity |
| location | The geo-location where the grafana resource lives | string |
| name | The resource name | string (required) |
| properties | Properties specific to the grafana resource. | ManagedGrafanaProperties |
| sku | The Sku of the grafana resource. | ResourceSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ResourceSku
| Name | Description | Value |
|---|---|---|
| name | string (required) |
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Create AKS with Prometheus and Grafana with privae link | This will create an Azure grafana, AKS and install Prometheus, an open-source monitoring and alerting toolkit, on an Azure Kubernetes Service (AKS) cluster. Then you use Azure Managed Grafana's managed private endpoint to connect to this Prometheus server and display the Prometheus data in a Grafana dashboard |
ARM template resource definition
The grafana 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.Dashboard/grafana resource, add the following JSON to your template.
{
"type": "Microsoft.Dashboard/grafana",
"apiVersion": "2022-05-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"apiKey": "string",
"autoGeneratedDomainNameLabelScope": "string",
"deterministicOutboundIP": "string",
"publicNetworkAccess": "string",
"zoneRedundancy": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
ManagedGrafanaProperties
| Name | Description | Value |
|---|---|---|
| apiKey | The api key setting of the Grafana instance. | 'Disabled' 'Enabled' |
| autoGeneratedDomainNameLabelScope | Scope for dns deterministic name hash calculation. | 'TenantReuse' |
| deterministicOutboundIP | Whether a Grafana instance uses deterministic outbound IPs. | 'Disabled' 'Enabled' |
| publicNetworkAccess | Indicate the state for enable or disable traffic over the public interface. | 'Disabled' 'Enabled' |
| zoneRedundancy | The zone redundancy setting of the Grafana instance. | 'Disabled' 'Enabled' |
ManagedGrafanaTags
| Name | Description | Value |
|---|
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
Microsoft.Dashboard/grafana
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-05-01-preview' |
| identity | The managed identity of the grafana resource. | ManagedServiceIdentity |
| location | The geo-location where the grafana resource lives | string |
| name | The resource name | string (required) |
| properties | Properties specific to the grafana resource. | ManagedGrafanaProperties |
| sku | The Sku of the grafana resource. | ResourceSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Dashboard/grafana' |
ResourceSku
| Name | Description | Value |
|---|---|---|
| name | string (required) |
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create AKS with Prometheus and Grafana with privae link |
This will create an Azure grafana, AKS and install Prometheus, an open-source monitoring and alerting toolkit, on an Azure Kubernetes Service (AKS) cluster. Then you use Azure Managed Grafana's managed private endpoint to connect to this Prometheus server and display the Prometheus data in a Grafana dashboard |
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@2022-05-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
apiKey = "string"
autoGeneratedDomainNameLabelScope = "string"
deterministicOutboundIP = "string"
publicNetworkAccess = "string"
zoneRedundancy = "string"
}
sku = {
name = "string"
}
}
}
Property Values
ManagedGrafanaProperties
| Name | Description | Value |
|---|---|---|
| apiKey | The api key setting of the Grafana instance. | 'Disabled' 'Enabled' |
| autoGeneratedDomainNameLabelScope | Scope for dns deterministic name hash calculation. | 'TenantReuse' |
| deterministicOutboundIP | Whether a Grafana instance uses deterministic outbound IPs. | 'Disabled' 'Enabled' |
| publicNetworkAccess | Indicate the state for enable or disable traffic over the public interface. | 'Disabled' 'Enabled' |
| zoneRedundancy | The zone redundancy setting of the Grafana instance. | 'Disabled' 'Enabled' |
ManagedGrafanaTags
| Name | Description | Value |
|---|
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
Microsoft.Dashboard/grafana
| Name | Description | Value |
|---|---|---|
| identity | The managed identity of the grafana resource. | ManagedServiceIdentity |
| location | The geo-location where the grafana resource lives | string |
| name | The resource name | string (required) |
| properties | Properties specific to the grafana resource. | ManagedGrafanaProperties |
| sku | The Sku of the grafana resource. | ResourceSku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Dashboard/grafana@2022-05-01-preview" |
ResourceSku
| Name | Description | Value |
|---|---|---|
| name | string (required) |
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|