Managed Clusters - List Mesh Upgrade Profiles

Service:

AKS

API Version:

2024-02-01

特定のクラスター内のすべてのサービス メッシュで使用可能なアップグレードをListsします。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles?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]$
subscriptionId	path	True	string uuid	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	MeshUpgradeProfileList	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	ユーザー アカウントの借用

例

Lists version compatibility and upgrade profile for all service meshes in a cluster

Sample Request

HTTP

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

Java

/**
 * Samples for ManagedClusters ListMeshUpgradeProfiles.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/
     * ManagedClustersList_MeshUpgradeProfiles.json
     */
    /**
     * Sample code: Lists version compatibility and upgrade profile for all service meshes in a cluster.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listsVersionCompatibilityAndUpgradeProfileForAllServiceMeshesInACluster(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getManagedClusters().listMeshUpgradeProfiles("rg1",
            "clustername1", 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_list_mesh_upgrade_profiles.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_mesh_upgrade_profiles(
        resource_group_name="rg1",
        resource_name="clustername1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/ManagedClustersList_MeshUpgradeProfiles.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/ManagedClustersList_MeshUpgradeProfiles.json
func ExampleManagedClustersClient_NewListMeshUpgradeProfilesPager() {
	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)
	}
	pager := clientFactory.NewManagedClustersClient().NewListMeshUpgradeProfilesPager("rg1", "clustername1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.MeshUpgradeProfileList = armcontainerservice.MeshUpgradeProfileList{
		// 	Value: []*armcontainerservice.MeshUpgradeProfile{
		// 		{
		// 			Name: to.Ptr("istio"),
		// 			Type: to.Ptr("Microsoft.ContainerService/managedClusters/meshUpgradeProfiles"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio"),
		// 			Properties: &armcontainerservice.MeshUpgradeProfileProperties{
		// 				CompatibleWith: []*armcontainerservice.CompatibleVersions{
		// 					{
		// 						Name: to.Ptr("kubernetes"),
		// 						Versions: []*string{
		// 							to.Ptr("1.23"),
		// 							to.Ptr("1.24"),
		// 							to.Ptr("1.25"),
		// 							to.Ptr("1.26")},
		// 					}},
		// 					Revision: to.Ptr("asm-1-17"),
		// 					Upgrades: []*string{
		// 						to.Ptr("asm-1-18")},
		// 					},
		// 			}},
		// 		}
	}
}

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 Lists available upgrades for all service meshes in a specific cluster.
 *
 * @summary Lists available upgrades for all service meshes in a specific cluster.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/ManagedClustersList_MeshUpgradeProfiles.json
 */
async function listsVersionCompatibilityAndUpgradeProfileForAllServiceMeshesInACluster() {
  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 resArray = new Array();
  for await (let item of client.managedClusters.listMeshUpgradeProfiles(
    resourceGroupName,
    resourceName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio",
      "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles",
      "name": "istio",
      "properties": {
        "revision": "asm-1-17",
        "upgrades": [
          "asm-1-18"
        ],
        "compatibleWith": [
          {
            "name": "kubernetes",
            "versions": [
              "1.23",
              "1.24",
              "1.25",
              "1.26"
            ]
          }
        ]
      }
    }
  ]
}

定義

名前	説明
CloudError	Container サービスからのエラー応答。
CloudErrorBody	Container サービスからのエラー応答。
CompatibleVersions	サービス メッシュ リビジョンと互換性のある製品/サービスに関するバージョン情報。
createdByType	リソースを作成した ID の種類。
MeshUpgradeProfile	特定のメッシュのプロファイルをアップグレードします。
MeshUpgradeProfileList	MeshUpgradeProfiles の配列を保持します
MeshUpgradeProfileProperties	major.minor リリースのメッシュ アップグレード プロファイル プロパティ。
systemData	リソースの作成と最後の変更に関連するメタデータ。

CloudError

Container サービスからのエラー応答。

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

CloudErrorBody

Container サービスからのエラー応答。

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

CompatibleVersions

サービス メッシュ リビジョンと互換性のある製品/サービスに関するバージョン情報。

名前	型	説明
name	string	製品/サービス名。
versions	string[]	サービス メッシュ アドオン リビジョンと互換性のある製品/サービス バージョン。

createdByType

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

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

MeshUpgradeProfile

特定のメッシュのプロファイルをアップグレードします。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties	MeshUpgradeProfileProperties	major.minor リリースのメッシュ アップグレード プロファイル プロパティ。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

MeshUpgradeProfileList

MeshUpgradeProfiles の配列を保持します

名前	型	説明
nextLink	string	メッシュ アップグレード プロファイルの次のセットを取得する URL。
value	MeshUpgradeProfile[]	サポートされているサービス メッシュ アドオン アップグレード プロファイルの配列。

MeshUpgradeProfileProperties

major.minor リリースのメッシュ アップグレード プロファイル プロパティ。

名前	型	説明
compatibleWith	CompatibleVersions[]	サービス メッシュのこのリビジョンが互換性のあるアイテムとその関連バージョンの一覧。
revision	string	メッシュ リリースのリビジョン。
upgrades	string[]	特定のメッシュ リビジョンのアップグレードに使用できるリビジョンの一覧

systemData

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

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