Clusters - Get

參考

服務:: Log Analytics

API 版本:: 2023-09-01

取得 Log Analytics 叢集實例。

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

URI 參數

名稱	位於	必要	類型	Description
clusterName	path	True	string	Log Analytics 叢集的名稱。
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	Cluster	確定回應定義。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ClustersGet

範例要求

HTTP

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

範例回覆

狀態碼:: 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"
}

定義

名稱	Description
AssociatedWorkspace	與叢集相關聯的Log Analytics工作區清單。
BillingType	叢集的計費類型。
Capacity	此叢集的容量保留層級為 GB。
CapacityReservationProperties	容量保留屬性。
Cluster	最上層Log Analytics叢集資源容器。
ClusterEntityStatus	叢集的布建狀態。
ClusterSku	叢集 SKU 定義。
ClusterSkuNameEnum	叢集的 SKU (層) 。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
keyVaultProperties	金鑰保存庫屬性。
ManagedServiceIdentity	受控服務識別 (系統指派和/或使用者指派的身分識別)
ManagedServiceIdentityType	(允許 SystemAssigned 和 UserAssigned 類型的受控服務識別類型) 。
UserAssignedIdentity	使用者指派的身分識別屬性

AssociatedWorkspace

與叢集相關聯的Log Analytics工作區清單。

名稱	類型	Description
associateDate	string	工作區關聯的時間。
resourceId	string	相關聯的工作區 arm 資源標識符，格式為：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}。
workspaceId	string	相關聯的工作區不可變標識碼。
workspaceName	string	相關聯的工作區資源名稱。

BillingType

叢集的計費類型。

名稱	類型	Description
Cluster	string
Workspaces	string

Capacity

此叢集的容量保留層級為 GB。

名稱	類型	Description
100	Integer
1000	Integer
10000	Integer
200	Integer
2000	Integer
25000	Integer
300	Integer
400	Integer
500	Integer
5000	Integer
50000	Integer

CapacityReservationProperties

容量保留屬性。

名稱	類型	Description
lastSkuUpdate	string	上次更新 Sku 的時間。
minCapacity	integer	以 GB 為單位的最小 CapacityReservation 值。

Cluster

最上層Log Analytics叢集資源容器。

名稱	類型	Description
id	string	資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	資源的身分識別。
location	string	資源所在的地理位置
name	string	資源的名稱
properties.associatedWorkspaces	AssociatedWorkspace[]	與叢集相關聯的Log Analytics工作區清單
properties.billingType	BillingType	叢集的計費類型。
properties.capacityReservationProperties	CapacityReservationProperties	容量保留的其他屬性
properties.clusterId	string	與叢集相關聯的標識碼。
properties.createdDate	string	叢集建立時間
properties.isAvailabilityZonesEnabled	boolean	設定叢集是否支援可用性區域。這隻能在 Azure Data Explorer 支援可用性區域的區域設定為 true。建立叢集之後，就無法修改此屬性。如果區域支援可用性區域，預設值為 '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

叢集的布建狀態。

名稱	類型	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
ProvisioningAccount	string
Succeeded	string
Updating	string

ClusterSku

叢集 SKU 定義。

名稱	類型	Description
capacity	Capacity	此叢集的容量保留層級為 GB。
name	ClusterSkuNameEnum	叢集的 SKU (層) 。

ClusterSkuNameEnum

叢集的 SKU (層) 。

名稱	類型	Description
CapacityReservation	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

keyVaultProperties

金鑰保存庫屬性。

名稱	類型	Description
keyName	string	與 Log Analytics 叢集相關聯的金鑰名稱。
keyRsaSize	integer	選取的金鑰大小下限。
keyVaultUri	string	金鑰保存庫 uri，其會保存與 Log Analytics 叢集相關聯的密鑰。
keyVersion	string	與 Log Analytics 叢集相關聯的金鑰版本。

ManagedServiceIdentity

受控服務識別 (系統指派和/或使用者指派的身分識別)

名稱	類型	Description
principalId	string	系統指派身分識別的服務主體標識碼。此屬性只會針對系統指派的身分識別提供。
tenantId	string	系統指派身分識別的租用戶標識碼。此屬性只會針對系統指派的身分識別提供。
type	ManagedServiceIdentityType	(允許 SystemAssigned 和 UserAssigned 類型的受控服務識別類型) 。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 身分識別與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。字典值可以是要求中 () 的空白物件 {} 。

ManagedServiceIdentityType

(允許 SystemAssigned 和 UserAssigned 類型的受控服務識別類型) 。

名稱	類型	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

UserAssignedIdentity

使用者指派的身分識別屬性

名稱	類型	Description
clientId	string	指派之身分識別的用戶端標識碼。
principalId	string	指派之身分識別的主體標識碼。

共用方式為