Managed Clusters - List Cluster User Credentials

Referencia

Servicio:: AKS

Versión de la API:: 2024-05-01

Enumera las credenciales de usuario de un clúster administrado.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
resourceName	path	True	string	Nombre del recurso de clúster administrado. Patrón de Regex: `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.
format	query		format	Solo se aplica a los clústeres de AAD, especifica el formato de kubeconfig devuelto. El formato "azure" devolverá kubeconfig del proveedor de autenticación de Azure; format 'exec' devolverá el formato exec kubeconfig, que requiere kubelogin binario en la ruta de acceso.
server-fqdn	query		string	tipo fqdn de servidor para que se devuelvan las credenciales

Respuestas

Nombre	Tipo	Description
200 OK	CredentialResults	De acuerdo
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get Managed Cluster

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/listClusterUserCredential?api-version=2024-05-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/2024-05-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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio contenedor.
CloudErrorBody	Respuesta de error del servicio contenedor.
CredentialResult	Respuesta de resultado de credenciales.
CredentialResults	Respuesta de resultado de credenciales de lista.
format	Solo se aplica a los clústeres de AAD, especifica el formato de kubeconfig devuelto. El formato "azure" devolverá kubeconfig del proveedor de autenticación de Azure; format 'exec' devolverá el formato exec kubeconfig, que requiere kubelogin binario en la ruta de acceso.

CloudError

Respuesta de error del servicio contenedor.

Nombre	Tipo	Description
error	CloudErrorBody	Detalles sobre el error.

CloudErrorBody

Respuesta de error del servicio contenedor.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

CredentialResult

Respuesta de resultado de credenciales.

Nombre	Tipo	Description
name	string	Nombre de la credencial.
value	string	Archivo de configuración de Kubernetes codificado en Base64.

CredentialResults

Respuesta de resultado de credenciales de lista.

Nombre	Tipo	Description
kubeconfigs	CredentialResult[]	Archivo de configuración de Kubernetes codificado en Base64.

format

Solo se aplica a los clústeres de AAD, especifica el formato de kubeconfig devuelto. El formato "azure" devolverá kubeconfig del proveedor de autenticación de Azure; format 'exec' devolverá el formato exec kubeconfig, que requiere kubelogin binario en la ruta de acceso.

Nombre	Tipo	Description
azure	string	Devuelve kubeconfig del proveedor de autenticación de Azure. Este formato está en desuso en v1.22 y se quitará completamente en la versión 1.26. Consulte: https://aka.ms/k8s/changes-1-26.
exec	string	Devuelve el formato exec kubeconfig. Este formato requiere el binario kubelogin en la ruta de acceso.

Compartir a través de