Clusters - Get

リファレンス

Service:: Log Analytics

API Version:: 2022-10-01

Log Analytics クラスターインスタンスを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}?api-version=2022-10-01

URI パラメーター

名前	/	必須	型	説明
clusterName	path	True	string	Log Analytics クラスターの名前。
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	Cluster	OK 応答の定義。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

ClustersGet

Sample Request

HTTP

GET https://management.azure.com/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/clusters/oiautorest6685?api-version=2022-10-01

Sample Response

Status code:: 200

{
  "properties": {
    "keyVaultProperties": {
      "keyVaultUri": "https://aztest2170.vault.azure.net",
      "keyName": "aztest2170cert",
      "keyVersion": "654ft6c4e63845cbb50fd6fg51540429"
    },
    "provisioningState": "Succeeded",
    "clusterId": "1c3f2afc-9ec1-4e74-bfe8-022b83bcd7b1",
    "billingType": "Cluster",
    "lastModifiedDate": "Sun, 04 Jan 2020 17:10:56 GMT",
    "createdDate": "Mon, 13 Jan 2020 14:40:33 GMT",
    "isDoubleEncryptionEnabled": true,
    "isAvailabilityZonesEnabled": true,
    "associatedWorkspaces": [
      {
        "workspaceId": "942bdefd-e6c9-411c-ac69-70ffad564363",
        "workspaceName": "testWs1",
        "resourceId": "/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/testRG/providers/microsoft.operationalinsights/workspaces/testWs1",
        "associateDate": "Tue, 07 Jul 2020 07:35:51 GMT"
      },
      {
        "workspaceId": "c7edb8f8-67f7-41f2-bddb-aecf22507e3f",
        "workspaceName": "testWs2",
        "resourceId": "/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/testRG/providers/microsoft.operationalinsights/workspaces/testWs2",
        "associateDate": "Mon, 13 Jan 2020 16:03:39 GMT"
      }
    ],
    "capacityReservationProperties": {
      "lastSkuUpdate": "Thu, 01 Jan 1970 00:00:00 GMT",
      "minCapacity": 100
    }
  },
  "id": "/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/clusters/oiautorest6685",
  "identity": {
    "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  },
  "sku": {
    "name": "CapacityReservation",
    "capacity": 1000
  },
  "name": "TestResourceLock",
  "type": "Microsoft.OperationalInsights/clusters",
  "location": "eastus"
}

定義

名前	説明
AssociatedWorkspace	クラスターに関連付けられている Log Analytics ワークスペースの一覧。
BillingType	クラスターの課金の種類。
Capacity	このクラスターの容量予約レベル (ギガバイト単位)。
CapacityReservationProperties	容量予約のプロパティ。
Cluster	最上位レベルの Log Analytics クラスターリソースコンテナー。
ClusterEntityStatus	クラスターのプロビジョニング状態。
ClusterSku	クラスター SKU 定義。
ClusterSkuNameEnum	クラスターの SKU (レベル)。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
keyVaultProperties	キーコンテナーのプロパティ。
ManagedServiceIdentity	マネージドサービス ID (システム割り当て ID またはユーザー割り当て ID)
ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
UserAssignedIdentity	ユーザー割り当て ID プロパティ

AssociatedWorkspace

クラスターに関連付けられている Log Analytics ワークスペースの一覧。

名前	型	説明
associateDate	string	ワークスペースの関連付けの時刻。
resourceId	string	関連付けられたワークスペース arm リソース ID ('/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName} の形式。
workspaceId	string	関連付けられたワークスペースの不変 ID。
workspaceName	string	関連付けられたワークスペースリソース名。

BillingType

クラスターの課金の種類。

名前	型	説明
Cluster	string
Workspaces	string

Capacity

このクラスターの容量予約レベル (ギガバイト単位)。

名前	型	説明
100	Integer
1000	Integer
10000	Integer
200	Integer
2000	Integer
25000	Integer
300	Integer
400	Integer
500	Integer
5000	Integer
50000	Integer

CapacityReservationProperties

容量予約のプロパティ。

名前	型	説明
lastSkuUpdate	string	Sku が最後に更新された時刻。
minCapacity	integer	CapacityReservation の最小値 (ギガバイト単位)。

Cluster

最上位レベルの Log Analytics クラスターリソースコンテナー。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	リソースの ID。
location	string	リソースが保存されている地理的な場所
name	string	リソースの名前
properties.associatedWorkspaces	AssociatedWorkspace[]	クラスターに関連付けられている Log Analytics ワークスペースの一覧
properties.billingType	BillingType	クラスターの課金の種類。
properties.capacityReservationProperties	CapacityReservationProperties	容量予約の追加プロパティ
properties.clusterId	string	クラスターに関連付けられている ID。
properties.createdDate	string	クラスターの作成時刻
properties.isAvailabilityZonesEnabled	boolean	クラスターが可用性ゾーンをサポートするかどうかを設定します。これは、Azure Data ExplorerがAvailability Zonesをサポートしているリージョンでのみ true に設定できます。このプロパティは、クラスターの作成後に変更することはできません。リージョンでAvailability Zonesがサポートされている場合、既定値は 'true' です。
properties.isDoubleEncryptionEnabled	boolean	クラスターで二重暗号化を使用するかどうかを構成します。このプロパティは、クラスターの作成後に変更することはできません。既定値は 'true' です
properties.keyVaultProperties	keyVaultProperties	関連付けられたキープロパティ。
properties.lastModifiedDate	string	クラスターが最後に更新された時刻。
properties.provisioningState	ClusterEntityStatus	クラスターのプロビジョニング状態。
sku	ClusterSku	sku プロパティ。
tags	object	リソースタグ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ClusterEntityStatus

クラスターのプロビジョニング状態。

名前	型	説明
Canceled	string
Creating	string
Deleting	string
Failed	string
ProvisioningAccount	string
Succeeded	string
Updating	string

ClusterSku

クラスター SKU 定義。

名前	型	説明
capacity	Capacity	このクラスターの容量予約レベル (ギガバイト単位)。
name	ClusterSkuNameEnum	クラスターの SKU (レベル)。

ClusterSkuNameEnum

クラスターの SKU (レベル)。

名前	型	説明
CapacityReservation	string

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

keyVaultProperties

キーコンテナーのプロパティ。

名前	型	説明
keyName	string	Log Analytics クラスターに関連付けられているキーの名前。
keyRsaSize	integer	選択したキーの最小必要サイズ。
keyVaultUri	string	Log Analytics クラスターに関連付けられているキーを保持するKey Vault URI。
keyVersion	string	Log Analytics クラスターに関連付けられているキーのバージョン。

ManagedServiceIdentity

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

名前	型	説明
principalId	string	システム割り当て ID のサービスプリンシパル ID。このプロパティは、システム割り当て ID に対してのみ提供されます。
tenantId	string	システム割り当て 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	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

UserAssignedIdentity

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

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

Share via