Grafana - Update

Service:: Managed Grafana

API Version:: 2025-08-01

Update a workspace for Grafana resource.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}?api-version=2025-08-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
workspaceName	path	True	string pattern: ^[a-zA-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]$	The workspace name of Azure Managed Grafana.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
identity	ManagedServiceIdentity	The managed identity of the grafana resource.
properties	ManagedGrafanaPropertiesUpdateParameters	Properties specific to the managed grafana resource.
sku	ResourceSku	Represents the SKU of a resource.
tags	object	The new tags of the grafana resource.

Responses

Name

Type

Description

200 OK

Azure operation completed successfully.

202 Accepted

The request has been accepted for processing, but processing has not yet completed.

Headers

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Grafana_Update

Sample request

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Dashboard/grafana/myWorkspace?api-version=2025-08-01

{
  "properties": {
    "apiKey": "Enabled",
    "deterministicOutboundIP": "Enabled",
    "enterpriseConfigurations": {
      "marketplaceAutoRenew": "Enabled",
      "marketplacePlanId": "myPlanId"
    },
    "grafanaConfigurations": {
      "security": {
        "csrfAlwaysCheck": false
      },
      "smtp": {
        "enabled": true,
        "fromAddress": "test@sendemail.com",
        "fromName": "emailsender",
        "host": "smtp.sendemail.com:587",
        "password": "<password>",
        "skipVerify": true,
        "startTLSPolicy": "OpportunisticStartTLS",
        "user": "username"
      },
      "snapshots": {
        "externalEnabled": true
      },
      "unifiedAlertingScreenshots": {
        "captureEnabled": false
      },
      "users": {
        "editorsCanAdmin": true,
        "viewersCanEdit": true
      }
    },
    "grafanaIntegrations": {
      "azureMonitorWorkspaceIntegrations": [
        {
          "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace"
        }
      ]
    },
    "grafanaMajorVersion": "9",
    "grafanaPlugins": {
      "sample-plugin-id": {}
    }
  },
  "sku": {
    "name": "Standard"
  },
  "tags": {
    "Environment": "Dev 2"
  }
}


