Get Kubernetes Versions - Get Kubernetes Versions

Service:: Hybrid Container Service

API Version:: 2024-01-01

Lists the supported kubernetes versions for the specified custom location

GET https://management.azure.com/{customLocationResourceUri}/providers/Microsoft.HybridContainerService/kubernetesVersions/default?api-version=2024-01-01

URI Parameters

Name	In	Required	Type	Description
customLocationResourceUri	path	True	string	The fully qualified Azure Resource Manager identifier of the custom location resource.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	KubernetesVersionProfile	Lists the supported kubernetes versions for the specified custom location
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

GetKubernetesVersions

Sample request

GET https://management.azure.com/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation/providers/Microsoft.HybridContainerService/kubernetesVersions/default?api-version=2024-01-01


/**
 * Samples for ResourceProvider GetKubernetesVersions.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/
     * GetKubernetesVersions.json
     */
    /**
     * Sample code: GetKubernetesVersions.
     * 
     * @param manager Entry point to HybridContainerServiceManager.
     */
    public static void
        getKubernetesVersions(com.azure.resourcemanager.hybridcontainerservice.HybridContainerServiceManager manager) {
        manager.resourceProviders().getKubernetesVersionsWithResponse(
            "subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
            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.hybridcontainerservice import HybridContainerServiceMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-hybridcontainerservice
# USAGE
    python get_kubernetes_versions.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 = HybridContainerServiceMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.get_kubernetes_versions(
        custom_location_resource_uri="subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    )
    print(response)


# x-ms-original-file: specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/GetKubernetesVersions.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 armhybridcontainerservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hybridcontainerservice/armhybridcontainerservice"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/GetKubernetesVersions.json
func ExampleClient_GetKubernetesVersions() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armhybridcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewClient().GetKubernetesVersions(ctx, "subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", 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.KubernetesVersionProfile = armhybridcontainerservice.KubernetesVersionProfile{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("microsoft.hybridcontainerservice/kubernetesVersions"),
	// 	ID: to.Ptr("/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation/providers/Microsoft.HybridContainerService/kubernetesVersions/default"),
	// 	ExtendedLocation: &armhybridcontainerservice.ExtendedLocation{
	// 		Name: to.Ptr("/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourcegroups/test-arcappliance-resgrp/providers/microsoft.extendedlocation/customlocations/testcustomlocation"),
	// 		Type: to.Ptr(armhybridcontainerservice.ExtendedLocationTypesCustomLocation),
	// 	},
	// 	Properties: &armhybridcontainerservice.KubernetesVersionProfileProperties{
	// 		ProvisioningState: to.Ptr(armhybridcontainerservice.ResourceProvisioningStateSucceeded),
	// 		Values: []*armhybridcontainerservice.KubernetesVersionProperties{
	// 			{
	// 				IsPreview: to.Ptr(false),
	// 				PatchVersions: map[string]*armhybridcontainerservice.KubernetesPatchVersions{
	// 					"1.23.12": &armhybridcontainerservice.KubernetesPatchVersions{
	// 						Readiness: []*armhybridcontainerservice.KubernetesVersionReadiness{
	// 							{
	// 								OSSKU: to.Ptr(armhybridcontainerservice.OSSKUCBLMariner),
	// 								OSType: to.Ptr(armhybridcontainerservice.OsTypeLinux),
	// 								Ready: to.Ptr(true),
	// 							},
	// 							{
	// 								OSSKU: to.Ptr(armhybridcontainerservice.OSSKU("Windows")),
	// 								OSType: to.Ptr(armhybridcontainerservice.OsTypeWindows),
	// 								Ready: to.Ptr(true),
	// 							},
	// 							{
	// 								ErrorMessage: to.Ptr("Not Ready. Reasons: Failed to find proudct stream windoes2022 in release aks-hybrid-catalog-stable-int"),
	// 								OSSKU: to.Ptr(armhybridcontainerservice.OSSKUWindows2022),
	// 								OSType: to.Ptr(armhybridcontainerservice.OsTypeWindows),
	// 								Ready: to.Ptr(false),
	// 						}},
	// 						Upgrades: []*string{
	// 							to.Ptr("1.23.13")},
	// 						},
	// 						"1.23.13": &armhybridcontainerservice.KubernetesPatchVersions{
	// 							Readiness: []*armhybridcontainerservice.KubernetesVersionReadiness{
	// 								{
	// 									OSSKU: to.Ptr(armhybridcontainerservice.OSSKUCBLMariner),
	// 									OSType: to.Ptr(armhybridcontainerservice.OsTypeLinux),
	// 									Ready: to.Ptr(true),
	// 								},
	// 								{
	// 									OSSKU: to.Ptr(armhybridcontainerservice.OSSKUWindows2019),
	// 									OSType: to.Ptr(armhybridcontainerservice.OsTypeWindows),
	// 									Ready: to.Ptr(true),
	// 								},
	// 								{
	// 									OSSKU: to.Ptr(armhybridcontainerservice.OSSKUWindows2022),
	// 									OSType: to.Ptr(armhybridcontainerservice.OsTypeWindows),
	// 									Ready: to.Ptr(true),
	// 							}},
	// 							Upgrades: []*string{
	// 							},
	// 						},
	// 					},
	// 					Version: to.Ptr("1.23"),
	// 			}},
	// 		},
	// 	}
}

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

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

/**
 * This sample demonstrates how to Lists the supported kubernetes versions for the specified custom location
 *
 * @summary Lists the supported kubernetes versions for the specified custom location
 * x-ms-original-file: specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/GetKubernetesVersions.json
 */
async function getKubernetesVersions() {
  const customLocationResourceUri =
    "subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation";
  const credential = new DefaultAzureCredential();
  const client = new HybridContainerServiceClient(credential);
  const result = await client.getKubernetesVersions(customLocationResourceUri);
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.HybridContainerService.Models;
using Azure.ResourceManager.HybridContainerService;

// Generated from example definition: specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/GetKubernetesVersions.json
// this example is just showing the usage of "GetKubernetesVersions" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this KubernetesVersionProfileResource created on azure
// for more information of creating KubernetesVersionProfileResource, please refer to the document of KubernetesVersionProfileResource
string customLocationResourceUri = "subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation";
ResourceIdentifier kubernetesVersionProfileResourceId = KubernetesVersionProfileResource.CreateResourceIdentifier(customLocationResourceUri);
KubernetesVersionProfileResource kubernetesVersionProfile = client.GetKubernetesVersionProfileResource(kubernetesVersionProfileResourceId);

// invoke the operation
KubernetesVersionProfileResource result = await kubernetesVersionProfile.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
KubernetesVersionProfileData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation/providers/Microsoft.HybridContainerService/kubernetesVersions/default",
  "name": "default",
  "type": "microsoft.hybridcontainerservice/kubernetesVersions",
  "extendedLocation": {
    "name": "/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourcegroups/test-arcappliance-resgrp/providers/microsoft.extendedlocation/customlocations/testcustomlocation",
    "type": "CustomLocation"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "values": [
      {
        "version": "1.23",
        "isPreview": false,
        "patchVersions": {
          "1.23.12": {
            "readiness": [
              {
                "osType": "Linux",
                "osSku": "CBLMariner",
                "ready": true
              },
              {
                "osType": "Windows",
                "osSku": "Windows",
                "ready": true
              },
              {
                "osType": "Windows",
                "osSku": "Windows2022",
                "ready": false,
                "errorMessage": "Not Ready. Reasons: Failed to find proudct stream windoes2022 in release aks-hybrid-catalog-stable-int"
              }
            ],
            "upgrades": [
              "1.23.13"
            ]
          },
          "1.23.13": {
            "readiness": [
              {
                "osType": "Linux",
                "osSku": "CBLMariner",
                "ready": true
              },
              {
                "osType": "Windows",
                "osSku": "Windows2019",
                "ready": true
              },
              {
                "osType": "Windows",
                "osSku": "Windows2022",
                "ready": true
              }
            ],
            "upgrades": []
          }
        }
      }
    ]
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
CredentialResult	The credential result response.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedLocation	Extended location pointing to the underlying infrastructure
ExtendedLocationTypes	The extended location type. Allowed value: 'CustomLocation'
KubernetesVersionProfile	The supported kubernetes versions.
Properties
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CredentialResult

Object

The credential result response.

Name	Type	Description
name	string	The name of the credential.
value	string (byte)	Base64-encoded Kubernetes configuration file.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExtendedLocation

Object

Extended location pointing to the underlying infrastructure

Name	Type	Description
name	string	ARM Id of the extended location.
type	ExtendedLocationTypes	The extended location type. Allowed value: 'CustomLocation'

ExtendedLocationTypes

Enumeration

The extended location type. Allowed value: 'CustomLocation'

Value	Description
CustomLocation

KubernetesVersionProfile

Object

The supported kubernetes versions.

Name	Type	Description
extendedLocation	ExtendedLocation	Extended location pointing to the underlying infrastructure
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	Properties
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Properties

Object

Name	Type	Description
kubeconfigs	CredentialResult[]	Base64-encoded Kubernetes configuration file.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.