Managed Clusters - List Cluster User Credentials

Referência

Serviço:: AKS

Versão da API:: 2024-05-01

Lista as credenciais de usuário de um cluster gerenciado.

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

Com parâmetros opcionais:

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 do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
resourceName	path	True	string	O nome do recurso de cluster gerenciado. Padrão Regex: `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string	A versão da API a ser usada para esta operação.
format	query		format	Aplicar somente a clusters AAD, especifica o formato de kubeconfig retornado. O formato 'azure' retornará azure auth-provider kubeconfig; O formato 'exec' retornará o formato exec kubeconfig, que requer o binário kubelogin no caminho.
server-fqdn	query		string	Tipo de FQDN do servidor para credenciais a serem retornadas

Respostas

Name	Tipo	Description
200 OK	CredentialResults	OK
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
CloudError	Uma resposta de erro do serviço de contêiner.
CloudErrorBody	Uma resposta de erro do serviço de contêiner.
CredentialResult	A resposta do resultado da credencial.
CredentialResults	A resposta do resultado da credencial da lista.
format	Aplicar somente a clusters AAD, especifica o formato de kubeconfig retornado. O formato 'azure' retornará azure auth-provider kubeconfig; O formato 'exec' retornará o formato exec kubeconfig, que requer o binário kubelogin no caminho.

CloudError

Uma resposta de erro do serviço de contêiner.

Name	Tipo	Description
error	CloudErrorBody	Detalhes sobre o erro.

CloudErrorBody

Uma resposta de erro do serviço de contêiner.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

CredentialResult

A resposta do resultado da credencial.

Name	Tipo	Description
name	string	O nome da credencial.
value	string	Arquivo de configuração do Kubernetes codificado em Base64.

CredentialResults

A resposta do resultado da credencial da lista.

Name	Tipo	Description
kubeconfigs	CredentialResult[]	Arquivo de configuração do Kubernetes codificado em Base64.

format

Aplicar somente a clusters AAD, especifica o formato de kubeconfig retornado. O formato 'azure' retornará azure auth-provider kubeconfig; O formato 'exec' retornará o formato exec kubeconfig, que requer o binário kubelogin no caminho.

Name	Tipo	Description
azure	string	Retornar azure auth-provider kubeconfig. Este formato foi preterido na v1.22 e será totalmente removido na v1.26. Ver: https://aka.ms/k8s/changes-1-26.
exec	string	Retornar formato exec kubeconfig. Este formato requer binário kubelogin no caminho.

Partilhar via