Grafana - Create

リファレンス

サービス:: Managed Grafana

API バージョン:: 2024-10-01

Grafana リソースのワークスペースを作成または更新します。この API はべき等であるため、ユーザーは新しい grafana を作成するか、既存の grafana を更新できます。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
workspaceName	path	True	string pattern: ^[a-zA-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]$	Azure Managed Grafana のワークスペース名。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
identity	ManagedServiceIdentity	grafana リソースのマネージド ID。
location	string	grafana リソースが存在する地理的な場所
properties	ManagedGrafanaProperties	grafana リソースに固有のプロパティ。
sku	ResourceSku	grafana リソースの SKU。
tags	object	grafana リソースのタグ。

応答

名前	型	説明
200 OK	ManagedGrafana	わかりました。 Grafana リソースのワークスペースを正常に作成しました。
201 Created	ManagedGrafana	作成が開始されました。操作が正常に開始され、非同期的に完了します。ヘッダー Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。

名前

型

説明

200 OK

ManagedGrafana

わかりました。 Grafana リソースのワークスペースを正常に作成しました。

201 Created

ManagedGrafana

作成が開始されました。操作が正常に開始され、非同期的に完了します。

ヘッダー

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。

例

Grafana_Create

要求のサンプル

HTTP

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

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

応答のサンプル

状態コード:: 200

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

状態コード:: 201

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

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

定義

名前	説明
ApiKey
AutoGeneratedDomainNameLabelScope	DNS 確定的な名前ハッシュ計算のスコープ
AzureMonitorWorkspaceIntegration	Azure Monitor ワークスペースの統合。
createdByType	リソースを作成した ID の種類。
DeterministicOutboundIP
EnterpriseConfigurations	Grafana インスタンスのエンタープライズ設定
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GrafanaConfigurations	Grafana インスタンスのサーバー構成
GrafanaIntegrations	GrafanaIntegrations は、一般的な監視シナリオ用のバンドルされた監視エクスペリエンス (事前構成済みのデータソース、カスタマイズされた Grafana ダッシュボード、アラートの既定値など) です。
GrafanaPlugin	Grafana のプラグイン
ManagedGrafana	grafana リソースの種類。
ManagedGrafanaProperties	grafana リソースに固有のプロパティ。
ManagedServiceIdentity	マネージドサービス ID (システム割り当て ID またはユーザー割り当て ID)
ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
MarketplaceAutoRenew	Enterprise サブスクリプションの AutoRenew 設定
PrivateEndpoint	プライベートエンドポイントリソース。
PrivateEndpointConnection	プライベートエンドポイント接続リソース。
PrivateEndpointConnectionProvisioningState	現在のプロビジョニング状態。
PrivateEndpointServiceConnectionStatus	プライベートエンドポイント接続の状態。
PrivateLinkServiceConnectionState	サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
ProvisioningState
PublicNetworkAccess	パブリックインターフェイス経由でトラフィックを有効または無効にする状態を示します。
ResourceSku
Security	Grafana のセキュリティ設定
Smtp	電子メールサーバーの設定。 https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp
Snapshots	Grafana Snapshots の設定
StartTLSPolicy	SMTP 構成の StartTLSPolicy 設定 https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentity	ユーザー割り当て ID プロパティ
Users	Grafana ユーザー設定
ZoneRedundancy

ApiKey

列挙

値	説明
Disabled
Enabled

AutoGeneratedDomainNameLabelScope

列挙

DNS 確定的な名前ハッシュ計算のスコープ

値	説明
TenantReuse

AzureMonitorWorkspaceIntegration

Object

Azure Monitor ワークスペースの統合。

名前	型	説明
azureMonitorWorkspaceResourceId	string	接続されている Azure Monitor ワークスペースのリソース ID。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

DeterministicOutboundIP

列挙

値	説明
Disabled
Enabled

EnterpriseConfigurations

Object

Grafana インスタンスのエンタープライズ設定

