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

Managed Clusters - List Cluster User Credentials

服务:: AKS

API 版本:: 2025-10-01

列出托管集群的用户凭据。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential?api-version=2025-10-01

具有可选参数:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential?api-version=2025-10-01&server-fqdn={server-fqdn}&format={format}

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
resourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$	托管集群资源的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
format	query		format	仅适用于 AAD 群集，指定返回的 kubeconfig 的格式。格式 'azure' 将返回 azure auth-provider kubeconfig;format 'exec' 将返回 exec 格式 kubeconfig，这需要路径中的 kubelogin 二进制文件。
server-fqdn	query		string	要返回的凭据的服务器 FQDN 类型

响应

名称	类型	说明
200 OK	CredentialResults	好的
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get Managed Cluster

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/listClusterUserCredential?api-version=2025-10-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python managed_clusters_list_cluster_user_credentials.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.managed_clusters.list_cluster_user_credentials(
        resource_group_name="rg1",
        resource_name="clustername1",
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-10-01/examples/ManagedClustersListClusterUserCredentials.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "kubeconfigs": [
    {
      "name": "credentialName1",
      "value": "Y3JlZGVudGlhbFZhbHVlMQ=="
    }
  ]
}

定义

名称	说明
CredentialResult	凭据结果响应。
CredentialResults	列表凭据结果响应。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
format	仅适用于 AAD 群集，指定返回的 kubeconfig 的格式。格式 'azure' 将返回 azure auth-provider kubeconfig;format 'exec' 将返回 exec 格式 kubeconfig，这需要路径中的 kubelogin 二进制文件。

CredentialResult

对象

凭据结果响应。

名称	类型	说明
name	string	凭据的名称。
value	string (byte)	Base64 编码的 Kubernetes 配置文件。

CredentialResults

对象

列表凭据结果响应。

名称	类型	说明
kubeconfigs	CredentialResult[]	Base64 编码的 Kubernetes 配置文件。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

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

ErrorResponse

对象

错误响应

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

format

枚举

仅适用于 AAD 群集，指定返回的 kubeconfig 的格式。格式 'azure' 将返回 azure auth-provider kubeconfig;format 'exec' 将返回 exec 格式 kubeconfig，这需要路径中的 kubelogin 二进制文件。

值	说明
exec	返回 exec 格式 kubeconfig。此格式需要路径中的 kubelogin 二进制文件。
azure	返回 azure auth-provider kubeconfig。此格式在 v1.22 中已弃用，将在 v1.26 中完全删除。请参阅：https://aka.ms/k8s/changes-1-26。

通过