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

2025/06/10 • 22 updated methods

Dashboards_ListBySubscription (updated)
Description :  List all resources of dashboards under the specified subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Dashboards_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Dashboard/dashboards
{
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 ManagedDashboard items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties specific to the managed dashboard 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 ,
}
,
}
,
]
,
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_List (updated)
Description :  List all resources of workspaces for Grafana under the specified subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Grafana_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "properties": [
                  {
                    "grafanaConfigurations": [
                      {
                        "#name": "smtp",
                        "Description": {
                          "new": "Email server settings.\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp",
                          "old": "Email server settings.\r\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp"
                        },
                        "$properties": [
                          {
                            "#name": "fromAddress",
                            "Description": {
                              "new": "Address used when sending out emails\nhttps://pkg.go.dev/net/mail#Address",
                              "old": "Address used when sending out emails\r\nhttps://pkg.go.dev/net/mail#Address"
                            }
                          },
                          {
                            "#name": "fromName",
                            "Description": {
                              "new": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\nhttps://pkg.go.dev/net/mail#Address",
                              "old": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\r\nhttps://pkg.go.dev/net/mail#Address"
                            }
                          },
                          {
                            "#name": "startTLSPolicy",
                            "Description": {
                              "new": "The StartTLSPolicy setting of the SMTP configuration\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy",
                              "old": "The StartTLSPolicy setting of the SMTP configuration\r\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy"
                            }
                          },
                          {
                            "#name": "skipVerify",
                            "Description": {
                              "new": "Verify SSL for SMTP server. Default is false\nhttps://pkg.go.dev/crypto/tls#Config",
                              "old": "Verify SSL for SMTP server. Default is false\r\nhttps://pkg.go.dev/crypto/tls#Config"
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              },
              {
                "#name": "identity",
                "Description": {
                  "new": "The managed service identities assigned to this resource.",
                  "old": "The managed identity of the grafana resource."
                }
              },
              {
                "@removed_15843e8c7de44aaa82357a45444f704b": {
                  "#name": "id",
                  "Description": "ARM id of the grafana resource",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@removed_9bcf7e57c6784234af3e051d24b361e2": {
                  "#name": "name",
                  "Description": "Name of the grafana resource.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@removed_02ba66d20ae84e7b8e069e49dce8bd00": {
                  "#name": "type",
                  "Description": "The type of the grafana resource.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@removed_7f9ad099f31742509cbdc1baaf8e7f93": {
                  "#name": "systemData",
                  "Description": "The system meta data relating to this grafana resource.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "createdBy",
                      "Description": "The identity that created the resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "createdByType",
                      "Description": "The type of identity that created the resource.",
                      "Enum": [
                        [
                          "User",
                          ""
                        ],
                        [
                          "Application",
                          ""
                        ],
                        [
                          "ManagedIdentity",
                          ""
                        ],
                        [
                          "Key",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "createdAt",
                      "Description": "The timestamp of resource creation (UTC).",
                      "Format": "date-time",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "lastModifiedBy",
                      "Description": "The identity that last modified the resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "lastModifiedByType",
                      "Description": "The type of identity that last modified the resource.",
                      "Enum": [
                        [
                          "User",
                          ""
                        ],
                        [
                          "Application",
                          ""
                        ],
                        [
                          "ManagedIdentity",
                          ""
                        ],
                        [
                          "Key",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "lastModifiedAt",
                      "Description": "The timestamp of resource last modification (UTC)",
                      "Format": "date-time",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "@removed_d9984977ef2048ccaefc41e719bc6042": {
                  "#name": "tags",
                  "Description": "The tags for grafana resource.",
                  "Required": false,
                  "Type": "object"
                }
              },
              {
                "@removed_8da71910c2e24b4cb2d2ba9a913fb05c": {
                  "#name": "location",
                  "Description": "The geo-location where the grafana 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 ,
}
[
{
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
Dashboards_List (updated)
Description :  List all resources of dashboards under the specified resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Dashboards_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/dashboards
{
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 ManagedDashboard items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties specific to the managed dashboard 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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ManagedDashboards_Create (updated)
Description :  Create or update a dashboard for grafana resource. This API is idempotent, so user can either create a new dashboard or update an existing dashboard.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagedDashboards_Create",
  "$responses": {
    "201": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation URI for long running operation."
        }
      },
      {
        "@added_6e2387d0ac8d4005bae8cee5f96d50d5": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/dashboards/{dashboardName}
{
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 ,
dashboardName:
{
Description: The name of the Azure Managed Dashboard. ,
Required: True ,
}
string ,
requestBodyParameters:
{
Required: True ,
}
{
properties:
{
Description: Properties specific to the managed dashboard 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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties specific to the managed dashboard 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 ,
}
,
}

⚐ 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 managed dashboard resource type. ,
}
{
properties:
{
Description: Properties specific to the managed dashboard 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 ,
}
,
}
,
}

⚐ 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": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "properties": [
                  {
                    "grafanaConfigurations": [
                      {
                        "#name": "smtp",
                        "Description": {
                          "new": "Email server settings.\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp",
                          "old": "Email server settings.\r\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp"
                        },
                        "$properties": [
                          {
                            "#name": "fromAddress",
                            "Description": {
                              "new": "Address used when sending out emails\nhttps://pkg.go.dev/net/mail#Address",
                              "old": "Address used when sending out emails\r\nhttps://pkg.go.dev/net/mail#Address"
                            }
                          },
                          {
                            "#name": "fromName",
                            "Description": {
                              "new": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\nhttps://pkg.go.dev/net/mail#Address",
                              "old": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\r\nhttps://pkg.go.dev/net/mail#Address"
                            }
                          },
                          {
                            "#name": "startTLSPolicy",
                            "Description": {
                              "new": "The StartTLSPolicy setting of the SMTP configuration\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy",
                              "old": "The StartTLSPolicy setting of the SMTP configuration\r\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy"
                            }
                          },
                          {
                            "#name": "skipVerify",
                            "Description": {
                              "new": "Verify SSL for SMTP server. Default is false\nhttps://pkg.go.dev/crypto/tls#Config",
                              "old": "Verify SSL for SMTP server. Default is false\r\nhttps://pkg.go.dev/crypto/tls#Config"
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              },
              {
                "#name": "identity",
                "Description": {
                  "new": "The managed service identities assigned to this resource.",
                  "old": "The managed identity of the grafana resource."
                }
              },
              {
                "@removed_eeb2d0e097de4818b255e31d8c18f1e1": {
                  "#name": "id",
                  "Description": "ARM id of the grafana resource",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@removed_3303ca3bffe84609ae7c67c1286e064d": {
                  "#name": "name",
                  "Description": "Name of the grafana resource.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@removed_55db3792f6a74ec6a25a015c23dc2f30": {
                  "#name": "type",
                  "Description": "The type of the grafana resource.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@removed_b81aebb6d16d494f8be0f663141bbf53": {
                  "#name": "systemData",
                  "Description": "The system meta data relating to this grafana resource.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "createdBy",
                      "Description": "The identity that created the resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "createdByType",
                      "Description": "The type of identity that created the resource.",
                      "Enum": [
                        [
                          "User",
                          ""
                        ],
                        [
                          "Application",
                          ""
                        ],
                        [
                          "ManagedIdentity",
                          ""
                        ],
                        [
                          "Key",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "createdAt",
                      "Description": "The timestamp of resource creation (UTC).",
                      "Format": "date-time",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "lastModifiedBy",
                      "Description": "The identity that last modified the resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "lastModifiedByType",
                      "Description": "The type of identity that last modified the resource.",
                      "Enum": [
                        [
                          "User",
                          ""
                        ],
                        [
                          "Application",
                          ""
                        ],
                        [
                          "ManagedIdentity",
                          ""
                        ],
                        [
                          "Key",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "lastModifiedAt",
                      "Description": "The timestamp of resource last modification (UTC)",
                      "Format": "date-time",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "@removed_4fc4806b0d2340c2bd9e654248354119": {
                  "#name": "tags",
                  "Description": "The tags for grafana resource.",
                  "Required": false,
                  "Type": "object"
                }
              },
              {
                "@removed_69e79c4645094259a4a4f42cf0a35b5a": {
                  "#name": "location",
                  "Description": "The geo-location where the grafana 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 ,
}
[
{
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
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": [
        {
          "properties": [
            {
              "grafanaConfigurations": [
                {
                  "#name": "smtp",
                  "Description": {
                    "new": "Email server settings.\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp",
                    "old": "Email server settings.\r\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp"
                  },
                  "$properties": [
                    {
                      "#name": "fromAddress",
                      "Description": {
                        "new": "Address used when sending out emails\nhttps://pkg.go.dev/net/mail#Address",
                        "old": "Address used when sending out emails\r\nhttps://pkg.go.dev/net/mail#Address"
                      }
                    },
                    {
                      "#name": "fromName",
                      "Description": {
                        "new": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\nhttps://pkg.go.dev/net/mail#Address",
                        "old": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\r\nhttps://pkg.go.dev/net/mail#Address"
                      }
                    },
                    {
                      "#name": "startTLSPolicy",
                      "Description": {
                        "new": "The StartTLSPolicy setting of the SMTP configuration\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy",
                        "old": "The StartTLSPolicy setting of the SMTP configuration\r\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy"
                      }
                    },
                    {
                      "#name": "skipVerify",
                      "Description": {
                        "new": "Verify SSL for SMTP server. Default is false\nhttps://pkg.go.dev/crypto/tls#Config",
                        "old": "Verify SSL for SMTP server. Default is false\r\nhttps://pkg.go.dev/crypto/tls#Config"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The managed identity of the grafana resource."
          }
        },
        {
          "@removed_f25ff6fe8aa24313b8edfd5889c087a0": {
            "#name": "id",
            "Description": "ARM id of the grafana resource",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_2fa82780fabb44958d59b65bc8f103a6": {
            "#name": "name",
            "Description": "Name of the grafana resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_72cdedb5a3ef4bf791fa72db260b6ab7": {
            "#name": "type",
            "Description": "The type of the grafana resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_bc743f0aca85454f91216a1855440ce9": {
            "#name": "systemData",
            "Description": "The system meta data relating to this grafana resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        },
        {
          "@removed_14796f89dbf7447398d8adafa4398bb1": {
            "#name": "tags",
            "Description": "The tags for grafana resource.",
            "Required": false,
            "Type": "object"
          }
        },
        {
          "@removed_72354ee40d5a443985c70c7fc1f4013c": {
            "#name": "location",
            "Description": "The geo-location where the grafana 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)

{
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
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": [
        {
          "properties": [
            {
              "grafanaConfigurations": [
                {
                  "#name": "smtp",
                  "Description": {
                    "new": "Email server settings.\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp",
                    "old": "Email server settings.\r\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp"
                  },
                  "$properties": [
                    {
                      "#name": "fromAddress",
                      "Description": {
                        "new": "Address used when sending out emails\nhttps://pkg.go.dev/net/mail#Address",
                        "old": "Address used when sending out emails\r\nhttps://pkg.go.dev/net/mail#Address"
                      }
                    },
                    {
                      "#name": "fromName",
                      "Description": {
                        "new": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\nhttps://pkg.go.dev/net/mail#Address",
                        "old": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\r\nhttps://pkg.go.dev/net/mail#Address"
                      }
                    },
                    {
                      "#name": "startTLSPolicy",
                      "Description": {
                        "new": "The StartTLSPolicy setting of the SMTP configuration\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy",
                        "old": "The StartTLSPolicy setting of the SMTP configuration\r\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy"
                      }
                    },
                    {
                      "#name": "skipVerify",
                      "Description": {
                        "new": "Verify SSL for SMTP server. Default is false\nhttps://pkg.go.dev/crypto/tls#Config",
                        "old": "Verify SSL for SMTP server. Default is false\r\nhttps://pkg.go.dev/crypto/tls#Config"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The managed identity of the grafana resource."
          }
        },
        {
          "@removed_e755bd5c67e74c09a45ddb386a2b893b": {
            "#name": "id",
            "Description": "ARM id of the grafana resource",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_7c66a8e2ae1e49df8ff25b11bc6b9d62": {
            "#name": "name",
            "Description": "Name of the grafana resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_633a04da0c0442619a892b84ae2aa1a6": {
            "#name": "type",
            "Description": "The type of the grafana resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_d624ff74fa8e4ba5a1226d56dfecbb40": {
            "#name": "systemData",
            "Description": "The system meta data relating to this grafana resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        },
        {
          "@removed_89bf89abba804a5cb6352bb7ab988ae4": {
            "#name": "tags",
            "Description": "The tags for grafana resource.",
            "Required": false,
            "Type": "object"
          }
        },
        {
          "@removed_d445e3b005604120a56401864350bf45": {
            "#name": "location",
            "Description": "The geo-location where the grafana resource lives",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  },
  "$responses": [
    {
      "200": {
        "$properties": [
          {
            "properties": [
              {
                "grafanaConfigurations": [
                  {
                    "#name": "smtp",
                    "Description": {
                      "new": "Email server settings.\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp",
                      "old": "Email server settings.\r\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp"
                    },
                    "$properties": [
                      {
                        "#name": "fromAddress",
                        "Description": {
                          "new": "Address used when sending out emails\nhttps://pkg.go.dev/net/mail#Address",
                          "old": "Address used when sending out emails\r\nhttps://pkg.go.dev/net/mail#Address"
                        }
                      },
                      {
                        "#name": "fromName",
                        "Description": {
                          "new": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\nhttps://pkg.go.dev/net/mail#Address",
                          "old": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\r\nhttps://pkg.go.dev/net/mail#Address"
                        }
                      },
                      {
                        "#name": "startTLSPolicy",
                        "Description": {
                          "new": "The StartTLSPolicy setting of the SMTP configuration\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy",
                          "old": "The StartTLSPolicy setting of the SMTP configuration\r\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy"
                        }
                      },
                      {
                        "#name": "skipVerify",
                        "Description": {
                          "new": "Verify SSL for SMTP server. Default is false\nhttps://pkg.go.dev/crypto/tls#Config",
                          "old": "Verify SSL for SMTP server. Default is false\r\nhttps://pkg.go.dev/crypto/tls#Config"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "identity",
            "Description": {
              "new": "The managed service identities assigned to this resource.",
              "old": "The managed identity of the grafana resource."
            }
          },
          {
            "@removed_e4227b75806c4c2fb598dbb55710e4be": {
              "#name": "id",
              "Description": "ARM id of the grafana resource",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_e8bd6d7cf40e4b3e9d3e3e31ee644e2a": {
              "#name": "name",
              "Description": "Name of the grafana resource.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_c9ef2795844648529c5056579fe900fc": {
              "#name": "type",
              "Description": "The type of the grafana resource.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_78b2e58811e843a4a5d43d0e0295a36a": {
              "#name": "systemData",
              "Description": "The system meta data relating to this grafana resource.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "createdBy",
                  "Description": "The identity that created the resource.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "createdByType",
                  "Description": "The type of identity that created the resource.",
                  "Enum": [
                    [
                      "User",
                      ""
                    ],
                    [
                      "Application",
                      ""
                    ],
                    [
                      "ManagedIdentity",
                      ""
                    ],
                    [
                      "Key",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "createdAt",
                  "Description": "The timestamp of resource creation (UTC).",
                  "Format": "date-time",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "lastModifiedBy",
                  "Description": "The identity that last modified the resource.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "lastModifiedByType",
                  "Description": "The type of identity that last modified the resource.",
                  "Enum": [
                    [
                      "User",
                      ""
                    ],
                    [
                      "Application",
                      ""
                    ],
                    [
                      "ManagedIdentity",
                      ""
                    ],
                    [
                      "Key",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "lastModifiedAt",
                  "Description": "The timestamp of resource last modification (UTC)",
                  "Format": "date-time",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          },
          {
            "@removed_c4329592b4a8435d80b4068720fe7cfd": {
              "#name": "tags",
              "Description": "The tags for grafana resource.",
              "Required": false,
              "Type": "object"
            }
          },
          {
            "@removed_2930ebbbcd6f4728a0d730ec92d8acb4": {
              "#name": "location",
              "Description": "The geo-location where the grafana resource lives",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    },
    {
      "#status": "201",
      "$headers": [
        {
          "#name": "azure-asyncoperation",
          "Description": {
            "new": "A link to the status monitor",
            "old": "Operation URI for long running operation."
          }
        },
        {
          "@added_840a416b96024e62bfb2edf2c19bc216": {
            "#name": "retry-after",
            "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
            "Type": "integer"
          }
        }
      ],
      "$schema": {
        "$properties": [
          {
            "properties": [
              {
                "grafanaConfigurations": [
                  {
                    "#name": "smtp",
                    "Description": {
                      "new": "Email server settings.\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp",
                      "old": "Email server settings.\r\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp"
                    },
                    "$properties": [
                      {
                        "#name": "fromAddress",
                        "Description": {
                          "new": "Address used when sending out emails\nhttps://pkg.go.dev/net/mail#Address",
                          "old": "Address used when sending out emails\r\nhttps://pkg.go.dev/net/mail#Address"
                        }
                      },
                      {
                        "#name": "fromName",
                        "Description": {
                          "new": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\nhttps://pkg.go.dev/net/mail#Address",
                          "old": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\r\nhttps://pkg.go.dev/net/mail#Address"
                        }
                      },
                      {
                        "#name": "startTLSPolicy",
                        "Description": {
                          "new": "The StartTLSPolicy setting of the SMTP configuration\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy",
                          "old": "The StartTLSPolicy setting of the SMTP configuration\r\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy"
                        }
                      },
                      {
                        "#name": "skipVerify",
                        "Description": {
                          "new": "Verify SSL for SMTP server. Default is false\nhttps://pkg.go.dev/crypto/tls#Config",
                          "old": "Verify SSL for SMTP server. Default is false\r\nhttps://pkg.go.dev/crypto/tls#Config"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "identity",
            "Description": {
              "new": "The managed service identities assigned to this resource.",
              "old": "The managed identity of the grafana resource."
            }
          },
          {
            "@removed_7c7cfaf41ca94de2b213ef371f7f6f4e": {
              "#name": "id",
              "Description": "ARM id of the grafana resource",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_1e16e812aa8e4ff0831f2779ba296bcb": {
              "#name": "name",
              "Description": "Name of the grafana resource.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_e8c9bb51cb404a9da6860098ad0752be": {
              "#name": "type",
              "Description": "The type of the grafana resource.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_e6e53e639aaa4cb99f420c810db0aa78": {
              "#name": "systemData",
              "Description": "The system meta data relating to this grafana resource.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "createdBy",
                  "Description": "The identity that created the resource.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "createdByType",
                  "Description": "The type of identity that created the resource.",
                  "Enum": [
                    [
                      "User",
                      ""
                    ],
                    [
                      "Application",
                      ""
                    ],
                    [
                      "ManagedIdentity",
                      ""
                    ],
                    [
                      "Key",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "createdAt",
                  "Description": "The timestamp of resource creation (UTC).",
                  "Format": "date-time",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "lastModifiedBy",
                  "Description": "The identity that last modified the resource.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "lastModifiedByType",
                  "Description": "The type of identity that last modified the resource.",
                  "Enum": [
                    [
                      "User",
                      ""
                    ],
                    [
                      "Application",
                      ""
                    ],
                    [
                      "ManagedIdentity",
                      ""
                    ],
                    [
                      "Key",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "lastModifiedAt",
                  "Description": "The timestamp of resource last modification (UTC)",
                  "Format": "date-time",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          },
          {
            "@removed_acceef8abbbc414f8e2190fb5cec4ba3": {
              "#name": "tags",
              "Description": "The tags for grafana resource.",
              "Required": false,
              "Type": "object"
            }
          },
          {
            "@removed_9d16385bb4764df0bf618c359cca061b": {
              "#name": "location",
              "Description": "The geo-location where the grafana 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 ,
}
{
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
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)

{
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
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. ,
}
{
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
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",
  "$parameters": {
    "requestBodyParameters": {
      "$properties": {
        "properties": [
          {
            "grafanaConfigurations": [
              {
                "#name": "smtp",
                "Description": {
                  "new": "Email server settings.\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp",
                  "old": "Email server settings.\r\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp"
                },
                "$properties": [
                  {
                    "#name": "fromAddress",
                    "Description": {
                      "new": "Address used when sending out emails\nhttps://pkg.go.dev/net/mail#Address",
                      "old": "Address used when sending out emails\r\nhttps://pkg.go.dev/net/mail#Address"
                    }
                  },
                  {
                    "#name": "fromName",
                    "Description": {
                      "new": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\nhttps://pkg.go.dev/net/mail#Address",
                      "old": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\r\nhttps://pkg.go.dev/net/mail#Address"
                    }
                  },
                  {
                    "#name": "startTLSPolicy",
                    "Description": {
                      "new": "The StartTLSPolicy setting of the SMTP configuration\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy",
                      "old": "The StartTLSPolicy setting of the SMTP configuration\r\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy"
                    }
                  },
                  {
                    "#name": "skipVerify",
                    "Description": {
                      "new": "Verify SSL for SMTP server. Default is false\nhttps://pkg.go.dev/crypto/tls#Config",
                      "old": "Verify SSL for SMTP server. Default is false\r\nhttps://pkg.go.dev/crypto/tls#Config"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "grafanaConfigurations": [
                {
                  "#name": "smtp",
                  "Description": {
                    "new": "Email server settings.\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp",
                    "old": "Email server settings.\r\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp"
                  },
                  "$properties": [
                    {
                      "#name": "fromAddress",
                      "Description": {
                        "new": "Address used when sending out emails\nhttps://pkg.go.dev/net/mail#Address",
                        "old": "Address used when sending out emails\r\nhttps://pkg.go.dev/net/mail#Address"
                      }
                    },
                    {
                      "#name": "fromName",
                      "Description": {
                        "new": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\nhttps://pkg.go.dev/net/mail#Address",
                        "old": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\r\nhttps://pkg.go.dev/net/mail#Address"
                      }
                    },
                    {
                      "#name": "startTLSPolicy",
                      "Description": {
                        "new": "The StartTLSPolicy setting of the SMTP configuration\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy",
                        "old": "The StartTLSPolicy setting of the SMTP configuration\r\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy"
                      }
                    },
                    {
                      "#name": "skipVerify",
                      "Description": {
                        "new": "Verify SSL for SMTP server. Default is false\nhttps://pkg.go.dev/crypto/tls#Config",
                        "old": "Verify SSL for SMTP server. Default is false\r\nhttps://pkg.go.dev/crypto/tls#Config"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The managed identity of the grafana resource."
          }
        },
        {
          "@removed_8ed72c0958734b6ea443e8d8a08ce0c0": {
            "#name": "id",
            "Description": "ARM id of the grafana resource",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_71760a0910aa448c865c36b7425c565f": {
            "#name": "name",
            "Description": "Name of the grafana resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_0ab4002982f2451baf097c049fb61008": {
            "#name": "type",
            "Description": "The type of the grafana resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_6eb7491a735f4fd592584903c309d7ea": {
            "#name": "systemData",
            "Description": "The system meta data relating to this grafana resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        },
        {
          "@removed_56215259c6724468ad01b9b8433cbad5": {
            "#name": "tags",
            "Description": "The tags for grafana resource.",
            "Required": false,
            "Type": "object"
          }
        },
        {
          "@removed_d483ab5267fe4a149a3ebf5fbaf7fa4c": {
            "#name": "location",
            "Description": "The geo-location where the grafana resource lives",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    },
    "202": {
      "$properties": [
        {
          "properties": [
            {
              "grafanaConfigurations": [
                {
                  "#name": "smtp",
                  "Description": {
                    "new": "Email server settings.\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp",
                    "old": "Email server settings.\r\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp"
                  },
                  "$properties": [
                    {
                      "#name": "fromAddress",
                      "Description": {
                        "new": "Address used when sending out emails\nhttps://pkg.go.dev/net/mail#Address",
                        "old": "Address used when sending out emails\r\nhttps://pkg.go.dev/net/mail#Address"
                      }
                    },
                    {
                      "#name": "fromName",
                      "Description": {
                        "new": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\nhttps://pkg.go.dev/net/mail#Address",
                        "old": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\r\nhttps://pkg.go.dev/net/mail#Address"
                      }
                    },
                    {
                      "#name": "startTLSPolicy",
                      "Description": {
                        "new": "The StartTLSPolicy setting of the SMTP configuration\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy",
                        "old": "The StartTLSPolicy setting of the SMTP configuration\r\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy"
                      }
                    },
                    {
                      "#name": "skipVerify",
                      "Description": {
                        "new": "Verify SSL for SMTP server. Default is false\nhttps://pkg.go.dev/crypto/tls#Config",
                        "old": "Verify SSL for SMTP server. Default is false\r\nhttps://pkg.go.dev/crypto/tls#Config"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The managed identity of the grafana resource."
          }
        },
        {
          "@removed_e80fecf3fbf346689a93bb8cbeaccb52": {
            "#name": "id",
            "Description": "ARM id of the grafana resource",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_f38471ae935c437e9b743ea5fabf43c2": {
            "#name": "name",
            "Description": "Name of the grafana resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_ae17bba89a504c2c9c940029750f24eb": {
            "#name": "type",
            "Description": "The type of the grafana resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_905f305b14434b65820f340120773c03": {
            "#name": "systemData",
            "Description": "The system meta data relating to this grafana resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        },
        {
          "@removed_c711258c7a324fef85c68fde5fc782a9": {
            "#name": "tags",
            "Description": "The tags for grafana resource.",
            "Required": false,
            "Type": "object"
          }
        },
        {
          "@removed_4a75c37a014f48fda75d009bc1889b31": {
            "#name": "location",
            "Description": "The geo-location where the grafana 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)

{
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
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)

{
sku:
{
Description: The Sku of the grafana resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
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_Delete (updated)
Description :  Delete a workspace for Grafana resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Grafana_Delete",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation URI for long running operation."
        }
      },
      {
        "@added_c56fb24b0bc44590b12680e6f5a0e561": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /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)

{}

⚐ Response (202)

{
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 ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
IntegrationFabrics_List (updated)
Description :  List IntegrationFabric resources by ManagedGrafana
Reference :  Link ¶

⚶ Changes

{
  "#id": "IntegrationFabrics_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/integrationFabrics
{
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)

{
value:
{
Description: The IntegrationFabric items on this page ,
Required: True ,
}
[
{
properties:
{
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 ,
targetResourceId:
{
Description: The resource Id of the Azure resource being integrated with Azure Managed Grafana. E.g., an Azure Kubernetes Service cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
dataSourceResourceId:
{
Description: The resource Id of the Azure resource which is used to configure Grafana data source. E.g., an Azure Monitor Workspace, an Azure Data Explorer cluster, etc. ,
Format: arm-id ,
Required: False ,
}
string ,
scenarios:
{
Description: A list of integration scenarios covered by this integration fabric ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
IntegrationFabrics_Create (updated)
Description :  Create a IntegrationFabric
Reference :  Link ¶

⚶ Changes

{
  "#id": "IntegrationFabrics_Create",
  "$responses": {
    "201": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation URI for long running operation."
        }
      },
      {
        "@added_087e223fa5f144b0ac377f9adc1e1b65": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/integrationFabrics/{integrationFabricName}
{
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 ,
integrationFabricName:
{
Description: The integration fabric name of Azure Managed Grafana. ,
Required: True ,
}
string ,
requestBodyParameters:
{
Required: True ,
}
{
properties:
{
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 ,
targetResourceId:
{
Description: The resource Id of the Azure resource being integrated with Azure Managed Grafana. E.g., an Azure Kubernetes Service cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
dataSourceResourceId:
{
Description: The resource Id of the Azure resource which is used to configure Grafana data source. E.g., an Azure Monitor Workspace, an Azure Data Explorer cluster, etc. ,
Format: arm-id ,
Required: False ,
}
string ,
scenarios:
{
Description: A list of integration scenarios covered by this integration fabric ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
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 ,
targetResourceId:
{
Description: The resource Id of the Azure resource being integrated with Azure Managed Grafana. E.g., an Azure Kubernetes Service cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
dataSourceResourceId:
{
Description: The resource Id of the Azure resource which is used to configure Grafana data source. E.g., an Azure Monitor Workspace, an Azure Data Explorer cluster, etc. ,
Format: arm-id ,
Required: False ,
}
string ,
scenarios:
{
Description: A list of integration scenarios covered by this integration fabric ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ 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 integration fabric resource type. ,
}
{
properties:
{
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 ,
targetResourceId:
{
Description: The resource Id of the Azure resource being integrated with Azure Managed Grafana. E.g., an Azure Kubernetes Service cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
dataSourceResourceId:
{
Description: The resource Id of the Azure resource which is used to configure Grafana data source. E.g., an Azure Monitor Workspace, an Azure Data Explorer cluster, etc. ,
Format: arm-id ,
Required: False ,
}
string ,
scenarios:
{
Description: A list of integration scenarios covered by this integration fabric ,
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 ,
}
,
]
,
}
,
}
IntegrationFabrics_Update (updated)
Description :  Update a IntegrationFabric
Reference :  Link ¶

⚶ Changes

{
  "#id": "IntegrationFabrics_Update",
  "$responses": {
    "202": [
      {
        "@added_c35c5c03caa44f47aa8393f7dd9345c5": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@added_59717056c6a649a0881037a05710eb21": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      },
      {
        "@removed_31cfd424427041b887259c95ea02407b": {
          "#name": "location",
          "Description": "Operation URI for long running operation.",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/integrationFabrics/{integrationFabricName}
{
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 ,
integrationFabricName:
{
Description: The integration fabric name of Azure Managed Grafana. ,
Required: True ,
}
string ,
requestBodyParameters:
{
Required: True ,
}
{
tags:
{
Description: The new tags of the Integration Fabric resource. ,
Required: False ,
}
object ,
properties:
{
Description: The new properties of this Integration Fabric resource ,
Required: False ,
}
{
scenarios:
{
Description: The new integration scenarios covered by this integration fabric. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
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 ,
targetResourceId:
{
Description: The resource Id of the Azure resource being integrated with Azure Managed Grafana. E.g., an Azure Kubernetes Service cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
dataSourceResourceId:
{
Description: The resource Id of the Azure resource which is used to configure Grafana data source. E.g., an Azure Monitor Workspace, an Azure Data Explorer cluster, etc. ,
Format: arm-id ,
Required: False ,
}
string ,
scenarios:
{
Description: A list of integration scenarios covered by this integration fabric ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
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 ,
}

⚐ 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 ,
}
,
]
,
}
,
}
IntegrationFabrics_Delete (updated)
Description :  Delete a IntegrationFabric
Reference :  Link ¶

⚶ Changes

{
  "#id": "IntegrationFabrics_Delete",
  "$responses": {
    "202": [
      {
        "@added_cd5dbd93356b497ab25d6225f4a66278": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@added_326a6b1b41f6469885d8a56613ffce51": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      },
      {
        "@removed_109d75617ff841738e9859a9743dfb57": {
          "#name": "location",
          "Description": "Operation URI for long running operation.",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/integrationFabrics/{integrationFabricName}
{
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 ,
integrationFabricName:
{
Description: The integration fabric name of Azure Managed Grafana. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
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 ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ManagedPrivateEndpoints_List (updated)
Description :  List all managed private endpoints of a grafana resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagedPrivateEndpoints_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/managedPrivateEndpoints
{
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)

{
value:
{
Description: The ManagedPrivateEndpointModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Resource properties. ,
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 ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource for which the managed private endpoint is pointing to. ,
Required: False ,
}
string ,
privateLinkResourceRegion:
{
Description: The region of the resource to which the managed private endpoint is pointing to. ,
Required: False ,
}
string ,
groupIds:
{
Description: The group Ids of the managed private endpoint. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: User input request message of the managed private endpoint. ,
Required: False ,
}
string ,
connectionState:
{
Description: The state of managed private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The approval/rejection status of managed private endpoint connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
}
,
privateLinkServiceUrl:
{
Description: The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port. ,
Required: False ,
}
string ,
privateLinkServicePrivateIP:
{
Description: The private IP of private endpoint after approval. This property is empty before connection is approved. ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ManagedPrivateEndpoints_Create (updated)
Description :  Create or update a managed private endpoint for a grafana resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagedPrivateEndpoints_Create",
  "$responses": {
    "201": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation URI for long running operation."
        }
      },
      {
        "@added_f6e31046c02b4977b69621e023533bb5": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/managedPrivateEndpoints/{managedPrivateEndpointName}
{
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 ,
managedPrivateEndpointName:
{
Description: The managed private endpoint name of Azure Managed Grafana. ,
Required: True ,
}
string ,
requestBodyParameters:
{
Description: The managed private endpoint to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
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 ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource for which the managed private endpoint is pointing to. ,
Required: False ,
}
string ,
privateLinkResourceRegion:
{
Description: The region of the resource to which the managed private endpoint is pointing to. ,
Required: False ,
}
string ,
groupIds:
{
Description: The group Ids of the managed private endpoint. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: User input request message of the managed private endpoint. ,
Required: False ,
}
string ,
connectionState:
{
Description: The state of managed private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The approval/rejection status of managed private endpoint connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
}
,
privateLinkServiceUrl:
{
Description: The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port. ,
Required: False ,
}
string ,
privateLinkServicePrivateIP:
{
Description: The private IP of private endpoint after approval. This property is empty before connection is approved. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
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 ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource for which the managed private endpoint is pointing to. ,
Required: False ,
}
string ,
privateLinkResourceRegion:
{
Description: The region of the resource to which the managed private endpoint is pointing to. ,
Required: False ,
}
string ,
groupIds:
{
Description: The group Ids of the managed private endpoint. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: User input request message of the managed private endpoint. ,
Required: False ,
}
string ,
connectionState:
{
Description: The state of managed private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The approval/rejection status of managed private endpoint connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
}
,
privateLinkServiceUrl:
{
Description: The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port. ,
Required: False ,
}
string ,
privateLinkServicePrivateIP:
{
Description: The private IP of private endpoint after approval. This property is empty before connection is approved. ,
Required: False ,
}
string ,
}
,
}

⚐ 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 managed private endpoint resource type. ,
}
{
properties:
{
Description: Resource properties. ,
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 ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource for which the managed private endpoint is pointing to. ,
Required: False ,
}
string ,
privateLinkResourceRegion:
{
Description: The region of the resource to which the managed private endpoint is pointing to. ,
Required: False ,
}
string ,
groupIds:
{
Description: The group Ids of the managed private endpoint. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: User input request message of the managed private endpoint. ,
Required: False ,
}
string ,
connectionState:
{
Description: The state of managed private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The approval/rejection status of managed private endpoint connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
}
,
privateLinkServiceUrl:
{
Description: The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port. ,
Required: False ,
}
string ,
privateLinkServicePrivateIP:
{
Description: The private IP of private endpoint after approval. This property is empty before connection is approved. ,
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 ,
}
,
]
,
}
,
}
ManagedPrivateEndpoints_Update (updated)
Description :  Update a managed private endpoint for an existing grafana resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagedPrivateEndpoints_Update",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation URI for long running operation."
        }
      },
      {
        "@added_f66f93f856944b3b94cb1ec74b78e247": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/managedPrivateEndpoints/{managedPrivateEndpointName}
{
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 ,
managedPrivateEndpointName:
{
Description: The managed private endpoint name of Azure Managed Grafana. ,
Required: True ,
}
string ,
requestBodyParameters:
{
Description: Properties that can be updated to an existing managed private endpoint. ,
Required: True ,
}
{
tags:
{
Description: The new tags of the managed private endpoint. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
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 ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource for which the managed private endpoint is pointing to. ,
Required: False ,
}
string ,
privateLinkResourceRegion:
{
Description: The region of the resource to which the managed private endpoint is pointing to. ,
Required: False ,
}
string ,
groupIds:
{
Description: The group Ids of the managed private endpoint. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: User input request message of the managed private endpoint. ,
Required: False ,
}
string ,
connectionState:
{
Description: The state of managed private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The approval/rejection status of managed private endpoint connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
}
,
privateLinkServiceUrl:
{
Description: The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port. ,
Required: False ,
}
string ,
privateLinkServicePrivateIP:
{
Description: The private IP of private endpoint after approval. This property is empty before connection is approved. ,
Required: False ,
}
string ,
}
,
}

⚐ 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 managed private endpoint resource type. ,
}
{
properties:
{
Description: Resource properties. ,
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 ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource for which the managed private endpoint is pointing to. ,
Required: False ,
}
string ,
privateLinkResourceRegion:
{
Description: The region of the resource to which the managed private endpoint is pointing to. ,
Required: False ,
}
string ,
groupIds:
{
Description: The group Ids of the managed private endpoint. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: User input request message of the managed private endpoint. ,
Required: False ,
}
string ,
connectionState:
{
Description: The state of managed private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The approval/rejection status of managed private endpoint connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
}
,
privateLinkServiceUrl:
{
Description: The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port. ,
Required: False ,
}
string ,
privateLinkServicePrivateIP:
{
Description: The private IP of private endpoint after approval. This property is empty before connection is approved. ,
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 ,
}
,
]
,
}
,
}
ManagedPrivateEndpoints_Delete (updated)
Description :  Delete a managed private endpoint for a grafana resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagedPrivateEndpoints_Delete",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation URI for long running operation."
        }
      },
      {
        "@added_0350a24cb95043c5b6601a1694d8d279": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/managedPrivateEndpoints/{managedPrivateEndpointName}
{
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 ,
managedPrivateEndpointName:
{
Description: The managed private endpoint name of Azure Managed Grafana. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
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 ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (updated)
Description :  Get private endpoint connection
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_List",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PrivateEndpointConnection list operation.",
        "old": "List of private endpoint connection associated with the specified storage account"
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateEndpointConnection items on this page",
            "old": "Array of private endpoint connections"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of operation list results (if there are any)."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateEndpointConnections
{
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)

{
value:
{
Description: The PrivateEndpointConnection items on this page ,
Required: True ,
}
[
{
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Approve (updated)
Description :  Manual approve private endpoint connection
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Approve",
  "$responses": {
    "201": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation URI for long running operation."
        }
      },
      {
        "@added_d924d943ca9a49c397c5541cb4f27d71": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name of Azure Managed Grafana. ,
Required: True ,
}
string ,
body:
{
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 ,
}
,
}
,
}

⚐ 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 Private Endpoint Connection resource. ,
}
{
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (updated)
Description :  Delete private endpoint connection
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Delete",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation URI for long running operation."
        }
      },
      {
        "@added_5d383ceb44484d46be7957d0a51e7d31": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name of Azure Managed Grafana. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
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 ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateLinkResources_List (updated)
Description :  List all private link resources information for this grafana resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateLinkResources_List",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PrivateLinkResource list operation.",
        "old": "A list of private link resources"
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateLinkResource items on this page",
            "old": "Array of private link resources"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of operation list results (if there are any)."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateLinkResources
{
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)

{
value:
{
Description: The PrivateLinkResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Resource properties. ,
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 ,
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ManagedPrivateEndpoints_Refresh (updated)
Description :  Refresh and sync managed private endpoints of a grafana resource to latest state.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagedPrivateEndpoints_Refresh",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation URI for long running operation."
        }
      },
      {
        "@added_16ea4542f403488ebc0347afedcb731c": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/refreshManagedPrivateEndpoints
{
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)

{}

⚐ Response (202)

{
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 ,
}

⚐ 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 ,
}
,
]
,
}
,
}