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

Connected Cluster - List By Resource Group

参考

服务:: Hybrid Kubernetes

API 版本:: 2024-01-01

Lists所有连接的群集
用于枚举资源组下已注册连接的 K8s 群集的 API

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters?api-version=2024-01-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	ConnectedClusterList	确定
Other Status Codes	ErrorResponse	描述操作失败原因的资源提供程序错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

GetClustersExample

示例请求

HTTP

GET https://management.azure.com/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourcegroups/k8sc-rg/providers/Microsoft.Kubernetes/connectedClusters?api-version=2024-01-01

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1",
      "name": "connectedCluster1",
      "type": "Microsoft.Kubernetes/connectedClusters",
      "location": "East US",
      "tags": {},
      "systemData": {
        "createdBy": "sikasire@microsoft.com",
        "createdByType": "User",
        "createdAt": "2020-12-17T07:06:33.9173186Z",
        "lastModifiedBy": "sikasire@microsoft.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-12-17T07:06:33.9173186Z"
      },
      "identity": {
        "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3",
        "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
        "type": "SystemAssigned"
      },
      "properties": {
        "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO",
        "kubernetesVersion": "1.17.0",
        "totalNodeCount": 2,
        "agentVersion": "0.1.0",
        "privateLinkState": "Disabled",
        "provisioningState": "Succeeded",
        "azureHybridBenefit": "NotApplicable",
        "distribution": "AKS",
        "distributionVersion": "1.0",
        "miscellaneousProperties": {
          "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8",
          "infrastructureVersion": "1.1"
        }
      }
    },
    {
      "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1",
      "name": "connectedCluster1",
      "type": "Microsoft.Kubernetes/connectedClusters",
      "location": "East US",
      "tags": {},
      "systemData": {
        "createdBy": "sikasire@microsoft.com",
        "createdByType": "User",
        "createdAt": "2020-12-17T07:06:33.9173186Z",
        "lastModifiedBy": "sikasire@microsoft.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-12-17T07:06:33.9173186Z"
      },
      "identity": {
        "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3",
        "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
        "type": "SystemAssigned"
      },
      "properties": {
        "agentPublicKeyCertificate": "XIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO",
        "kubernetesVersion": "1.1",
        "totalNodeCount": 2,
        "agentVersion": "0.1.0",
        "privateLinkState": "Enabled",
        "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName",
        "provisioningState": "Succeeded",
        "azureHybridBenefit": "NotApplicable",
        "distribution": "AKS",
        "distributionVersion": "1.0",
        "miscellaneousProperties": {
          "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8",
          "infrastructureVersion": "1.1"
        }
      }
    }
  ],
  "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters?api-version=2019-11-01-preview&$skiptoken=X'12345'"
}

定义

名称	说明
AadProfile	AAD 配置文件指定 Azure Active Directory 集成的属性。
ArcAgentProfile	定义群集的 Arc 代理属性。
AutoUpgradeOptions	指示上的 Arc 代理是否自动升级到最新版本。默认为“已启用”。
AzureHybridBenefit	指示是否选择加入Azure 混合权益
ConnectedCluster	表示连接的群集。
ConnectedClusterIdentity	连接的群集的标识。
ConnectedClusterKind	指示基于主机基础结构的 Arc 连接的群集的类型。
ConnectedClusterList	已连接群集的分页列表
ConnectivityStatus	表示已连接群集的连接状态。
createdByType	创建资源的标识类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
lastModifiedByType	上次修改资源的标识类型。
PrivateLinkState	描述已连接群集资源上的专用链接状态的属性。
ProvisioningState	已连接群集资源的预配状态。
ResourceIdentityType	用于连接的群集的标识类型。类型“SystemAssigned”包括系统创建的标识。类型“None”表示未向连接的群集分配任何标识。
SystemData	与资源的创建和上次修改相关的元数据。

AadProfile

AAD 配置文件指定 Azure Active Directory 集成的属性。

名称	类型	说明
adminGroupObjectIDs	string[]	将具有群集管理员角色的 AAD 组对象 ID 的列表。
enableAzureRBAC	boolean	是否为 Kubernetes 授权启用 Azure RBAC。
tenantID	string	用于身份验证的 AAD 租户 ID。如果未指定，将使用部署订阅的租户。

ArcAgentProfile

定义群集的 Arc 代理属性。

