Managed Clusters - List Cluster User Credentials

Referenz

Dienst:: AKS

API-Version:: 2024-09-01

Listet die Benutzeranmeldeinformationen eines verwalteten Clusters auf.

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

Mit optionalen Parametern:

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string	Der Name der verwalteten Clusterressource. RegEx-Muster: `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.
format	query		format	Gilt nur für AAD-Cluster, gibt das Format der zurückgegebenen Kubeconfig an. Das Format "azure" gibt azure auth-provider kubeconfig zurück; format 'exec' gibt das exec-Format kubeconfig zurück, das kubelogin binary im Pfad erfordert.
server-fqdn	query		string	Server-Fqdn-Typ für anmeldeinformationen, die zurückgegeben werden sollen

Antworten

Name	Typ	Beschreibung
200 OK	CredentialResults	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get Managed Cluster

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Containerdiensts.
CloudErrorBody	Eine Fehlerantwort des Containerdiensts.
CredentialResult	Die Ergebnisantwort für Anmeldeinformationen.
CredentialResults	Die Ergebnisantwort der Listenanmeldeinformationen.
format	Gilt nur für AAD-Cluster, gibt das Format der zurückgegebenen Kubeconfig an. Das Format "azure" gibt azure auth-provider kubeconfig zurück; format 'exec' gibt das exec-Format kubeconfig zurück, das kubelogin binary im Pfad erfordert.

CloudError

Eine Fehlerantwort des Containerdiensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Details zum Fehler.

CloudErrorBody

Eine Fehlerantwort des Containerdiensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

CredentialResult

Die Ergebnisantwort für Anmeldeinformationen.

Name	Typ	Beschreibung
name	string	Der Name der Anmeldeinformationen.
value	string	Base64-codierte Kubernetes-Konfigurationsdatei.

CredentialResults

Die Ergebnisantwort der Listenanmeldeinformationen.

Name	Typ	Beschreibung
kubeconfigs	CredentialResult[]	Base64-codierte Kubernetes-Konfigurationsdatei.

format

Gilt nur für AAD-Cluster, gibt das Format der zurückgegebenen Kubeconfig an. Das Format "azure" gibt azure auth-provider kubeconfig zurück; format 'exec' gibt das exec-Format kubeconfig zurück, das kubelogin binary im Pfad erfordert.

Name	Typ	Beschreibung
azure	string	Gibt azure auth-provider kubeconfig zurück. Dieses Format ist in v1.22 veraltet und wird in Version 1.26 vollständig entfernt. Siehe: https://aka.ms/k8s/changes-1-26.
exec	string	Gibt das exec-Format kubeconfig zurück. Für dieses Format ist eine Kubelogin-Binärdatei im Pfad erforderlich.

Freigeben über