名前	型	説明
marketplaceAutoRenew	MarketplaceAutoRenew	Enterprise サブスクリプションの AutoRenew 設定
marketplacePlanId	string	Enterprise プラグインの Azure Marketplace サブスクリプションのプラン ID

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

GrafanaConfigurations

Object

Grafana インスタンスのサーバー構成

名前	型	説明
security	Security	Grafana のセキュリティ設定
smtp	Smtp	電子メールサーバーの設定。 https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp
snapshots	Snapshots	Grafana Snapshots の設定
users	Users	Grafana ユーザー設定

GrafanaIntegrations

Object

GrafanaIntegrations は、一般的な監視シナリオ用のバンドルされた監視エクスペリエンス (事前構成済みのデータソース、カスタマイズされた Grafana ダッシュボード、アラートの既定値など) です。

名前	型	説明
azureMonitorWorkspaceIntegrations	AzureMonitorWorkspaceIntegration[]	Azure Monitor ワークスペースの統合。

GrafanaPlugin

Object

Grafana のプラグイン

名前	型	説明
pluginId	string	Grafana プラグイン ID

ManagedGrafana

Object

grafana リソースの種類。

名前	型	説明
id	string	grafana リソースの ARM ID
identity	ManagedServiceIdentity	grafana リソースのマネージド ID。
location	string	grafana リソースが存在する地理的な場所
name	string	grafana リソースの名前。
properties	ManagedGrafanaProperties	grafana リソースに固有のプロパティ。
sku	ResourceSku	grafana リソースの SKU。
systemData	systemData	この grafana リソースに関連するシステムメタデータ。
tags	object	grafana リソースのタグ。
type	string	grafana リソースの種類。

ManagedGrafanaProperties

Object

grafana リソースに固有のプロパティ。

名前	型	規定値	説明
apiKey	ApiKey	Disabled	Grafana インスタンスの API キー設定。
autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope		DNS 確定的な名前ハッシュ計算のスコープ。
deterministicOutboundIP	DeterministicOutboundIP	Disabled	Grafana インスタンスが決定論的送信 IP を使用するかどうか。
endpoint	string		Grafana インスタンスのエンドポイント。
enterpriseConfigurations	EnterpriseConfigurations		Grafana インスタンスのエンタープライズ設定
grafanaConfigurations	GrafanaConfigurations		Grafana インスタンスのサーバー構成
grafanaIntegrations	GrafanaIntegrations		GrafanaIntegrations は、一般的な監視シナリオ用のバンドルされた監視エクスペリエンス (事前構成済みのデータソース、カスタマイズされた Grafana ダッシュボード、アラートの既定値など) です。
grafanaMajorVersion	string		ターゲットとなる主要な Grafana ソフトウェアバージョン。
grafanaPlugins	<string, GrafanaPlugin>		Grafana インスタンスのインストール済みプラグインの一覧。キーはプラグイン ID、値はプラグイン定義です。
grafanaVersion	string		Grafana ソフトウェアバージョン。
outboundIPs	string[]		deterministicOutboundIP が有効になっている場合の送信 IP の一覧。
privateEndpointConnections	PrivateEndpointConnection[]		Grafana インスタンスのプライベートエンドポイント接続。
provisioningState	ProvisioningState		リソースのプロビジョニング状態。
publicNetworkAccess	PublicNetworkAccess	Enabled	パブリックインターフェイス経由でトラフィックを有効または無効にする状態を示します。
zoneRedundancy	ZoneRedundancy	Disabled	Grafana インスタンスのゾーン冗長設定。

ManagedServiceIdentity

Object

マネージドサービス ID (システム割り当て ID またはユーザー割り当て ID)

名前	型	説明
principalId	string (uuid)	システム割り当て ID のサービスプリンシパル ID。このプロパティは、システム割り当て ID にのみ提供されます。
tenantId	string (uuid)	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID にのみ提供されます。
type	ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned ID リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリキーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。

ManagedServiceIdentityType

列挙

マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

値	説明
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MarketplaceAutoRenew

列挙

Enterprise サブスクリプションの AutoRenew 設定

