Managed Clusters - List Cluster User Credentials

リファレンス

サービス:: AKS

API バージョン:: 2024-09-01

マネージドクラスターのユーザー資格情報を一覧表示します。

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前では大文字と小文字が区別されません。
resourceName	path	True	string	マネージドクラスターリソースの名前。正規表現パターン: `^[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	この操作に使用する API バージョン。
format	query		format	AAD クラスターにのみ適用され、返される kubeconfig の形式を指定します。形式 'azure' は azure auth-provider kubeconfig を返します。形式 'exec' は、パスに kubelogin バイナリを必要とする exec 形式 kubeconfig を返します。
server-fqdn	query		string	返される資格情報のサーバー fqdn の種類

応答

名前	型	説明
200 OK	CredentialResults	わかりました
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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=2024-09-01

応答のサンプル

状態コード:: 200

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

定義

名前	説明
CloudError	コンテナーサービスからのエラー応答。
CloudErrorBody	コンテナーサービスからのエラー応答。
CredentialResult	資格情報の結果の応答。
CredentialResults	資格情報の結果の応答を一覧表示します。
format	AAD クラスターにのみ適用され、返される kubeconfig の形式を指定します。形式 'azure' は azure auth-provider kubeconfig を返します。形式 'exec' は、パスに kubelogin バイナリを必要とする exec 形式 kubeconfig を返します。

CloudError

コンテナーサービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	エラーの詳細。

CloudErrorBody

コンテナーサービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

CredentialResult

資格情報の結果の応答。

名前	型	説明
name	string	資格情報の名前。
value	string	Base64 でエンコードされた Kubernetes 構成ファイル。

CredentialResults

資格情報の結果の応答を一覧表示します。

名前	型	説明
kubeconfigs	CredentialResult[]	Base64 でエンコードされた Kubernetes 構成ファイル。

format

AAD クラスターにのみ適用され、返される kubeconfig の形式を指定します。形式 'azure' は azure auth-provider kubeconfig を返します。形式 'exec' は、パスに kubelogin バイナリを必要とする exec 形式 kubeconfig を返します。

名前	型	説明
azure	string	azure auth-provider kubeconfig を返します。この形式は v1.22 では非推奨となり、v1.26 では完全に削除されます。 https://aka.ms/k8s/changes-1-26を参照してください。
exec	string	exec 形式の kubeconfig を返します。この形式では、パスに kubelogin バイナリが必要です。

次の方法で共有