Managed Clusters - List Cluster User Credentials

服務:

AKS

API 版本:

2025-09-01

列出受管理叢集的使用者認證資料。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
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)	目標訂用帳戶的標識碼。 此值必須是 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 類型，用於傳回的認證

回應

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

安全性

azure_auth

Azure Active Directory OAuth2 流

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

範圍

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

範例

Get Managed Cluster

範例要求

HTTP

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

Python

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-09-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=="
    }
  ]
}

定義

名稱	Description
CredentialResult	認證結果回應。
CredentialResults	清單認證結果回應。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
format	僅適用於 AAD 叢集，指定傳回的 kubeconfig 格式。 格式 'azure' 會傳回 azure auth-provider kubeconfig;format 'exec' 將傳回 exec 格式 kubeconfig，這需要路徑中的 kubelogin 二進位檔。

CredentialResult

Object

認證結果回應。

名稱	類型	Description
name	string	認證的名稱。
value	string (byte)	Base64 編碼的 Kubernetes 組態檔。

CredentialResults

Object

清單認證結果回應。

名稱	類型	Description
kubeconfigs	CredentialResult[]	Base64 編碼的 Kubernetes 組態檔。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

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

ErrorDetail

Object

錯誤詳細數據。

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

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

format

列舉型別

僅適用於 AAD 叢集，指定傳回的 kubeconfig 格式。 格式 'azure' 會傳回 azure auth-provider kubeconfig;format 'exec' 將傳回 exec 格式 kubeconfig，這需要路徑中的 kubelogin 二進位檔。

值	Description
exec	傳回exec格式kubeconfig。 此格式需要路徑中的 kubelogin 二進位檔。
azure	傳回 azure auth-provider kubeconfig。 此格式在 v1.22 中已被取代，且會在 v1.26 中完全移除。 請參閱：https://aka.ms/k8s/changes-1-26。