値	説明
Disabled
Enabled

PrivateEndpoint

Object

プライベートエンドポイントリソース。

名前	型	説明
id	string	プライベートエンドポイントの ARM 識別子

PrivateEndpointConnection

Object

プライベートエンドポイント接続リソース。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.groupIds	string[]	プライベートエンドポイント接続グループ ID。
properties.privateEndpoint	PrivateEndpoint	プライベートエンドポイントのリソース。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	プライベートエンドポイント接続リソースのプロビジョニング状態。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

列挙

現在のプロビジョニング状態。

値	説明
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

列挙

プライベートエンドポイント接続の状態。

値	説明
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

名前	型	説明
actionsRequired	string	サービスプロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。
description	string	接続の承認/拒否の理由。
status	PrivateEndpointServiceConnectionStatus	接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。

ProvisioningState

列挙

値	説明
Accepted
Canceled
Creating
Deleted
Deleting
Failed
NotSpecified
Succeeded
Updating

PublicNetworkAccess

列挙

パブリックインターフェイス経由でトラフィックを有効または無効にする状態を示します。

値	説明
Disabled
Enabled

ResourceSku

Object

名前	型	説明
name	string

Security

Object

Grafana のセキュリティ設定

名前	型	説明
csrfAlwaysCheck	boolean	ログイン Cookie が要求に含まれていない場合でも CSRF チェックを実行するには、true に設定します (既定値は false)。

Smtp

Object

電子メールサーバーの設定。 https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp

名前	型	規定値	説明
enabled	boolean	False	これを有効にして、Grafana が電子メールを送信できるようにします。既定値は false です
fromAddress	string		メール https://pkg.go.dev/net/mail#Address を送信するときに使用されるアドレス
fromName	string		メールを送信するときに使用する名前。既定値は "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address
host	string		SMTP サーバーのホスト名とポート (例: test.email.net:587)
password	string		SMTP 認証のパスワード。パスワードに # または ;が含まれている場合は、三重引用符で囲む必要があります
skipVerify	boolean		SMTP サーバーの SSL を確認します。既定値は false https://pkg.go.dev/crypto/tls#Config
startTLSPolicy	StartTLSPolicy		SMTP 構成の StartTLSPolicy 設定 https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy
user	string		SMTP 認証のユーザー

Snapshots

Object

Grafana Snapshots の設定

名前	型	説明
externalEnabled	boolean	外部スナップショット発行エンドポイントを無効にするには false に設定します

StartTLSPolicy

列挙

SMTP 構成の StartTLSPolicy 設定 https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy

値	説明
MandatoryStartTLS
NoStartTLS
OpportunisticStartTLS

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UserAssignedIdentity

Object

ユーザー割り当て ID プロパティ

名前	型	説明
clientId	string (uuid)	割り当てられた ID のクライアント ID。
principalId	string (uuid)	割り当てられた ID のプリンシパル ID。

Users

Object

Grafana ユーザー設定

名前	型	説明
viewersCanEdit	boolean	true に設定すると、閲覧者は探索にアクセスして使用し、アクセス権を持つダッシュボードのパネルで一時的な編集を実行できます。変更を保存できません。

ZoneRedundancy

列挙

値	説明
Disabled
Enabled

次の方法で共有

Grafana - Create

URI パラメーター

要求本文

応答

例

Grafana_Create

要求のサンプル

応答のサンプル

定義

ApiKey

AutoGeneratedDomainNameLabelScope

AzureMonitorWorkspaceIntegration

createdByType

DeterministicOutboundIP

EnterpriseConfigurations

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GrafanaConfigurations

GrafanaIntegrations

GrafanaPlugin

ManagedGrafana

ManagedGrafanaProperties

ManagedServiceIdentity

ManagedServiceIdentityType

MarketplaceAutoRenew

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ProvisioningState

PublicNetworkAccess

ResourceSku

Security

Smtp

Snapshots

StartTLSPolicy

systemData

UserAssignedIdentity

Users

ZoneRedundancy