Managed Clusters - List Cluster User Credentials

Service:

AKS

API Version:

2022-04-01

Mencantumkan kredensial pengguna dari kluster terkelola.

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

With optional parameters:

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

Parameter URI

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
resourceName	path	True	string	Nama sumber daya kluster terkelola. Regex pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.
format	query		format	Hanya berlaku untuk kluster AAD, menentukan format kubeconfig yang dikembalikan. Format 'azure' akan mengembalikan kubeconfig azure auth-provider; format 'exec' akan mengembalikan format exec kubeconfig, yang memerlukan biner kubelogin di jalur.
server-fqdn	query		string	jenis fqdn server untuk kredensial yang akan dikembalikan

Respons

Name	Type	Description
200 OK	CredentialResults	OK
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

Get Managed Cluster

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/listClusterUserCredential?api-version=2022-04-01

Java

import com.azure.core.util.Context;

/** Samples for ManagedClusters ListClusterMonitoringUserCredentials. */
public final class Main {
    /*
     * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-04-01/examples/ManagedClustersListClusterCredentialResult.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()
            .listClusterMonitoringUserCredentialsWithResponse("rg1", "clustername1", null, Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Go

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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-04-01/examples/ManagedClustersListClusterCredentialResult.json
func ExampleManagedClustersClient_ListClusterMonitoringUserCredentials() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcontainerservice.NewManagedClustersClient("subid1", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListClusterMonitoringUserCredentials(ctx,
		"rg1",
		"clustername1",
		&armcontainerservice.ManagedClustersClientListClusterMonitoringUserCredentialsOptions{ServerFqdn: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

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

/**
 * This sample demonstrates how to Lists the cluster monitoring user credentials of a managed cluster.
 *
 * @summary Lists the cluster monitoring user credentials of a managed cluster.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-04-01/examples/ManagedClustersListClusterCredentialResult.json
 */
async function getManagedCluster() {
  const subscriptionId = "subid1";
  const resourceGroupName = "rg1";
  const resourceName = "clustername1";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.managedClusters.listClusterMonitoringUserCredentials(
    resourceGroupName,
    resourceName
  );
  console.log(result);
}

getManagedCluster().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "kubeconfigs": [
    {
      "name": "credentialName1",
      "value": "credentialValue1"
    }
  ]
}

Definisi

CloudError	Respons kesalahan dari layanan Kontainer.
CloudErrorBody	Respons kesalahan dari layanan Kontainer.
CredentialResult	Respons hasil kredensial.
CredentialResults	Respons hasil kredensial daftar.
format	Hanya berlaku untuk kluster AAD, menentukan format kubeconfig yang dikembalikan. Format 'azure' akan mengembalikan kubeconfig azure auth-provider; format 'exec' akan mengembalikan format exec kubeconfig, yang memerlukan biner kubelogin di jalur.

CloudError

Respons kesalahan dari layanan Kontainer.

Name	Type	Description
error	CloudErrorBody	Detail tentang kesalahan.

CloudErrorBody

Respons kesalahan dari layanan Kontainer.

Name	Type	Description
code	string	Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan tersebut.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

CredentialResult

Respons hasil kredensial.

Name	Type	Description
name	string	Nama kredensial.
value	string	File konfigurasi Kubernetes yang dikodekan Base64.

CredentialResults

Respons hasil kredensial daftar.

Name	Type	Description
kubeconfigs	CredentialResult[]	File konfigurasi Kubernetes yang dikodekan Base64.

format

Hanya berlaku untuk kluster AAD, menentukan format kubeconfig yang dikembalikan. Format 'azure' akan mengembalikan kubeconfig azure auth-provider; format 'exec' akan mengembalikan format exec kubeconfig, yang memerlukan biner kubelogin di jalur.

Name	Type	Description
azure	string	Mengembalikan kubeconfig azure auth-provider. Format ini tidak digunakan lagi dalam 1.22 dan akan sepenuhnya dihapus dalam 1.25.
exec	string	Mengembalikan format exec kubeconfig. Format ini memerlukan biner kubelogin di jalur .