Microsoft.Dashboard (preview:2024-11-01)

2025/07/18 • 5 updated methods

Grafana_List (updated)
Description :  List all resources of workspaces for Grafana under the specified subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Grafana_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_467ce38d19a24833ae415cffa4547dcf": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_9786278c2191454eb509aaf6456ef924": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Dashboard/grafana
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ManagedGrafana items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties specific to the grafana resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaVersion:
{
Description: The Grafana software version. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of the Grafana instance. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicate the state for enable or disable traffic over the public interface. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: The zone redundancy setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiKey:
{
Description: The api key setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
deterministicOutboundIP:
{
Description: Whether a Grafana instance uses deterministic outbound IPs. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
outboundIPs:
{
Description: List of outbound IPs if deterministicOutboundIP is enabled. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: The private endpoint connections of the Grafana instance. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The private endpoint connection group ids. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope:
{
Description: Scope for dns deterministic name hash calculation. ,
Enum:
{
TenantReuse: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaIntegrations:
{
Description: GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. ,
Required: False ,
}
{
azureMonitorWorkspaceIntegrations:
{
Required: False ,
}
[
{
azureMonitorWorkspaceResourceId:
{
Description: The resource Id of the connected Azure Monitor Workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
Description: Enterprise settings of a Grafana instance ,
Required: False ,
}
{
marketplacePlanId:
{
Description: The Plan Id of the Azure Marketplace subscription for the Enterprise plugins ,
Required: False ,
}
string ,
marketplaceAutoRenew:
{
Description: The AutoRenew setting of the Enterprise subscription ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
grafanaConfigurations:
{
Description: Server configurations of a Grafana instance ,
Required: False ,
}
{
smtp:
{
Description: Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp ,
Required: False ,
}
{
enabled:
{
Description: Enable this to allow Grafana to send email. Default is false ,
Required: False ,
}
boolean ,
host:
{
Description: SMTP server hostname with port, e.g. test.email.net:587 ,
Required: False ,
}
string ,
user:
{
Description: User of SMTP auth ,
Required: False ,
}
string ,
password:
{
Description: Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes ,
Format: password ,
Required: False ,
}
string ,
fromAddress:
{
Description: Address used when sending out emails https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
fromName:
{
Description: Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
startTLSPolicy:
{
Description: The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy ,
Enum:
{
OpportunisticStartTLS: No description available. ,
MandatoryStartTLS: No description available. ,
NoStartTLS: No description available. ,
}
,
Required: False ,
}
enum ,
skipVerify:
{
Description: Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config ,
Required: False ,
}
boolean ,
}
,
snapshots:
{
Description: Grafana Snapshots settings ,
Required: False ,
}
{
externalEnabled:
{
Description: Set to false to disable external snapshot publish endpoint ,
Required: False ,
}
boolean ,
}
,
users:
{
Description: Grafana users settings ,
Required: False ,
}
{
viewersCanEdit:
{
Description: Set to true so viewers can access and use explore and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. ,
Required: False ,
}
boolean ,
editorsCanAdmin:
{
Description: Set to true so editors can administrate dashboards, folders and teams they create. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Grafana security settings ,
Required: False ,
}
{
csrfAlwaysCheck:
{
Description: Set to true to execute the CSRF check even if the login cookie is not in a request (default false). ,
Required: False ,
}
boolean ,
}
,
unifiedAlertingScreenshots:
{
Description: Grafana Unified Alerting Screenshots settings ,
Required: False ,
}
{
captureEnabled:
{
Description: Set to false to disable capture screenshot in Unified Alert due to performance issue. ,
Required: False ,
}
boolean ,
}
,
}
,
grafanaPlugins:
{
Description: Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition. ,
Required: False ,
}
object ,
grafanaMajorVersion:
{
Description: The major Grafana software version to target. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Grafana_ListByResourceGroup (updated)
Description :  List all resources of workspaces for Grafana under the specified resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Grafana_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_da137fb8a6c043a697db057fe1cf8047": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_f7983114afb44bf48fe76e94c2d6a60e": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ManagedGrafana items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties specific to the grafana resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaVersion:
{
Description: The Grafana software version. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of the Grafana instance. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicate the state for enable or disable traffic over the public interface. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: The zone redundancy setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiKey:
{
Description: The api key setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
deterministicOutboundIP:
{
Description: Whether a Grafana instance uses deterministic outbound IPs. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
outboundIPs:
{
Description: List of outbound IPs if deterministicOutboundIP is enabled. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: The private endpoint connections of the Grafana instance. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The private endpoint connection group ids. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope:
{
Description: Scope for dns deterministic name hash calculation. ,
Enum:
{
TenantReuse: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaIntegrations:
{
Description: GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. ,
Required: False ,
}
{
azureMonitorWorkspaceIntegrations:
{
Required: False ,
}
[
{
azureMonitorWorkspaceResourceId:
{
Description: The resource Id of the connected Azure Monitor Workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
Description: Enterprise settings of a Grafana instance ,
Required: False ,
}
{
marketplacePlanId:
{
Description: The Plan Id of the Azure Marketplace subscription for the Enterprise plugins ,
Required: False ,
}
string ,
marketplaceAutoRenew:
{
Description: The AutoRenew setting of the Enterprise subscription ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
grafanaConfigurations:
{
Description: Server configurations of a Grafana instance ,
Required: False ,
}
{
smtp:
{
Description: Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp ,
Required: False ,
}
{
enabled:
{
Description: Enable this to allow Grafana to send email. Default is false ,
Required: False ,
}
boolean ,
host:
{
Description: SMTP server hostname with port, e.g. test.email.net:587 ,
Required: False ,
}
string ,
user:
{
Description: User of SMTP auth ,
Required: False ,
}
string ,
password:
{
Description: Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes ,
Format: password ,
Required: False ,
}
string ,
fromAddress:
{
Description: Address used when sending out emails https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
fromName:
{
Description: Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
startTLSPolicy:
{
Description: The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy ,
Enum:
{
OpportunisticStartTLS: No description available. ,
MandatoryStartTLS: No description available. ,
NoStartTLS: No description available. ,
}
,
Required: False ,
}
enum ,
skipVerify:
{
Description: Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config ,
Required: False ,
}
boolean ,
}
,
snapshots:
{
Description: Grafana Snapshots settings ,
Required: False ,
}
{
externalEnabled:
{
Description: Set to false to disable external snapshot publish endpoint ,
Required: False ,
}
boolean ,
}
,
users:
{
Description: Grafana users settings ,
Required: False ,
}
{
viewersCanEdit:
{
Description: Set to true so viewers can access and use explore and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. ,
Required: False ,
}
boolean ,
editorsCanAdmin:
{
Description: Set to true so editors can administrate dashboards, folders and teams they create. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Grafana security settings ,
Required: False ,
}
{
csrfAlwaysCheck:
{
Description: Set to true to execute the CSRF check even if the login cookie is not in a request (default false). ,
Required: False ,
}
boolean ,
}
,
unifiedAlertingScreenshots:
{
Description: Grafana Unified Alerting Screenshots settings ,
Required: False ,
}
{
captureEnabled:
{
Description: Set to false to disable capture screenshot in Unified Alert due to performance issue. ,
Required: False ,
}
boolean ,
}
,
}
,
grafanaPlugins:
{
Description: Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition. ,
Required: False ,
}
object ,
grafanaMajorVersion:
{
Description: The major Grafana software version to target. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Grafana_Get (updated)
Description :  Get the properties of a specific workspace for Grafana resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Grafana_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@added_dd4a2736fa664d478436a42b85e54b53": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_c775e79be8bc45f2abcf473e1bbf3f6b": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The workspace name of Azure Managed Grafana. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties specific to the grafana resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaVersion:
{
Description: The Grafana software version. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of the Grafana instance. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicate the state for enable or disable traffic over the public interface. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: The zone redundancy setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiKey:
{
Description: The api key setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
deterministicOutboundIP:
{
Description: Whether a Grafana instance uses deterministic outbound IPs. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
outboundIPs:
{
Description: List of outbound IPs if deterministicOutboundIP is enabled. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: The private endpoint connections of the Grafana instance. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The private endpoint connection group ids. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope:
{
Description: Scope for dns deterministic name hash calculation. ,
Enum:
{
TenantReuse: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaIntegrations:
{
Description: GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. ,
Required: False ,
}
{
azureMonitorWorkspaceIntegrations:
{
Required: False ,
}
[
{
azureMonitorWorkspaceResourceId:
{
Description: The resource Id of the connected Azure Monitor Workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
Description: Enterprise settings of a Grafana instance ,
Required: False ,
}
{
marketplacePlanId:
{
Description: The Plan Id of the Azure Marketplace subscription for the Enterprise plugins ,
Required: False ,
}
string ,
marketplaceAutoRenew:
{
Description: The AutoRenew setting of the Enterprise subscription ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
grafanaConfigurations:
{
Description: Server configurations of a Grafana instance ,
Required: False ,
}
{
smtp:
{
Description: Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp ,
Required: False ,
}
{
enabled:
{
Description: Enable this to allow Grafana to send email. Default is false ,
Required: False ,
}
boolean ,
host:
{
Description: SMTP server hostname with port, e.g. test.email.net:587 ,
Required: False ,
}
string ,
user:
{
Description: User of SMTP auth ,
Required: False ,
}
string ,
password:
{
Description: Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes ,
Format: password ,
Required: False ,
}
string ,
fromAddress:
{
Description: Address used when sending out emails https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
fromName:
{
Description: Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
startTLSPolicy:
{
Description: The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy ,
Enum:
{
OpportunisticStartTLS: No description available. ,
MandatoryStartTLS: No description available. ,
NoStartTLS: No description available. ,
}
,
Required: False ,
}
enum ,
skipVerify:
{
Description: Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config ,
Required: False ,
}
boolean ,
}
,
snapshots:
{
Description: Grafana Snapshots settings ,
Required: False ,
}
{
externalEnabled:
{
Description: Set to false to disable external snapshot publish endpoint ,
Required: False ,
}
boolean ,
}
,
users:
{
Description: Grafana users settings ,
Required: False ,
}
{
viewersCanEdit:
{
Description: Set to true so viewers can access and use explore and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. ,
Required: False ,
}
boolean ,
editorsCanAdmin:
{
Description: Set to true so editors can administrate dashboards, folders and teams they create. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Grafana security settings ,
Required: False ,
}
{
csrfAlwaysCheck:
{
Description: Set to true to execute the CSRF check even if the login cookie is not in a request (default false). ,
Required: False ,
}
boolean ,
}
,
unifiedAlertingScreenshots:
{
Description: Grafana Unified Alerting Screenshots settings ,
Required: False ,
}
{
captureEnabled:
{
Description: Set to false to disable capture screenshot in Unified Alert due to performance issue. ,
Required: False ,
}
boolean ,
}
,
}
,
grafanaPlugins:
{
Description: Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition. ,
Required: False ,
}
object ,
grafanaMajorVersion:
{
Description: The major Grafana software version to target. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Grafana_Create (updated)
Description :  Create or update a workspace for Grafana resource. This API is idempotent, so user can either create a new grafana or update an existing grafana.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Grafana_Create",
  "$parameters": {
    "requestBodyParameters": {
      "$properties": {
        "@added_42da866631c540ba8912265e96fac468": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_16b2638a2b5d48b9bb2a428121c22ed5": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@added_83a3b044153f43c79911c7673cc54acf": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_6d5dcb94d74c429abc525e2897c708b5": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@added_97ac21f6f54543738895aca5754b7168": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_8788fe8bcf7a44fa9ae2cceff037ff95": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The workspace name of Azure Managed Grafana. ,
Required: True ,
}
string ,
requestBodyParameters:
{
Required: True ,
}
{
properties:
{
Description: Properties specific to the grafana resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaVersion:
{
Description: The Grafana software version. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of the Grafana instance. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicate the state for enable or disable traffic over the public interface. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: The zone redundancy setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiKey:
{
Description: The api key setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
deterministicOutboundIP:
{
Description: Whether a Grafana instance uses deterministic outbound IPs. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
outboundIPs:
{
Description: List of outbound IPs if deterministicOutboundIP is enabled. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: The private endpoint connections of the Grafana instance. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The private endpoint connection group ids. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope:
{
Description: Scope for dns deterministic name hash calculation. ,
Enum:
{
TenantReuse: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaIntegrations:
{
Description: GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. ,
Required: False ,
}
{
azureMonitorWorkspaceIntegrations:
{
Required: False ,
}
[
{
azureMonitorWorkspaceResourceId:
{
Description: The resource Id of the connected Azure Monitor Workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
Description: Enterprise settings of a Grafana instance ,
Required: False ,
}
{
marketplacePlanId:
{
Description: The Plan Id of the Azure Marketplace subscription for the Enterprise plugins ,
Required: False ,
}
string ,
marketplaceAutoRenew:
{
Description: The AutoRenew setting of the Enterprise subscription ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
grafanaConfigurations:
{
Description: Server configurations of a Grafana instance ,
Required: False ,
}
{
smtp:
{
Description: Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp ,
Required: False ,
}
{
enabled:
{
Description: Enable this to allow Grafana to send email. Default is false ,
Required: False ,
}
boolean ,
host:
{
Description: SMTP server hostname with port, e.g. test.email.net:587 ,
Required: False ,
}
string ,
user:
{
Description: User of SMTP auth ,
Required: False ,
}
string ,
password:
{
Description: Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes ,
Format: password ,
Required: False ,
}
string ,
fromAddress:
{
Description: Address used when sending out emails https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
fromName:
{
Description: Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
startTLSPolicy:
{
Description: The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy ,
Enum:
{
OpportunisticStartTLS: No description available. ,
MandatoryStartTLS: No description available. ,
NoStartTLS: No description available. ,
}
,
Required: False ,
}
enum ,
skipVerify:
{
Description: Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config ,
Required: False ,
}
boolean ,
}
,
snapshots:
{
Description: Grafana Snapshots settings ,
Required: False ,
}
{
externalEnabled:
{
Description: Set to false to disable external snapshot publish endpoint ,
Required: False ,
}
boolean ,
}
,
users:
{
Description: Grafana users settings ,
Required: False ,
}
{
viewersCanEdit:
{
Description: Set to true so viewers can access and use explore and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. ,
Required: False ,
}
boolean ,
editorsCanAdmin:
{
Description: Set to true so editors can administrate dashboards, folders and teams they create. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Grafana security settings ,
Required: False ,
}
{
csrfAlwaysCheck:
{
Description: Set to true to execute the CSRF check even if the login cookie is not in a request (default false). ,
Required: False ,
}
boolean ,
}
,
unifiedAlertingScreenshots:
{
Description: Grafana Unified Alerting Screenshots settings ,
Required: False ,
}
{
captureEnabled:
{
Description: Set to false to disable capture screenshot in Unified Alert due to performance issue. ,
Required: False ,
}
boolean ,
}
,
}
,
grafanaPlugins:
{
Description: Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition. ,
Required: False ,
}
object ,
grafanaMajorVersion:
{
Description: The major Grafana software version to target. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties specific to the grafana resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaVersion:
{
Description: The Grafana software version. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of the Grafana instance. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicate the state for enable or disable traffic over the public interface. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: The zone redundancy setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiKey:
{
Description: The api key setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
deterministicOutboundIP:
{
Description: Whether a Grafana instance uses deterministic outbound IPs. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
outboundIPs:
{
Description: List of outbound IPs if deterministicOutboundIP is enabled. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: The private endpoint connections of the Grafana instance. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The private endpoint connection group ids. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope:
{
Description: Scope for dns deterministic name hash calculation. ,
Enum:
{
TenantReuse: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaIntegrations:
{
Description: GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. ,
Required: False ,
}
{
azureMonitorWorkspaceIntegrations:
{
Required: False ,
}
[
{
azureMonitorWorkspaceResourceId:
{
Description: The resource Id of the connected Azure Monitor Workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
Description: Enterprise settings of a Grafana instance ,
Required: False ,
}
{
marketplacePlanId:
{
Description: The Plan Id of the Azure Marketplace subscription for the Enterprise plugins ,
Required: False ,
}
string ,
marketplaceAutoRenew:
{
Description: The AutoRenew setting of the Enterprise subscription ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
grafanaConfigurations:
{
Description: Server configurations of a Grafana instance ,
Required: False ,
}
{
smtp:
{
Description: Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp ,
Required: False ,
}
{
enabled:
{
Description: Enable this to allow Grafana to send email. Default is false ,
Required: False ,
}
boolean ,
host:
{
Description: SMTP server hostname with port, e.g. test.email.net:587 ,
Required: False ,
}
string ,
user:
{
Description: User of SMTP auth ,
Required: False ,
}
string ,
password:
{
Description: Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes ,
Format: password ,
Required: False ,
}
string ,
fromAddress:
{
Description: Address used when sending out emails https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
fromName:
{
Description: Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
startTLSPolicy:
{
Description: The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy ,
Enum:
{
OpportunisticStartTLS: No description available. ,
MandatoryStartTLS: No description available. ,
NoStartTLS: No description available. ,
}
,
Required: False ,
}
enum ,
skipVerify:
{
Description: Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config ,
Required: False ,
}
boolean ,
}
,
snapshots:
{
Description: Grafana Snapshots settings ,
Required: False ,
}
{
externalEnabled:
{
Description: Set to false to disable external snapshot publish endpoint ,
Required: False ,
}
boolean ,
}
,
users:
{
Description: Grafana users settings ,
Required: False ,
}
{
viewersCanEdit:
{
Description: Set to true so viewers can access and use explore and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. ,
Required: False ,
}
boolean ,
editorsCanAdmin:
{
Description: Set to true so editors can administrate dashboards, folders and teams they create. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Grafana security settings ,
Required: False ,
}
{
csrfAlwaysCheck:
{
Description: Set to true to execute the CSRF check even if the login cookie is not in a request (default false). ,
Required: False ,
}
boolean ,
}
,
unifiedAlertingScreenshots:
{
Description: Grafana Unified Alerting Screenshots settings ,
Required: False ,
}
{
captureEnabled:
{
Description: Set to false to disable capture screenshot in Unified Alert due to performance issue. ,
Required: False ,
}
boolean ,
}
,
}
,
grafanaPlugins:
{
Description: Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition. ,
Required: False ,
}
object ,
grafanaMajorVersion:
{
Description: The major Grafana software version to target. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The grafana resource type. ,
}
{
properties:
{
Description: Properties specific to the grafana resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaVersion:
{
Description: The Grafana software version. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of the Grafana instance. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicate the state for enable or disable traffic over the public interface. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: The zone redundancy setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiKey:
{
Description: The api key setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
deterministicOutboundIP:
{
Description: Whether a Grafana instance uses deterministic outbound IPs. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
outboundIPs:
{
Description: List of outbound IPs if deterministicOutboundIP is enabled. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: The private endpoint connections of the Grafana instance. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The private endpoint connection group ids. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope:
{
Description: Scope for dns deterministic name hash calculation. ,
Enum:
{
TenantReuse: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaIntegrations:
{
Description: GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. ,
Required: False ,
}
{
azureMonitorWorkspaceIntegrations:
{
Required: False ,
}
[
{
azureMonitorWorkspaceResourceId:
{
Description: The resource Id of the connected Azure Monitor Workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
Description: Enterprise settings of a Grafana instance ,
Required: False ,
}
{
marketplacePlanId:
{
Description: The Plan Id of the Azure Marketplace subscription for the Enterprise plugins ,
Required: False ,
}
string ,
marketplaceAutoRenew:
{
Description: The AutoRenew setting of the Enterprise subscription ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
grafanaConfigurations:
{
Description: Server configurations of a Grafana instance ,
Required: False ,
}
{
smtp:
{
Description: Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp ,
Required: False ,
}
{
enabled:
{
Description: Enable this to allow Grafana to send email. Default is false ,
Required: False ,
}
boolean ,
host:
{
Description: SMTP server hostname with port, e.g. test.email.net:587 ,
Required: False ,
}
string ,
user:
{
Description: User of SMTP auth ,
Required: False ,
}
string ,
password:
{
Description: Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes ,
Format: password ,
Required: False ,
}
string ,
fromAddress:
{
Description: Address used when sending out emails https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
fromName:
{
Description: Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
startTLSPolicy:
{
Description: The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy ,
Enum:
{
OpportunisticStartTLS: No description available. ,
MandatoryStartTLS: No description available. ,
NoStartTLS: No description available. ,
}
,
Required: False ,
}
enum ,
skipVerify:
{
Description: Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config ,
Required: False ,
}
boolean ,
}
,
snapshots:
{
Description: Grafana Snapshots settings ,
Required: False ,
}
{
externalEnabled:
{
Description: Set to false to disable external snapshot publish endpoint ,
Required: False ,
}
boolean ,
}
,
users:
{
Description: Grafana users settings ,
Required: False ,
}
{
viewersCanEdit:
{
Description: Set to true so viewers can access and use explore and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. ,
Required: False ,
}
boolean ,
editorsCanAdmin:
{
Description: Set to true so editors can administrate dashboards, folders and teams they create. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Grafana security settings ,
Required: False ,
}
{
csrfAlwaysCheck:
{
Description: Set to true to execute the CSRF check even if the login cookie is not in a request (default false). ,
Required: False ,
}
boolean ,
}
,
unifiedAlertingScreenshots:
{
Description: Grafana Unified Alerting Screenshots settings ,
Required: False ,
}
{
captureEnabled:
{
Description: Set to false to disable capture screenshot in Unified Alert due to performance issue. ,
Required: False ,
}
boolean ,
}
,
}
,
grafanaPlugins:
{
Description: Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition. ,
Required: False ,
}
object ,
grafanaMajorVersion:
{
Description: The major Grafana software version to target. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Grafana_Update (updated)
Description :  Update a workspace for Grafana resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Grafana_Update",
  "$responses": {
    "200": {
      "$properties": {
        "@added_2ffbd2f1bc89406fb1810cd18cc61b95": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_744f58c9c22746049aa759d21c13ca3d": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "202": {
      "$properties": {
        "@added_fe15f880c1c8412c8202083900c23621": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_6ef4918a119e4286b5a28a78cf3421f8": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The workspace name of Azure Managed Grafana. ,
Required: True ,
}
string ,
requestBodyParameters:
{
Required: True ,
}
{
sku:
{
Description: Represents the SKU of a resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed identity of the grafana resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: The new tags of the grafana resource. ,
Required: False ,
}
object ,
properties:
{
Description: Properties specific to the managed grafana resource. ,
Required: False ,
}
{
zoneRedundancy:
{
Description: The zone redundancy setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiKey:
{
Description: The api key setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
deterministicOutboundIP:
{
Description: Whether a Grafana instance uses deterministic outbound IPs. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Indicate the state for enable or disable traffic over the public interface. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaIntegrations:
{
Description: GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. ,
Required: False ,
}
{
azureMonitorWorkspaceIntegrations:
{
Required: False ,
}
[
{
azureMonitorWorkspaceResourceId:
{
Description: The resource Id of the connected Azure Monitor Workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
Description: Enterprise settings of a Grafana instance ,
Required: False ,
}
{
marketplacePlanId:
{
Description: The Plan Id of the Azure Marketplace subscription for the Enterprise plugins ,
Required: False ,
}
string ,
marketplaceAutoRenew:
{
Description: The AutoRenew setting of the Enterprise subscription ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
grafanaConfigurations:
{
Description: Server configurations of a Grafana instance ,
Required: False ,
}
{
smtp:
{
Description: Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp ,
Required: False ,
}
{
enabled:
{
Description: Enable this to allow Grafana to send email. Default is false ,
Required: False ,
}
boolean ,
host:
{
Description: SMTP server hostname with port, e.g. test.email.net:587 ,
Required: False ,
}
string ,
user:
{
Description: User of SMTP auth ,
Required: False ,
}
string ,
password:
{
Description: Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes ,
Format: password ,
Required: False ,
}
string ,
fromAddress:
{
Description: Address used when sending out emails https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
fromName:
{
Description: Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
startTLSPolicy:
{
Description: The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy ,
Enum:
{
OpportunisticStartTLS: No description available. ,
MandatoryStartTLS: No description available. ,
NoStartTLS: No description available. ,
}
,
Required: False ,
}
enum ,
skipVerify:
{
Description: Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config ,
Required: False ,
}
boolean ,
}
,
snapshots:
{
Description: Grafana Snapshots settings ,
Required: False ,
}
{
externalEnabled:
{
Description: Set to false to disable external snapshot publish endpoint ,
Required: False ,
}
boolean ,
}
,
users:
{
Description: Grafana users settings ,
Required: False ,
}
{
viewersCanEdit:
{
Description: Set to true so viewers can access and use explore and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. ,
Required: False ,
}
boolean ,
editorsCanAdmin:
{
Description: Set to true so editors can administrate dashboards, folders and teams they create. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Grafana security settings ,
Required: False ,
}
{
csrfAlwaysCheck:
{
Description: Set to true to execute the CSRF check even if the login cookie is not in a request (default false). ,
Required: False ,
}
boolean ,
}
,
unifiedAlertingScreenshots:
{
Description: Grafana Unified Alerting Screenshots settings ,
Required: False ,
}
{
captureEnabled:
{
Description: Set to false to disable capture screenshot in Unified Alert due to performance issue. ,
Required: False ,
}
boolean ,
}
,
}
,
grafanaPlugins:
{
Description: Update of Grafana plugin. Key is plugin id, value is plugin definition. If plugin definition is null, plugin with given plugin id will be removed. Otherwise, given plugin will be installed. ,
Required: False ,
}
object ,
grafanaMajorVersion:
{
Description: The major Grafana software version to target. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties specific to the grafana resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaVersion:
{
Description: The Grafana software version. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of the Grafana instance. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicate the state for enable or disable traffic over the public interface. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: The zone redundancy setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiKey:
{
Description: The api key setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
deterministicOutboundIP:
{
Description: Whether a Grafana instance uses deterministic outbound IPs. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
outboundIPs:
{
Description: List of outbound IPs if deterministicOutboundIP is enabled. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: The private endpoint connections of the Grafana instance. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The private endpoint connection group ids. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope:
{
Description: Scope for dns deterministic name hash calculation. ,
Enum:
{
TenantReuse: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaIntegrations:
{
Description: GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. ,
Required: False ,
}
{
azureMonitorWorkspaceIntegrations:
{
Required: False ,
}
[
{
azureMonitorWorkspaceResourceId:
{
Description: The resource Id of the connected Azure Monitor Workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
Description: Enterprise settings of a Grafana instance ,
Required: False ,
}
{
marketplacePlanId:
{
Description: The Plan Id of the Azure Marketplace subscription for the Enterprise plugins ,
Required: False ,
}
string ,
marketplaceAutoRenew:
{
Description: The AutoRenew setting of the Enterprise subscription ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
grafanaConfigurations:
{
Description: Server configurations of a Grafana instance ,
Required: False ,
}
{
smtp:
{
Description: Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp ,
Required: False ,
}
{
enabled:
{
Description: Enable this to allow Grafana to send email. Default is false ,
Required: False ,
}
boolean ,
host:
{
Description: SMTP server hostname with port, e.g. test.email.net:587 ,
Required: False ,
}
string ,
user:
{
Description: User of SMTP auth ,
Required: False ,
}
string ,
password:
{
Description: Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes ,
Format: password ,
Required: False ,
}
string ,
fromAddress:
{
Description: Address used when sending out emails https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
fromName:
{
Description: Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
startTLSPolicy:
{
Description: The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy ,
Enum:
{
OpportunisticStartTLS: No description available. ,
MandatoryStartTLS: No description available. ,
NoStartTLS: No description available. ,
}
,
Required: False ,
}
enum ,
skipVerify:
{
Description: Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config ,
Required: False ,
}
boolean ,
}
,
snapshots:
{
Description: Grafana Snapshots settings ,
Required: False ,
}
{
externalEnabled:
{
Description: Set to false to disable external snapshot publish endpoint ,
Required: False ,
}
boolean ,
}
,
users:
{
Description: Grafana users settings ,
Required: False ,
}
{
viewersCanEdit:
{
Description: Set to true so viewers can access and use explore and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. ,
Required: False ,
}
boolean ,
editorsCanAdmin:
{
Description: Set to true so editors can administrate dashboards, folders and teams they create. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Grafana security settings ,
Required: False ,
}
{
csrfAlwaysCheck:
{
Description: Set to true to execute the CSRF check even if the login cookie is not in a request (default false). ,
Required: False ,
}
boolean ,
}
,
unifiedAlertingScreenshots:
{
Description: Grafana Unified Alerting Screenshots settings ,
Required: False ,
}
{
captureEnabled:
{
Description: Set to false to disable capture screenshot in Unified Alert due to performance issue. ,
Required: False ,
}
boolean ,
}
,
}
,
grafanaPlugins:
{
Description: Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition. ,
Required: False ,
}
object ,
grafanaMajorVersion:
{
Description: The major Grafana software version to target. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The grafana resource type. ,
}
{
properties:
{
Description: Properties specific to the grafana resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaVersion:
{
Description: The Grafana software version. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of the Grafana instance. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicate the state for enable or disable traffic over the public interface. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: The zone redundancy setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiKey:
{
Description: The api key setting of the Grafana instance. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
deterministicOutboundIP:
{
Description: Whether a Grafana instance uses deterministic outbound IPs. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
outboundIPs:
{
Description: List of outbound IPs if deterministicOutboundIP is enabled. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: The private endpoint connections of the Grafana instance. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The private endpoint connection group ids. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope:
{
Description: Scope for dns deterministic name hash calculation. ,
Enum:
{
TenantReuse: No description available. ,
}
,
Required: False ,
}
enum ,
grafanaIntegrations:
{
Description: GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. ,
Required: False ,
}
{
azureMonitorWorkspaceIntegrations:
{
Required: False ,
}
[
{
azureMonitorWorkspaceResourceId:
{
Description: The resource Id of the connected Azure Monitor Workspace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
Description: Enterprise settings of a Grafana instance ,
Required: False ,
}
{
marketplacePlanId:
{
Description: The Plan Id of the Azure Marketplace subscription for the Enterprise plugins ,
Required: False ,
}
string ,
marketplaceAutoRenew:
{
Description: The AutoRenew setting of the Enterprise subscription ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
grafanaConfigurations:
{
Description: Server configurations of a Grafana instance ,
Required: False ,
}
{
smtp:
{
Description: Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp ,
Required: False ,
}
{
enabled:
{
Description: Enable this to allow Grafana to send email. Default is false ,
Required: False ,
}
boolean ,
host:
{
Description: SMTP server hostname with port, e.g. test.email.net:587 ,
Required: False ,
}
string ,
user:
{
Description: User of SMTP auth ,
Required: False ,
}
string ,
password:
{
Description: Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes ,
Format: password ,
Required: False ,
}
string ,
fromAddress:
{
Description: Address used when sending out emails https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
fromName:
{
Description: Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address ,
Required: False ,
}
string ,
startTLSPolicy:
{
Description: The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy ,
Enum:
{
OpportunisticStartTLS: No description available. ,
MandatoryStartTLS: No description available. ,
NoStartTLS: No description available. ,
}
,
Required: False ,
}
enum ,
skipVerify:
{
Description: Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config ,
Required: False ,
}
boolean ,
}
,
snapshots:
{
Description: Grafana Snapshots settings ,
Required: False ,
}
{
externalEnabled:
{
Description: Set to false to disable external snapshot publish endpoint ,
Required: False ,
}
boolean ,
}
,
users:
{
Description: Grafana users settings ,
Required: False ,
}
{
viewersCanEdit:
{
Description: Set to true so viewers can access and use explore and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. ,
Required: False ,
}
boolean ,
editorsCanAdmin:
{
Description: Set to true so editors can administrate dashboards, folders and teams they create. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Grafana security settings ,
Required: False ,
}
{
csrfAlwaysCheck:
{
Description: Set to true to execute the CSRF check even if the login cookie is not in a request (default false). ,
Required: False ,
}
boolean ,
}
,
unifiedAlertingScreenshots:
{
Description: Grafana Unified Alerting Screenshots settings ,
Required: False ,
}
{
captureEnabled:
{
Description: Set to false to disable capture screenshot in Unified Alert due to performance issue. ,
Required: False ,
}
boolean ,
}
,
}
,
grafanaPlugins:
{
Description: Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition. ,
Required: False ,
}
object ,
grafanaMajorVersion:
{
Description: The major Grafana software version to target. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}