Managed Clusters - Get Mesh Revision Profile

Service:

AKS

API Version:

2024-02-01

Obtient un profil de révision de maillage pour un maillage spécifié à l’emplacement spécifié.
Contient des métadonnées supplémentaires sur la révision, notamment les révisions prises en charge, la compatibilité du cluster et les mises à niveau disponibles

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles/{mode}?api-version=2024-02-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
location	path	True	string	Nom de la région Azure.
mode	path	True	string	Mode du maillage. 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 de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	MeshRevisionProfile	Ok
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Get a mesh revision profile for a mesh mode

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio?api-version=2024-02-01

Java

/**
 * Samples for ManagedClusters GetMeshRevisionProfile.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/
     * ManagedClustersGet_MeshRevisionProfile.json
     */
    /**
     * Sample code: Get a mesh revision profile for a mesh mode.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAMeshRevisionProfileForAMeshMode(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getManagedClusters()
            .getMeshRevisionProfileWithResponse("location1", "istio", 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_mesh_revision_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_mesh_revision_profile(
        location="location1",
        mode="istio",
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/ManagedClustersGet_MeshRevisionProfile.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/ManagedClustersGet_MeshRevisionProfile.json
func ExampleManagedClustersClient_GetMeshRevisionProfile() {
	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().GetMeshRevisionProfile(ctx, "location1", "istio", 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.MeshRevisionProfile = armcontainerservice.MeshRevisionProfile{
	// 	Name: to.Ptr("istio"),
	// 	Type: to.Ptr("Microsoft.ContainerService/locations/meshRevisionProfiles"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio"),
	// 	Properties: &armcontainerservice.MeshRevisionProfileProperties{
	// 		MeshRevisions: []*armcontainerservice.MeshRevision{
	// 			{
	// 				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")},
	// 					},
	// 					{
	// 						CompatibleWith: []*armcontainerservice.CompatibleVersions{
	// 							{
	// 								Name: to.Ptr("kubernetes"),
	// 								Versions: []*string{
	// 									to.Ptr("1.24"),
	// 									to.Ptr("1.25"),
	// 									to.Ptr("1.26"),
	// 									to.Ptr("1.27")},
	// 							}},
	// 							Revision: to.Ptr("asm-1-18"),
	// 							Upgrades: []*string{
	// 							},
	// 					}},
	// 				},
	// 			}
}

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 Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades
 *
 * @summary Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/ManagedClustersGet_MeshRevisionProfile.json
 */
async function getAMeshRevisionProfileForAMeshMode() {
  const subscriptionId =
    process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const location = "location1";
  const mode = "istio";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.managedClusters.getMeshRevisionProfile(location, mode);
  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/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio",
  "type": "Microsoft.ContainerService/locations/meshRevisionProfiles",
  "name": "istio",
  "properties": {
    "meshRevisions": [
      {
        "revision": "asm-1-17",
        "upgrades": [
          "asm-1-18"
        ],
        "compatibleWith": [
          {
            "name": "kubernetes",
            "versions": [
              "1.23",
              "1.24",
              "1.25",
              "1.26"
            ]
          }
        ]
      },
      {
        "revision": "asm-1-18",
        "upgrades": [],
        "compatibleWith": [
          {
            "name": "kubernetes",
            "versions": [
              "1.24",
              "1.25",
              "1.26",
              "1.27"
            ]
          }
        ]
      }
    ]
  }
}

Définitions

Nom	Description
CloudError	Réponse d’erreur du service conteneur.
CloudErrorBody	Réponse d’erreur du service conteneur.
CompatibleVersions	Informations de version sur un produit/service compatible avec une révision de maillage de service.
createdByType	Type d’identité qui a créé la ressource.
MeshRevision	Conserve des informations sur les mises à niveau et la compatibilité pour une version de maillage major.minor donnée.
MeshRevisionProfile	Profil de révision de maillage pour un maillage.
MeshRevisionProfileProperties	Propriétés du profil de révision de maillage pour un maillage
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CloudError

Réponse d’erreur du service conteneur.

Nom	Type	Description
error	CloudErrorBody	Détails sur l’erreur.

CloudErrorBody

Réponse d’erreur du service conteneur.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
details	CloudErrorBody[]	Liste de détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

CompatibleVersions

Informations de version sur un produit/service compatible avec une révision de maillage de service.

Nom	Type	Description
name	string	Nom du produit/service.
versions	string[]	Versions de produit/service compatibles avec une révision de complément de maillage de service.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

MeshRevision

Conserve des informations sur les mises à niveau et la compatibilité pour une version de maillage major.minor donnée.

Nom	Type	Description
compatibleWith	CompatibleVersions[]	Liste des éléments avec ́s que cette révision du maillage de service est compatible et de leurs versions associées.
revision	string	Révision de la version de maillage.
upgrades	string[]	Liste des révisions disponibles pour la mise à niveau d’une révision de maillage spécifique

MeshRevisionProfile

Profil de révision de maillage pour un maillage.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	nom de la ressource.
properties	MeshRevisionProfileProperties	Propriétés du profil de révision de maillage pour un maillage
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

MeshRevisionProfileProperties

Propriétés du profil de révision de maillage pour un maillage

Nom	Type	Description
meshRevisions	MeshRevision[]	Conserve des informations sur les mises à niveau et la compatibilité pour une version de maillage major.minor donnée.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.