import com.azure.resourcemanager.dashboard.models.ApiKey;
import com.azure.resourcemanager.dashboard.models.AzureMonitorWorkspaceIntegration;
import com.azure.resourcemanager.dashboard.models.DeterministicOutboundIp;
import com.azure.resourcemanager.dashboard.models.EnterpriseConfigurations;
import com.azure.resourcemanager.dashboard.models.GrafanaConfigurations;
import com.azure.resourcemanager.dashboard.models.GrafanaIntegrations;
import com.azure.resourcemanager.dashboard.models.GrafanaPlugin;
import com.azure.resourcemanager.dashboard.models.ManagedGrafana;
import com.azure.resourcemanager.dashboard.models.ManagedGrafanaPropertiesUpdateParameters;
import com.azure.resourcemanager.dashboard.models.MarketplaceAutoRenew;
import com.azure.resourcemanager.dashboard.models.ResourceSku;
import com.azure.resourcemanager.dashboard.models.Security;
import com.azure.resourcemanager.dashboard.models.Smtp;
import com.azure.resourcemanager.dashboard.models.Snapshots;
import com.azure.resourcemanager.dashboard.models.StartTlsPolicy;
import com.azure.resourcemanager.dashboard.models.UnifiedAlertingScreenshots;
import com.azure.resourcemanager.dashboard.models.Users;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Grafana Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-08-01/Grafana_Update.json
     */
    /**
     * Sample code: Grafana_Update.
     * 
     * @param manager Entry point to DashboardManager.
     */
    public static void grafanaUpdate(com.azure.resourcemanager.dashboard.DashboardManager manager) {
        ManagedGrafana resource = manager.grafanas()
            .getByResourceGroupWithResponse("myResourceGroup", "myWorkspace", com.azure.core.util.Context.NONE)
            .getValue();
        resource.update().withTags(mapOf("Environment", "Dev 2")).withSku(new ResourceSku().withName("Standard"))
            .withProperties(new ManagedGrafanaPropertiesUpdateParameters().withApiKey(ApiKey.ENABLED)
                .withDeterministicOutboundIp(DeterministicOutboundIp.ENABLED)
                .withGrafanaIntegrations(new GrafanaIntegrations().withAzureMonitorWorkspaceIntegrations(
                    Arrays.asList(new AzureMonitorWorkspaceIntegration().withAzureMonitorWorkspaceResourceId(
                        "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace"))))
                .withEnterpriseConfigurations(new EnterpriseConfigurations().withMarketplacePlanId("myPlanId")
                    .withMarketplaceAutoRenew(MarketplaceAutoRenew.ENABLED))
                .withGrafanaConfigurations(new GrafanaConfigurations()
                    .withSmtp(new Smtp().withEnabled(true).withHost("smtp.sendemail.com:587").withUser("username")
                        .withPassword("fakeTokenPlaceholder").withFromAddress("test@sendemail.com")
                        .withFromName("emailsender").withStartTlsPolicy(StartTlsPolicy.OPPORTUNISTIC_START_TLS)
                        .withSkipVerify(true))
                    .withSnapshots(new Snapshots().withExternalEnabled(true))
                    .withUsers(new Users().withViewersCanEdit(true).withEditorsCanAdmin(true))
                    .withSecurity(new Security().withCsrfAlwaysCheck(false))
                    .withUnifiedAlertingScreenshots(new UnifiedAlertingScreenshots().withCaptureEnabled(false)))
                .withGrafanaPlugins(mapOf("sample-plugin-id", new GrafanaPlugin())).withGrafanaMajorVersion("9"))
            .apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.dashboard import DashboardManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dashboard
# USAGE
    python grafana_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DashboardManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.grafana.begin_update(
        resource_group_name="myResourceGroup",
        workspace_name="myWorkspace",
        request_body_parameters={
            "properties": {
                "apiKey": "Enabled",
                "deterministicOutboundIP": "Enabled",
                "enterpriseConfigurations": {"marketplaceAutoRenew": "Enabled", "marketplacePlanId": "myPlanId"},
                "grafanaConfigurations": {
                    "security": {"csrfAlwaysCheck": False},
                    "smtp": {
                        "enabled": True,
                        "fromAddress": "test@sendemail.com",
                        "fromName": "emailsender",
                        "host": "smtp.sendemail.com:587",
                        "password": "<password>",
                        "skipVerify": True,
                        "startTLSPolicy": "OpportunisticStartTLS",
                        "user": "username",
                    },
                    "snapshots": {"externalEnabled": True},
                    "unifiedAlertingScreenshots": {"captureEnabled": False},
                    "users": {"editorsCanAdmin": True, "viewersCanEdit": True},
                },
                "grafanaIntegrations": {
                    "azureMonitorWorkspaceIntegrations": [
                        {
                            "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace"
                        }
                    ]
                },
                "grafanaMajorVersion": "9",
                "grafanaPlugins": {"sample-plugin-id": {}},
            },
            "sku": {"name": "Standard"},
            "tags": {"Environment": "Dev 2"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-08-01/Grafana_Update.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdashboard_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dashboard/armdashboard/v2"
)

// Generated from example definition: 2025-08-01/Grafana_Update.json
func ExampleGrafanaClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdashboard.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewGrafanaClient().BeginUpdate(ctx, "myResourceGroup", "myWorkspace", armdashboard.ManagedGrafanaUpdateParameters{
		Properties: &armdashboard.ManagedGrafanaPropertiesUpdateParameters{
			APIKey:                  to.Ptr(armdashboard.APIKeyEnabled),
			DeterministicOutboundIP: to.Ptr(armdashboard.DeterministicOutboundIPEnabled),
			EnterpriseConfigurations: &armdashboard.EnterpriseConfigurations{
				MarketplaceAutoRenew: to.Ptr(armdashboard.MarketplaceAutoRenewEnabled),
				MarketplacePlanID:    to.Ptr("myPlanId"),
			},
			GrafanaConfigurations: &armdashboard.GrafanaConfigurations{
				Security: &armdashboard.Security{
					CsrfAlwaysCheck: to.Ptr(false),
				},
				SMTP: &armdashboard.SMTP{
					Enabled:        to.Ptr(true),
					FromAddress:    to.Ptr("test@sendemail.com"),
					FromName:       to.Ptr("emailsender"),
					Host:           to.Ptr("smtp.sendemail.com:587"),
					Password:       to.Ptr("<password>"),
					SkipVerify:     to.Ptr(true),
					StartTLSPolicy: to.Ptr(armdashboard.StartTLSPolicyOpportunisticStartTLS),
					User:           to.Ptr("username"),
				},
				Snapshots: &armdashboard.Snapshots{
					ExternalEnabled: to.Ptr(true),
				},
				UnifiedAlertingScreenshots: &armdashboard.UnifiedAlertingScreenshots{
					CaptureEnabled: to.Ptr(false),
				},
				Users: &armdashboard.Users{
					EditorsCanAdmin: to.Ptr(true),
					ViewersCanEdit:  to.Ptr(true),
				},
			},
			GrafanaIntegrations: &armdashboard.GrafanaIntegrations{
				AzureMonitorWorkspaceIntegrations: []*armdashboard.AzureMonitorWorkspaceIntegration{
					{
						AzureMonitorWorkspaceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace"),
					},
				},
			},
			GrafanaMajorVersion: to.Ptr("9"),
			GrafanaPlugins: map[string]*armdashboard.GrafanaPlugin{
				"sample-plugin-id": {},
			},
		},
		SKU: &armdashboard.ResourceSKU{
			Name: to.Ptr("Standard"),
		},
		Tags: map[string]*string{
			"Environment": to.Ptr("Dev 2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdashboard.GrafanaClientUpdateResponse{
	// 	ManagedGrafana: &armdashboard.ManagedGrafana{
	// 		Name: to.Ptr("myWorkspace"),
	// 		Type: to.Ptr("Microsoft.Dashboard/grafana"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace"),
	// 		Location: to.Ptr("West US"),
	// 		Properties: &armdashboard.ManagedGrafanaProperties{
	// 			APIKey: to.Ptr(armdashboard.APIKeyEnabled),
	// 			AutoGeneratedDomainNameLabelScope: to.Ptr(armdashboard.AutoGeneratedDomainNameLabelScopeTenantReuse),
	// 			DeterministicOutboundIP: to.Ptr(armdashboard.DeterministicOutboundIPEnabled),
	// 			Endpoint: to.Ptr("https://myworkspace-abcdefghijklmnop.wus.grafana.azure.com"),
	// 			EnterpriseConfigurations: &armdashboard.EnterpriseConfigurations{
	// 				MarketplaceAutoRenew: to.Ptr(armdashboard.MarketplaceAutoRenewEnabled),
	// 				MarketplacePlanID: to.Ptr("myPlanId"),
	// 			},
	// 			GrafanaConfigurations: &armdashboard.GrafanaConfigurations{
	// 				Security: &armdashboard.Security{
	// 					CsrfAlwaysCheck: to.Ptr(false),
	// 				},
	// 				SMTP: &armdashboard.SMTP{
	// 					Enabled: to.Ptr(true),
	// 					FromAddress: to.Ptr("test@sendemail.com"),
	// 					FromName: to.Ptr("emailsender"),
	// 					Host: to.Ptr("smtp.sendemail.com:587"),
	// 					SkipVerify: to.Ptr(true),
	// 					StartTLSPolicy: to.Ptr(armdashboard.StartTLSPolicyOpportunisticStartTLS),
	// 					User: to.Ptr("username"),
	// 				},
	// 				Snapshots: &armdashboard.Snapshots{
	// 					ExternalEnabled: to.Ptr(true),
	// 				},
	// 				Users: &armdashboard.Users{
	// 					EditorsCanAdmin: to.Ptr(true),
	// 					ViewersCanEdit: to.Ptr(true),
	// 				},
	// 			},
	// 			GrafanaIntegrations: &armdashboard.GrafanaIntegrations{
	// 				AzureMonitorWorkspaceIntegrations: []*armdashboard.AzureMonitorWorkspaceIntegration{
	// 					{
	// 						AzureMonitorWorkspaceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace"),
	// 					},
	// 				},
	// 			},
	// 			GrafanaMajorVersion: to.Ptr("9"),
	// 			GrafanaPlugins: map[string]*armdashboard.GrafanaPlugin{
	// 				"sample-plugin-id": &armdashboard.GrafanaPlugin{
	// 					PluginID: to.Ptr("sample-plugin-id"),
	// 				},
	// 			},
	// 			GrafanaVersion: to.Ptr("9.4.5"),
	// 			OutboundIPs: []*string{
	// 				to.Ptr("192.168.0.1"),
	// 				to.Ptr("192.168.0.2"),
	// 			},
	// 			ProvisioningState: to.Ptr(armdashboard.ProvisioningStateSucceeded),
	// 			PublicNetworkAccess: to.Ptr(armdashboard.PublicNetworkAccessEnabled),
	// 			ZoneRedundancy: to.Ptr(armdashboard.ZoneRedundancyEnabled),
	// 		},
	// 		SKU: &armdashboard.ResourceSKU{
	// 			Name: to.Ptr("Standard"),
	// 		},
	// 		Tags: map[string]*string{
	// 			"Environment": to.Ptr("Dev 2"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DashboardManagementClient } = require("@azure/arm-dashboard");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to update a workspace for Grafana resource.
 *
 * @summary update a workspace for Grafana resource.
 * x-ms-original-file: 2025-08-01/Grafana_Update.json
 */
async function grafanaUpdate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new DashboardManagementClient(credential, subscriptionId);
  const result = await client.grafana.update("myResourceGroup", "myWorkspace", {
    properties: {
      apiKey: "Enabled",
      deterministicOutboundIP: "Enabled",
      enterpriseConfigurations: {
        marketplaceAutoRenew: "Enabled",
        marketplacePlanId: "myPlanId",
      },
      grafanaConfigurations: {
        security: { csrfAlwaysCheck: false },
        smtp: {
          enabled: true,
          fromAddress: "test@sendemail.com",
          fromName: "emailsender",
          host: "smtp.sendemail.com:587",
          password: "<password>",
          skipVerify: true,
          startTLSPolicy: "OpportunisticStartTLS",
          user: "username",
        },
        snapshots: { externalEnabled: true },
        unifiedAlertingScreenshots: { captureEnabled: false },
        users: { editorsCanAdmin: true, viewersCanEdit: true },
      },
      grafanaIntegrations: {
        azureMonitorWorkspaceIntegrations: [
          {
            azureMonitorWorkspaceResourceId:
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace",
          },
        ],
      },
      grafanaMajorVersion: "9",
      grafanaPlugins: { "sample-plugin-id": {} },
    },
    sku: { name: "Standard" },
    tags: { Environment: "Dev 2" },
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Grafana.Models;
using Azure.ResourceManager.Grafana;

// Generated from example definition: 2025-08-01/Grafana_Update.json
// this example is just showing the usage of "ManagedGrafana_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedGrafanaResource created on azure
// for more information of creating ManagedGrafanaResource, please refer to the document of ManagedGrafanaResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myResourceGroup";
string workspaceName = "myWorkspace";
ResourceIdentifier managedGrafanaResourceId = ManagedGrafanaResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
ManagedGrafanaResource managedGrafana = client.GetManagedGrafanaResource(managedGrafanaResourceId);

// invoke the operation
ManagedGrafanaPatch patch = new ManagedGrafanaPatch
{
    Sku = new ManagedGrafanaSku("Standard"),
    Tags =
    {
    ["Environment"] = "Dev 2"
    },
    Properties = new ManagedGrafanaPatchProperties
    {
        ApiKey = GrafanaApiKey.Enabled,
        DeterministicOutboundIP = DeterministicOutboundIP.Enabled,
        MonitorWorkspaceIntegrations = {new MonitorWorkspaceIntegration
        {
        MonitorWorkspaceResourceId = new ResourceIdentifier("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace"),
        }},
        EnterpriseConfigurations = new EnterpriseConfigurations
        {
            MarketplacePlanId = "myPlanId",
            MarketplaceAutoRenew = MarketplaceAutoRenew.Enabled,
        },
        GrafanaConfigurations = new GrafanaConfigurations
        {
            Smtp = new GrafanaSmtpSettings
            {
                IsEnabled = true,
                Host = "smtp.sendemail.com:587",
                User = "username",
                Password = "<password>",
                FromAddress = "test@sendemail.com",
                FromName = "emailsender",
                StartTLSPolicy = GrafanaStartTlsPolicy.OpportunisticStartTls,
                SkipVerify = true,
            },
            IsExternalEnabled = true,
            Users = new GrafanaUserSettings
            {
                ViewersCanEdit = true,
                EditorsCanAdmin = true,
            },
            IsCsrfAlwaysCheckEnabled = false,
            IsCaptureEnabled = false,
        },
        GrafanaPlugins =
        {
        ["sample-plugin-id"] = new GrafanaPlugin()
        },
        GrafanaMajorVersion = "9",
    },
};
ArmOperation<ManagedGrafanaResource> lro = await managedGrafana.UpdateAsync(WaitUntil.Completed, patch);
ManagedGrafanaResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ManagedGrafanaData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "name": "myWorkspace",
  "type": "Microsoft.Dashboard/grafana",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace",
  "location": "West US",
  "properties": {
    "apiKey": "Enabled",
    "autoGeneratedDomainNameLabelScope": "TenantReuse",
    "deterministicOutboundIP": "Enabled",
    "endpoint": "https://myworkspace-abcdefghijklmnop.wus.grafana.azure.com",
    "enterpriseConfigurations": {
      "marketplaceAutoRenew": "Enabled",
      "marketplacePlanId": "myPlanId"
    },
    "grafanaConfigurations": {
      "security": {
        "csrfAlwaysCheck": false
      },
      "smtp": {
        "enabled": true,
        "fromAddress": "test@sendemail.com",
        "fromName": "emailsender",
        "host": "smtp.sendemail.com:587",
        "skipVerify": true,
        "startTLSPolicy": "OpportunisticStartTLS",
        "user": "username"
      },
      "snapshots": {
        "externalEnabled": true
      },
      "users": {
        "editorsCanAdmin": true,
        "viewersCanEdit": true
      }
    },
    "grafanaIntegrations": {
      "azureMonitorWorkspaceIntegrations": [
        {
          "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace"
        }
      ]
    },
    "grafanaMajorVersion": "9",
    "grafanaPlugins": {
      "sample-plugin-id": {
        "pluginId": "sample-plugin-id"
      }
    },
    "grafanaVersion": "9.4.5",
    "outboundIPs": [
      "192.168.0.1",
      "192.168.0.2"
    ],
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled",
    "zoneRedundancy": "Enabled"
  },
  "sku": {
    "name": "Standard"
  },
  "tags": {
    "Environment": "Dev 2"
  }
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2025-08-01

{
  "name": "myWorkspace",
  "type": "Microsoft.Dashboard/grafana",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace",
  "location": "West US",
  "properties": {
    "apiKey": "Enabled",
    "autoGeneratedDomainNameLabelScope": "TenantReuse",
    "deterministicOutboundIP": "Enabled",
    "endpoint": "https://myworkspace-abcdefghijklmnop.wus.grafana.azure.com",
    "enterpriseConfigurations": {
      "marketplaceAutoRenew": "Enabled",
      "marketplacePlanId": "myPlanId"
    },
    "grafanaConfigurations": {
      "security": {
        "csrfAlwaysCheck": false
      },
      "smtp": {
        "enabled": true,
        "fromAddress": "test@sendemail.com",
        "fromName": "emailsender",
        "host": "smtp.sendemail.com:587",
        "skipVerify": true,
        "startTLSPolicy": "OpportunisticStartTLS",
        "user": "username"
      },
      "snapshots": {
        "externalEnabled": true
      },
      "users": {
        "editorsCanAdmin": true,
        "viewersCanEdit": true
      }
    },
    "grafanaIntegrations": {
      "azureMonitorWorkspaceIntegrations": [
        {
          "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace"
        }
      ]
    },
    "grafanaMajorVersion": "9",
    "grafanaPlugins": {
      "sample-plugin-id": {
        "pluginId": "sample-plugin-id"
      }
    },
    "grafanaVersion": "9.4.5",
    "provisioningState": "Accepted",
    "publicNetworkAccess": "Enabled",
    "zoneRedundancy": "Enabled"
  },
  "sku": {
    "name": "Standard"
  },
  "systemData": {
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-02-04T02:03:01.1974346Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  },
  "tags": {
    "Environment": "Dev 2"
  }
}

Definitions

Name	Description
ApiKey	The api key setting of the Grafana instance.
AutoGeneratedDomainNameLabelScope	Scope for dns deterministic name hash calculation
AzureMonitorWorkspaceIntegration	Integrations for Azure Monitor Workspace.
createdByType	The type of identity that created the resource.
CreatorCanAdmin	The creator will have admin access for the Grafana instance.
DeterministicOutboundIP	Whether a Grafana instance uses deterministic outbound IPs.
EnterpriseConfigurations	Enterprise settings of a Grafana instance
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GrafanaConfigurations	Server configurations of a Grafana instance
GrafanaIntegrations	GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios.
GrafanaPlugin	Plugin of Grafana
ManagedGrafana	The grafana resource type.
ManagedGrafanaProperties	Properties specific to the grafana resource.
ManagedGrafanaPropertiesUpdateParameters	The properties parameters for a PATCH request to a grafana resource.
ManagedGrafanaUpdateParameters	The parameters for a PATCH request to a grafana resource.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
MarketplaceAutoRenew	The AutoRenew setting of the Enterprise subscription
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	The Private Endpoint Connection resource.
PrivateEndpointConnectionProvisioningState	The current provisioning state.
PrivateEndpointServiceConnectionStatus	The private endpoint connection status.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProvisioningState
PublicNetworkAccess	Indicate the state for enable or disable traffic over the public interface.
ResourceSku	Represents the SKU of a resource.
Security	Grafana security settings
Size	Specifies the capacity tier of the Grafana instance.
Smtp	Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp
Snapshots	Grafana Snapshots settings
StartTLSPolicy	The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy
systemData	Metadata pertaining to creation and last modification of the resource.
UnifiedAlertingScreenshots	Grafana Unified Alerting Screenshots settings
UserAssignedIdentity	User assigned identity properties
Users	Grafana users settings
ZoneRedundancy	The zone redundancy setting of the Grafana instance.

ApiKey

Enumeration

The api key setting of the Grafana instance.

Value	Description
Disabled
Enabled

AutoGeneratedDomainNameLabelScope

Enumeration

Scope for dns deterministic name hash calculation

Value	Description
TenantReuse

AzureMonitorWorkspaceIntegration

Object

Integrations for Azure Monitor Workspace.

Name	Type	Description
azureMonitorWorkspaceResourceId	string	The resource Id of the connected Azure Monitor Workspace.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CreatorCanAdmin

Enumeration

The creator will have admin access for the Grafana instance.

Value	Description
Disabled	Creator admin access is disabled
Enabled	Creator admin access is enabled

DeterministicOutboundIP

Enumeration

Whether a Grafana instance uses deterministic outbound IPs.

Value	Description
Disabled
Enabled

EnterpriseConfigurations

Object

Enterprise settings of a Grafana instance

Name	Type	Description
marketplaceAutoRenew	MarketplaceAutoRenew	The AutoRenew setting of the Enterprise subscription
marketplacePlanId	string	The Plan Id of the Azure Marketplace subscription for the Enterprise plugins

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

GrafanaConfigurations

Object

Server configurations of a Grafana instance

Name	Type	Description
security	Security	Grafana security settings
smtp	Smtp	Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp
snapshots	Snapshots	Grafana Snapshots settings
unifiedAlertingScreenshots	UnifiedAlertingScreenshots	Grafana Unified Alerting Screenshots settings
users	Users	Grafana users settings

GrafanaIntegrations

Object

GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios.

Name	Type	Description
azureMonitorWorkspaceIntegrations	AzureMonitorWorkspaceIntegration[]	Integrations for Azure Monitor Workspace.

GrafanaPlugin

Object

Plugin of Grafana

Name	Type	Description
pluginId	string	Grafana plugin id

ManagedGrafana

Object

The grafana resource type.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	ManagedGrafanaProperties	Properties specific to the grafana resource.
sku	ResourceSku	The Sku of the grafana resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ManagedGrafanaProperties

Object

Properties specific to the grafana resource.

Name	Type	Default value	Description
apiKey	ApiKey	Disabled	The api key setting of the Grafana instance.
autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope		Scope for dns deterministic name hash calculation.
creatorCanAdmin	CreatorCanAdmin		The creator will have admin access for the Grafana instance.
deterministicOutboundIP	DeterministicOutboundIP	Disabled	Whether a Grafana instance uses deterministic outbound IPs.
endpoint	string		The endpoint of the Grafana instance.
enterpriseConfigurations	EnterpriseConfigurations		Enterprise settings of a Grafana instance
grafanaConfigurations	GrafanaConfigurations		Server configurations of a Grafana instance
grafanaIntegrations	GrafanaIntegrations		GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios.
grafanaMajorVersion	string		The major Grafana software version to target.
grafanaPlugins	<string, GrafanaPlugin>		Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition.
grafanaVersion	string		The Grafana software version.
outboundIPs	string[]		List of outbound IPs if deterministicOutboundIP is enabled.
privateEndpointConnections	PrivateEndpointConnection[]		The private endpoint connections of the Grafana instance.
provisioningState	ProvisioningState		Provisioning state of the resource.
publicNetworkAccess	PublicNetworkAccess	Enabled	Indicate the state for enable or disable traffic over the public interface.
zoneRedundancy	ZoneRedundancy	Disabled	The zone redundancy setting of the Grafana instance.

ManagedGrafanaPropertiesUpdateParameters

Object

The properties parameters for a PATCH request to a grafana resource.

Name	Type	Default value	Description
apiKey	ApiKey	Disabled	The api key setting of the Grafana instance.
creatorCanAdmin	CreatorCanAdmin		The creator will have admin access for the Grafana instance.
deterministicOutboundIP	DeterministicOutboundIP	Disabled	Whether a Grafana instance uses deterministic outbound IPs.
enterpriseConfigurations	EnterpriseConfigurations		Enterprise settings of a Grafana instance
grafanaConfigurations	GrafanaConfigurations		Server configurations of a Grafana instance
grafanaIntegrations	GrafanaIntegrations		GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios.
grafanaMajorVersion	string		The major Grafana software version to target.
grafanaPlugins	<string, GrafanaPlugin>		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.
publicNetworkAccess	PublicNetworkAccess	Enabled	Indicate the state for enable or disable traffic over the public interface.
zoneRedundancy	ZoneRedundancy	Disabled	The zone redundancy setting of the Grafana instance.

ManagedGrafanaUpdateParameters

Object

The parameters for a PATCH request to a grafana resource.

Name	Type	Description
identity	ManagedServiceIdentity	The managed identity of the grafana resource.
properties	ManagedGrafanaPropertiesUpdateParameters	Properties specific to the managed grafana resource.
sku	ResourceSku	Represents the SKU of a resource.
tags	object	The new tags of the grafana resource.

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities 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.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MarketplaceAutoRenew

Enumeration

The AutoRenew setting of the Enterprise subscription

Value	Description
Disabled
Enabled

PrivateEndpoint

Object

The Private Endpoint resource.

Name	Type	Description
id	string	The ARM identifier for Private Endpoint

PrivateEndpointConnection

Object

The Private Endpoint Connection resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.groupIds	string[]	The private endpoint connection group ids.
properties.privateEndpoint	PrivateEndpoint	The resource of private end point.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeration

The current provisioning state.

Value	Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Enumeration

The private endpoint connection status.

Value	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

A collection of information about the state of the connection between service consumer and provider.

Name	Type	Description
actionsRequired	string	A message indicating if changes on the service provider require any updates on the consumer.
description	string	The reason for approval/rejection of the connection.
status	PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ProvisioningState

Enumeration

Value	Description
Accepted
Creating
Updating
Deleting
Succeeded
Failed
Canceled
Deleted
NotSpecified

PublicNetworkAccess

Enumeration

Indicate the state for enable or disable traffic over the public interface.

Value	Description
Enabled
Disabled

ResourceSku

Object

Represents the SKU of a resource.

Name	Type	Description
name	string	The name of the SKU.
size	Size	Specifies the capacity tier of the Grafana instance.

Security

Object

Grafana security settings

Name	Type	Description
csrfAlwaysCheck	boolean	Set to true to execute the CSRF check even if the login cookie is not in a request (default false).

Size

Enumeration

Specifies the capacity tier of the Grafana instance.

Value	Description
X1	X1 capacity tier
X2	X2 capacity tier

Smtp

Object

Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp

Name	Type	Default value	Description
enabled	boolean	False	Enable this to allow Grafana to send email. Default is false
fromAddress	string		Address used when sending out emails https://pkg.go.dev/net/mail#Address
fromName	string		Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address
host	string		SMTP server hostname with port, e.g. test.email.net:587
password	string (password)		Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes
skipVerify	boolean		Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config
startTLSPolicy	StartTLSPolicy		The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy
user	string		User of SMTP auth

Snapshots

Object

Grafana Snapshots settings

Name	Type	Description
externalEnabled	boolean	Set to false to disable external snapshot publish endpoint

StartTLSPolicy

Enumeration

The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy

Value	Description
OpportunisticStartTLS
MandatoryStartTLS
NoStartTLS

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UnifiedAlertingScreenshots

Object

Grafana Unified Alerting Screenshots settings

Name	Type	Description
captureEnabled	boolean	Set to false to disable capture screenshot in Unified Alert due to performance issue.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

Users

Object

Grafana users settings

Name	Type	Description
editorsCanAdmin	boolean	Set to true so editors can administrate dashboards, folders and teams they create.
viewersCanEdit	boolean	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.

ZoneRedundancy

Enumeration

The zone redundancy setting of the Grafana instance.

Value	Description
Disabled
Enabled