名称	类型	默认值	说明
agentAutoUpgrade	AutoUpgradeOptions	Enabled	指示上的 Arc 代理是否自动升级到最新版本。默认为“已启用”。
desiredAgentVersion	string		要安装在群集资源上的 Arc 代理的版本

AutoUpgradeOptions

指示上的 Arc 代理是否自动升级到最新版本。默认为“已启用”。

名称	类型	说明
Disabled	string
Enabled	string

AzureHybridBenefit

指示是否选择加入Azure 混合权益

名称	类型	说明
False	string
NotApplicable	string
True	string

ConnectedCluster

表示连接的群集。

名称	类型	默认值	说明
id	string		资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ConnectedClusterIdentity		已连接群集的标识。
kind	ConnectedClusterKind		连接的群集的类型。
location	string		资源所在的地理位置
name	string		资源的名称
properties.aadProfile	AadProfile		已连接群集的 AAD 配置文件。
properties.agentPublicKeyCertificate	string		代理用于对 Azure 中的后端服务进行初始握手的 Base64 编码公共证书。
properties.agentVersion	string		在连接的群集资源上运行的代理的版本
properties.arcAgentProfile	ArcAgentProfile		预配群集的 Arc 代理配置。
properties.azureHybridBenefit	AzureHybridBenefit	NotApplicable	指示是否选择加入Azure 混合权益
properties.connectivityStatus	ConnectivityStatus		表示已连接群集的连接状态。
properties.distribution	string		在此连接的群集上运行的 Kubernetes 分发版。
properties.distributionVersion	string		此连接的群集上的 Kubernetes 分发版本。
properties.infrastructure	string		此连接的群集所代表的 Kubernetes 群集在上运行的基础结构。
properties.kubernetesVersion	string		连接的群集资源的 Kubernetes 版本
properties.lastConnectivityTime	string		表示从群集收到心跳的最后一个实例的时间
properties.managedIdentityCertificateExpirationTime	string		托管标识证书的过期时间
properties.miscellaneousProperties	object		与连接的群集相关的更多属性
properties.offering	string		连接的群集产品/服务
properties.privateLinkScopeResourceId	string		此连接的群集分配到的专用链接范围的资源 ID（如果有）。
properties.privateLinkState	PrivateLinkState	Disabled	描述已连接群集资源上的专用链接状态的属性。
properties.provisioningState	ProvisioningState		已连接群集资源的预配状态。
properties.totalCoreCount	integer		连接的群集资源中存在的 CPU 核心数
properties.totalNodeCount	integer		连接的群集资源中存在的节点数
systemData	SystemData		与资源的创建和上次修改相关的元数据
tags	object		资源标记。
type	string		资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ConnectedClusterIdentity

连接的群集的标识。

名称	类型	默认值	说明
principalId	string		连接的群集标识的主体 ID。仅为系统分配的标识提供此属性。
tenantId	string		与连接的群集关联的租户 ID。仅为系统分配的标识提供此属性。
type	ResourceIdentityType	SystemAssigned	用于连接的群集的标识类型。类型“SystemAssigned”包括系统创建的标识。类型“None”表示未向连接的群集分配任何标识。

ConnectedClusterKind

指示基于主机基础结构的 Arc 连接的群集的类型。

名称	类型	说明
ProvisionedCluster	string

ConnectedClusterList

已连接群集的分页列表

名称	类型	说明
nextLink	string	用于提取已连接群集的下一页的链接
value	ConnectedCluster[]	已连接的群集列表

ConnectivityStatus

表示已连接群集的连接状态。

名称	类型	说明
Connected	string
Connecting	string
Expired	string
Offline	string

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

lastModifiedByType

上次修改资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

PrivateLinkState

描述已连接群集资源上的专用链接状态的属性。

名称	类型	说明
Disabled	string
Enabled	string

ProvisioningState

已连接群集资源的预配状态。

名称	类型	说明
Accepted	string
Canceled	string
Deleting	string
Failed	string
Provisioning	string
Succeeded	string
Updating	string

ResourceIdentityType

用于连接的群集的标识类型。类型“SystemAssigned”包括系统创建的标识。类型“None”表示未向连接的群集分配任何标识。

名称	类型	说明
None	string
SystemAssigned	string

SystemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源的创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源修改的时间戳 (UTC) 。
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	lastModifiedByType	上次修改资源的标识类型。

通过