你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Clusters - List

参考

服务:: Log Analytics

API 版本:: 2023-09-01

获取订阅中的 Log Analytics 群集。

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	ClusterListResult	正常响应定义。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ClustersSubscriptionList

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "value": [
    {
      "properties": {
        "keyVaultProperties": {
          "keyVaultUri": "https://aztest2170.vault.azure.net",
          "keyName": "aztest2170cert",
          "keyVersion": "654ft6c4e63845cbb50fd6fg51540429"
        },
        "provisioningState": "Succeeded",
        "clusterId": "5b02755b-5bf4-430c-9487-45502a2a7e62"
      },
      "sku": {
        "name": "CapacityReservation",
        "capacity": 1000
      },
      "id": "/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/clusters/mycluster",
      "identity": {
        "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b",
        "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
        "type": "SystemAssigned"
      },
      "name": "mycluster",
      "type": "Microsoft.OperationalInsights/clusters",
      "location": "eastus"
    }
  ]
}

定义

名称	说明
AssociatedWorkspace	与群集关联的 Log Analytics 工作区列表。
BillingType	群集的计费类型。
Capacity	此群集的容量预留级别（以 GB 为单位）。
CapacityReservationProperties	容量预留属性。
Cluster	顶级 Log Analytics 群集资源容器。
ClusterEntityStatus	群集的预配状态。
ClusterListResult	列表群集操作响应。
ClusterSku	群集 SKU 定义。
ClusterSkuNameEnum	群集的 SKU (层) 。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
keyVaultProperties	密钥保管库属性。
ManagedServiceIdentity	托管服务标识 (系统分配的标识和/或用户分配的标识)
ManagedServiceIdentityType	托管服务标识的类型 (其中允许 systemAssigned 和 UserAssigned 类型) 。
UserAssignedIdentity	用户分配的标识属性

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

此群集的容量预留级别（以 GB 为单位）。

名称	类型	说明
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 值（以 GB 为单位）。

Cluster

顶级 Log Analytics 群集资源容器。

名称	类型	说明
id	string	资源的完全限定的资源 ID。例如 - /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	与群集关联的 ID。
properties.createdDate	string	群集创建时间
properties.isAvailabilityZonesEnabled	boolean	设置群集是否支持可用性区域。仅在 Azure 数据资源管理器支持可用性区域的区域，才能将其设置为 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

群集的预配状态。

名称	类型	说明
Canceled	string
Creating	string
Deleting	string
Failed	string
ProvisioningAccount	string
Succeeded	string
Updating	string

ClusterListResult

列表群集操作响应。

名称	类型	说明
nextLink	string	用于获取下一页建议的链接。
value	Cluster[]	Log Analytics 群集的列表。

ClusterSku

群集 SKU 定义。

名称	类型	说明
capacity	Capacity	此群集的容量预留级别（以 GB 为单位）。
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	错误对象。

keyVaultProperties

密钥保管库属性。

名称	类型	说明
keyName	string	与 Log Analytics 群集关联的密钥的名称。
keyRsaSize	integer	所选的密钥最小所需大小。
keyVaultUri	string	密钥保管库 URI，用于保存它们与 Log Analytics 群集关联的密钥。
keyVersion	string	与 Log Analytics 群集关联的密钥的版本。

ManagedServiceIdentity

托管服务标识 (系统分配的标识和/或用户分配的标识)

名称	类型	说明
principalId	string	系统分配的标识的服务主体 ID。仅为系统分配的标识提供此属性。
tenantId	string	系统分配的标识的租户 ID。仅为系统分配的标识提供此属性。
type	ManagedServiceIdentityType	托管服务标识的类型 (其中允许 systemAssigned 和 UserAssigned 类型) 。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 标识与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将是采用以下格式的 ARM 资源 ID：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。字典值可以是请求中 ({}) 的空对象。

ManagedServiceIdentityType

托管服务标识的类型 (其中允许 systemAssigned 和 UserAssigned 类型) 。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

UserAssignedIdentity

用户分配的标识属性

名称	类型	说明
clientId	string	分配的标识的客户端 ID。
principalId	string	已分配标识的主体 ID。

通过