Managed Clusters - List Cluster User Credentials

Service:

AKS

API Version:

2024-02-01

清單 受控叢集的用戶認證。

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

With optional parameters:

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。 名稱不區分大小寫。
resourceName	path	True	string	受控叢集資源的名稱。 Regex 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	用於此作業的 API 版本。
format	query		format	僅適用於 AAD 叢集，指定傳回 kubeconfig 的格式。 格式 'azure' 會傳回 azure auth-provider kubeconfig;format 'exec' 會傳回 exec format kubeconfig，這需要路徑中的 kubelogin 二進位檔。
server-fqdn	query		string	要傳回認證的伺服器 fqdn 類型

回應

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

範例

Get Managed Cluster

Sample Request

HTTP

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

Java

/**
 * Samples for ManagedClusters ListClusterUserCredentials.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/
     * ManagedClustersListClusterUserCredentials.json
     */
    /**
     * Sample code: Get Managed Cluster.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getManagedCluster(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getManagedClusters()
            .listClusterUserCredentialsWithResponse("rg1", "clustername1", null, null,
                com.azure.core.util.Context.NONE);
    }
}

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

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/2024-02-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

Sample Response

Status code:

200

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

定義

名稱	Description
CloudError	來自容器服務的錯誤回應。
CloudErrorBody	來自容器服務的錯誤回應。
CredentialResult	認證結果回應。
CredentialResults	清單認證結果回應。
format	僅適用於 AAD 叢集，指定傳回 kubeconfig 的格式。 格式 'azure' 會傳回 azure auth-provider kubeconfig;format 'exec' 會傳回 exec format kubeconfig，這需要路徑中的 kubelogin 二進位檔。

CloudError

來自容器服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	錯誤的詳細數據。

CloudErrorBody

來自容器服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程式碼不變，且要以程式設計方式使用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。 例如，錯誤中的屬性名稱。

CredentialResult

認證結果回應。

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

CredentialResults

清單認證結果回應。

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

format

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

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