Microsoft.Dashboard grafana
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@2023-09-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
apiKey: 'string'
autoGeneratedDomainNameLabelScope: 'TenantReuse'
deterministicOutboundIP: 'string'
enterpriseConfigurations: {
marketplaceAutoRenew: 'string'
marketplacePlanId: 'string'
}
grafanaConfigurations: {
smtp: {
enabled: bool
fromAddress: 'string'
fromName: 'string'
host: 'string'
password: 'string'
skipVerify: bool
startTLSPolicy: 'string'
user: 'string'
}
}
grafanaIntegrations: {
azureMonitorWorkspaceIntegrations: [
{
azureMonitorWorkspaceResourceId: 'string'
}
]
}
grafanaMajorVersion: 'string'
grafanaPlugins: {
{customized property}: {}
}
publicNetworkAccess: '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. | ManagedServiceIdentity |
| properties | Properties specific to the grafana resource. | ManagedGrafanaProperties |
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 |
UserAssignedIdentities
| 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 |
|---|---|---|
| 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' |
| enterpriseConfigurations | Enterprise settings of a Grafana instance | EnterpriseConfigurations |
| grafanaConfigurations | Server configurations of a Grafana instance | GrafanaConfigurations |
| grafanaIntegrations | GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. | GrafanaIntegrations |
| grafanaMajorVersion | The major Grafana software version to target. | string |
| grafanaPlugins | Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition. | ManagedGrafanaPropertiesGrafanaPlugins |
| 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' |
EnterpriseConfigurations
| Name | Description | Value |
|---|---|---|
| marketplaceAutoRenew | The AutoRenew setting of the Enterprise subscription | 'Disabled' 'Enabled' |
| marketplacePlanId | The Plan Id of the Azure Marketplace subscription for the Enterprise plugins | string |
GrafanaConfigurations
| Name | Description | Value |
|---|---|---|
| smtp | Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp |
Smtp |
Smtp
| Name | Description | Value |
|---|---|---|
| enabled | Enable this to allow Grafana to send email. Default is false | bool |
| fromAddress | Address used when sending out emails https://pkg.go.dev/net/mail#Address |
string |
| fromName | Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address |
string |
| host | SMTP server hostname with port, e.g. test.email.net:587 | string |
| password | Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes | string Constraints: Sensitive value. Pass in as a secure parameter. |
| skipVerify | Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config |
bool |
| startTLSPolicy | The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy |
'MandatoryStartTLS' 'NoStartTLS' 'OpportunisticStartTLS' |
| user | User of SMTP auth | string |
GrafanaIntegrations
| Name | Description | Value |
|---|---|---|
| azureMonitorWorkspaceIntegrations | AzureMonitorWorkspaceIntegration[] |
AzureMonitorWorkspaceIntegration
| Name | Description | Value |
|---|---|---|
| azureMonitorWorkspaceResourceId | The resource Id of the connected Azure Monitor Workspace. | string |
ManagedGrafanaPropertiesGrafanaPlugins
| Name | Description | Value |
|---|---|---|
| {customized property} | GrafanaPlugin |
GrafanaPlugin
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
ResourceSku
| Name | Description | Value |
|---|---|---|
| name | string (required) |
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": "2023-09-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"apiKey": "string",
"autoGeneratedDomainNameLabelScope": "TenantReuse",
"deterministicOutboundIP": "string",
"enterpriseConfigurations": {
"marketplaceAutoRenew": "string",
"marketplacePlanId": "string"
},
"grafanaConfigurations": {
"smtp": {
"enabled": "bool",
"fromAddress": "string",
"fromName": "string",
"host": "string",
"password": "string",
"skipVerify": "bool",
"startTLSPolicy": "string",
"user": "string"
}
},
"grafanaIntegrations": {
"azureMonitorWorkspaceIntegrations": [
{
"azureMonitorWorkspaceResourceId": "string"
}
]
},
"grafanaMajorVersion": "string",
"grafanaPlugins": {
"{customized property}": {}
},
"publicNetworkAccess": "string",
"zoneRedundancy": "string"
}
}
Property values
grafana
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Dashboard/grafana' |
| apiVersion | The resource api version | '2023-09-01' |
| 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. | ManagedServiceIdentity |
| properties | Properties specific to the grafana resource. | ManagedGrafanaProperties |
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 |
UserAssignedIdentities
| 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 |
|---|---|---|
| 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' |
| enterpriseConfigurations | Enterprise settings of a Grafana instance | EnterpriseConfigurations |
| grafanaConfigurations | Server configurations of a Grafana instance | GrafanaConfigurations |
| grafanaIntegrations | GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. | GrafanaIntegrations |
| grafanaMajorVersion | The major Grafana software version to target. | string |
| grafanaPlugins | Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition. | ManagedGrafanaPropertiesGrafanaPlugins |
| 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' |
EnterpriseConfigurations
| Name | Description | Value |
|---|---|---|
| marketplaceAutoRenew | The AutoRenew setting of the Enterprise subscription | 'Disabled' 'Enabled' |
| marketplacePlanId | The Plan Id of the Azure Marketplace subscription for the Enterprise plugins | string |
GrafanaConfigurations
| Name | Description | Value |
|---|---|---|
| smtp | Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp |
Smtp |
Smtp
| Name | Description | Value |
|---|---|---|
| enabled | Enable this to allow Grafana to send email. Default is false | bool |
| fromAddress | Address used when sending out emails https://pkg.go.dev/net/mail#Address |
string |
| fromName | Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address |
string |
| host | SMTP server hostname with port, e.g. test.email.net:587 | string |
| password | Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes | string Constraints: Sensitive value. Pass in as a secure parameter. |
| skipVerify | Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config |
bool |
| startTLSPolicy | The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy |
'MandatoryStartTLS' 'NoStartTLS' 'OpportunisticStartTLS' |
| user | User of SMTP auth | string |
GrafanaIntegrations
| Name | Description | Value |
|---|---|---|
| azureMonitorWorkspaceIntegrations | AzureMonitorWorkspaceIntegration[] |
AzureMonitorWorkspaceIntegration
| Name | Description | Value |
|---|---|---|
| azureMonitorWorkspaceResourceId | The resource Id of the connected Azure Monitor Workspace. | string |
ManagedGrafanaPropertiesGrafanaPlugins
| Name | Description | Value |
|---|---|---|
| {customized property} | GrafanaPlugin |
GrafanaPlugin
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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@2023-09-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
apiKey = "string"
autoGeneratedDomainNameLabelScope = "TenantReuse"
deterministicOutboundIP = "string"
enterpriseConfigurations = {
marketplaceAutoRenew = "string"
marketplacePlanId = "string"
}
grafanaConfigurations = {
smtp = {
enabled = bool
fromAddress = "string"
fromName = "string"
host = "string"
password = "string"
skipVerify = bool
startTLSPolicy = "string"
user = "string"
}
}
grafanaIntegrations = {
azureMonitorWorkspaceIntegrations = [
{
azureMonitorWorkspaceResourceId = "string"
}
]
}
grafanaMajorVersion = "string"
grafanaPlugins = {
{customized property} = {}
}
publicNetworkAccess = "string"
zoneRedundancy = "string"
}
sku = {
name = "string"
}
})
}
Property values
grafana
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Dashboard/grafana@2023-09-01" |
| 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. | ManagedServiceIdentity |
| properties | Properties specific to the grafana resource. | ManagedGrafanaProperties |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (required) |
| identity_ids | 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. | Array of user identity IDs. |
UserAssignedIdentities
| 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 |
|---|---|---|
| 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" |
| enterpriseConfigurations | Enterprise settings of a Grafana instance | EnterpriseConfigurations |
| grafanaConfigurations | Server configurations of a Grafana instance | GrafanaConfigurations |
| grafanaIntegrations | GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. | GrafanaIntegrations |
| grafanaMajorVersion | The major Grafana software version to target. | string |
| grafanaPlugins | Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition. | ManagedGrafanaPropertiesGrafanaPlugins |
| 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" |
EnterpriseConfigurations
| Name | Description | Value |
|---|---|---|
| marketplaceAutoRenew | The AutoRenew setting of the Enterprise subscription | "Disabled" "Enabled" |
| marketplacePlanId | The Plan Id of the Azure Marketplace subscription for the Enterprise plugins | string |
GrafanaConfigurations
| Name | Description | Value |
|---|---|---|
| smtp | Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp |
Smtp |
Smtp
| Name | Description | Value |
|---|---|---|
| enabled | Enable this to allow Grafana to send email. Default is false | bool |
| fromAddress | Address used when sending out emails https://pkg.go.dev/net/mail#Address |
string |
| fromName | Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address |
string |
| host | SMTP server hostname with port, e.g. test.email.net:587 | string |
| password | Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes | string Constraints: Sensitive value. Pass in as a secure parameter. |
| skipVerify | Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config |
bool |
| startTLSPolicy | The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy |
"MandatoryStartTLS" "NoStartTLS" "OpportunisticStartTLS" |
| user | User of SMTP auth | string |
GrafanaIntegrations
| Name | Description | Value |
|---|---|---|
| azureMonitorWorkspaceIntegrations | AzureMonitorWorkspaceIntegration[] |
AzureMonitorWorkspaceIntegration
| Name | Description | Value |
|---|---|---|
| azureMonitorWorkspaceResourceId | The resource Id of the connected Azure Monitor Workspace. | string |
ManagedGrafanaPropertiesGrafanaPlugins
| Name | Description | Value |
|---|---|---|
| {customized property} | GrafanaPlugin |
GrafanaPlugin
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
ResourceSku
| Name | Description | Value |
|---|---|---|
| name | string (required) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for