Managed Clusters - Get Access Profile

Service:

AKS

API Version:

2024-02-01

マネージド クラスターのアクセス プロファイルを取得します。
警告: この API は非推奨になります。 代わりに 、ListClusterUserCredentials または ListClusterAdminCredentials を使用します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソース グループの名前。 名前の大文字と小文字は区別されます。
resourceName	path	True	string	マネージド クラスター リソースの名前。 Regex pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
roleName	path	True	string	マネージド クラスター accessProfile リソースのロールの名前。
subscriptionId	path	True	string uuid	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	ManagedClusterAccessProfile	OK
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Get Managed Cluster

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser/listCredential?api-version=2024-02-01

Java

/**
 * Samples for ManagedClusters GetAccessProfile.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/
     * ManagedClustersGetAccessProfile.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().getAccessProfileWithResponse("rg1",
            "clustername1", "clusterUser", 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

Python

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_get_access_profile.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.get_access_profile(
        resource_group_name="rg1",
        resource_name="clustername1",
        role_name="clusterUser",
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/ManagedClustersGetAccessProfile.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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/ManagedClustersGetAccessProfile.json
func ExampleManagedClustersClient_GetAccessProfile() {
	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().GetAccessProfile(ctx, "rg1", "clustername1", "clusterUser", 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.ManagedClusterAccessProfile = armcontainerservice.ManagedClusterAccessProfile{
	// 	Name: to.Ptr("clusterUser"),
	// 	Type: to.Ptr("Microsoft.ContainerService/ManagedClusters/AccessProfiles"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser"),
	// 	Location: to.Ptr("location1"),
	// 	Properties: &armcontainerservice.AccessProfile{
	// 		KubeConfig: []byte("a3ViZUNvbmZpZzE="),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to **WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .
 *
 * @summary **WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/ManagedClustersGetAccessProfile.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 roleName = "clusterUser";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.managedClusters.getAccessProfile(
    resourceGroupName,
    resourceName,
    roleName,
  );
  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

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser",
  "location": "location1",
  "name": "clusterUser",
  "properties": {
    "kubeConfig": "a3ViZUNvbmZpZzE="
  },
  "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles"
}

定義

名前	説明
CloudError	コンテナー サービスからのエラー応答。
CloudErrorBody	コンテナー サービスからのエラー応答。
createdByType	リソースを作成した ID の種類。
ManagedClusterAccessProfile	マネージド クラスター アクセス プロファイル。
systemData	リソースの作成と最後の変更に関連するメタデータ。

CloudError

コンテナー サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	エラーの詳細。

CloudErrorBody

コンテナー サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。
details	CloudErrorBody[]	エラーに関するその他の詳細の一覧。
message	string	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedClusterAccessProfile

マネージド クラスター アクセス プロファイル。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	リソースが保存されている地理的な場所
name	string	リソースの名前
properties.kubeConfig	string	Base64 でエンコードされた Kubernetes 構成ファイル。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソース タグ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。