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	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string	Версия API, используемая для этой операции.
format	query		format	Применяется только к кластерам AAD, указывает формат возвращаемого kubeconfig. Формат Azure возвращает kubeconfig azure auth-provider; Формат exec возвращает kubeconfig формата exec, для которого требуется двоичный файл kubelogin в пути.
server-fqdn	query		string	Тип полного доменного имени сервера для возвращаемых учетных данных

Ответы

Имя	Тип	Описание
200 OK	CredentialResults	ХОРОШО
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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-09-01


/**
 * Samples for ManagedClusters ListClusterUserCredentials.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-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

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

package armcontainerservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerservice/armcontainerservice/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListClusterUserCredentials.json
func ExampleManagedClustersClient_ListClusterUserCredentials() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagedClustersClient().ListClusterUserCredentials(ctx, "rg1", "clustername1", &armcontainerservice.ManagedClustersClientListClusterUserCredentialsOptions{ServerFqdn: nil,
		Format: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CredentialResults = armcontainerservice.CredentialResults{
	// 	Kubeconfigs: []*armcontainerservice.CredentialResult{
	// 		{
	// 			Name: to.Ptr("credentialName1"),
	// 			Value: []byte("Y3JlZGVudGlhbFZhbHVlMQ=="),
	// 	}},
	// }
}

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

const { ContainerServiceClient } = require("@azure/arm-containerservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the user credentials of a managed cluster.
 *
 * @summary Lists the user credentials of a managed cluster.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListClusterUserCredentials.json
 */
async function getManagedCluster() {
  const subscriptionId =
    process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERSERVICE_RESOURCE_GROUP"] || "rg1";
  const resourceName = "clustername1";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.managedClusters.listClusterUserCredentials(
    resourceGroupName,
    resourceName,
  );
  console.log(result);
}

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

Пример ответа

Код состояния:: 200

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

Определения

Имя	Описание
CloudError	Ответ об ошибке службы контейнеров.
CloudErrorBody	Ответ об ошибке службы контейнеров.
CredentialResult	Ответ результата учетных данных.
CredentialResults	Ответ результата учетных данных списка.
format	Применяется только к кластерам AAD, указывает формат возвращаемого kubeconfig. Формат Azure возвращает kubeconfig azure auth-provider; Формат exec возвращает kubeconfig формата exec, для которого требуется двоичный файл kubelogin в пути.

CloudError

Ответ об ошибке службы контейнеров.

Имя	Тип	Описание
error	CloudErrorBody	Сведения об ошибке.

CloudErrorBody

Ответ об ошибке службы контейнеров.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

CredentialResult

Ответ результата учетных данных.

Имя	Тип	Описание
name	string	Имя учетных данных.
value	string	Файл конфигурации Kubernetes в кодировке Base64.

CredentialResults

Ответ результата учетных данных списка.

Имя	Тип	Описание
kubeconfigs	CredentialResult[]	Файл конфигурации Kubernetes в кодировке Base64.

format

Применяется только к кластерам AAD, указывает формат возвращаемого kubeconfig. Формат Azure возвращает kubeconfig azure auth-provider; Формат exec возвращает kubeconfig формата exec, для которого требуется двоичный файл kubelogin в пути.

Имя	Тип	Описание
azure	string	Возвращает azure auth-provider kubeconfig. Этот формат устарел в версии 1.22 и будет полностью удален в версии 1.26. См. https://aka.ms/k8s/changes-1-26.
exec	string	Возврат файла exec format kubeconfig. Для этого формата требуется двоичный файл kubelogin в пути.

Поделиться через

Managed Clusters - List Cluster User Credentials

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

Get Managed Cluster

Образец запроса

Пример ответа

Определения

CloudError

CloudErrorBody

CredentialResult

CredentialResults

format

Дополнительные ресурсы