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

Clusters - List By Resource Group

服务:: Log Analytics

API 版本:: 2025-02-01

获取资源组中的 Log Analytics 群集。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此作的 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	模拟用户帐户

示例

ClustersGet

示例请求

HTTP

GET https://management.azure.com/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/clusters?api-version=2025-02-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	列表群集作响应。
ClusterReplicationProperties	群集复制属性。
ClusterReplicationState	群集复制的预配状态。
ClusterSku	群集 SKU 定义。
ClusterSkuNameEnum	群集的 SKU（层）。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
keyVaultProperties	密钥保管库属性。
ManagedServiceIdentity	托管服务标识（系统分配和/或用户分配的标识）
ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
UserAssignedIdentity	用户分配的标识属性

AssociatedWorkspace

Object

与群集关联的 Log Analytics 工作区列表。

名称	类型	说明
associateDate	string (date-time)	工作区关联的时间。
resourceId	string (arm-id)	关联的工作区 arm 资源 ID，格式为：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}。
workspaceId	string (uuid)	关联的工作区不可变 ID。
workspaceName	string	关联的工作区资源名称。

BillingType

枚举

群集的计费类型。

值	说明
Cluster
Workspaces

Capacity

枚举

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

值	说明
100
200
300
400
500
1000
2000
5000
10000
25000
50000

CapacityReservationProperties

Object

容量预留属性。

名称	类型	说明
lastSkuUpdate	string (date-time)	上次更新 SKU 的时间。
minCapacity	integer (int64)	最小 CapacityReservation 值（以 GB 为单位）。

Cluster

Object

顶级 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 (date-time)	群集创建时间
properties.isAvailabilityZonesEnabled	boolean	设置群集是否支持可用性区域。这只能在 Azure 数据资源管理器支持可用性区域的区域中设置为 true。创建群集后无法修改此属性。如果区域支持可用性区域，则默认值为“true”。
properties.isDoubleEncryptionEnabled	boolean	配置群集是否使用双重加密。创建群集后无法修改此属性。默认值为“true”
properties.keyVaultProperties	keyVaultProperties	关联的键属性。
properties.lastModifiedDate	string (date-time)	上次更新群集的时间。
properties.provisioningState	ClusterEntityStatus	群集的预配状态。
properties.replication	ClusterReplicationProperties	群集的复制属性。
sku	ClusterSku	SKU 属性。
tags	object	资源标记。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ClusterEntityStatus

枚举

群集的预配状态。

值	说明
Creating
Succeeded
Failed
Canceled
Deleting
ProvisioningAccount
Updating

ClusterListResult

Object

列表群集作响应。

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

ClusterReplicationProperties

Object

群集复制属性。

名称	类型	说明
createdDate	string (date-time)	群集的复制创建时间
enabled	boolean	指定是否启用复制。如果为 true，群集将复制到指定位置。
isAvailabilityZonesEnabled	boolean	应为给定复制的群集启用 AvailabilityZones
lastModifiedDate	string (date-time)	上次更新群集复制的时间。
location	string	复制的辅助位置。如果正在启用复制，则必须提供启用。
provisioningState	ClusterReplicationState	群集复制的预配状态。

ClusterReplicationState

枚举

群集复制的预配状态。

值	说明
Succeeded
EnableRequested
Enabling
DisableRequested
Disabling
RollbackRequested
RollingBack
Failed
Canceled

ClusterSku

Object

群集 SKU 定义。

名称	类型	说明
capacity	Capacity (int64)	此群集的容量预留级别（以 GB 为单位）。
name	ClusterSkuNameEnum	群集的 SKU（层）。

ClusterSkuNameEnum

枚举

群集的 SKU（层）。

值	说明
CapacityReservation

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

keyVaultProperties

Object

密钥保管库属性。

名称	类型	说明
keyName	string	与 Log Analytics 群集关联的密钥的名称。
keyRsaSize	integer (int32)	所选密钥所需的最小大小。
keyVaultUri	string	保存与 Log Analytics 群集关联的密钥的 Key Vault URI。
keyVersion	string	与 Log Analytics 群集关联的密钥的版本。

ManagedServiceIdentity

Object

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

名称	类型	说明
principalId	string (uuid)	系统分配标识的服务主体 ID。此属性仅针对系统分配的标识提供。
tenantId	string (uuid)	系统分配标识的租户 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
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

UserAssignedIdentity

Object

用户分配的标识属性

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

通过

Clusters - List By Resource Group

URI 参数

响应

安全性

azure_auth

作用域

示例

ClustersGet

示例请求

示例响应

定义

AssociatedWorkspace

BillingType

Capacity

CapacityReservationProperties

Cluster

ClusterEntityStatus

ClusterListResult

ClusterReplicationProperties

ClusterReplicationState

ClusterSku

ClusterSkuNameEnum

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

keyVaultProperties

ManagedServiceIdentity

ManagedServiceIdentityType

UserAssignedIdentity