Gets the upgrade profile of a provisioned cluster
GET https://management.azure.com/{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/upgradeProfiles/default?api-version=2024-01-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
connectedClusterResourceUri
|
path |
True
|
string
|
The fully qualified Azure Resource Manager identifier of the connected cluster resource.
|
|
api-version
|
query |
True
|
string
|
The API version to use for this operation.
|
Responses
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
GetUpgradeProfileForProvisionedClusterInstance
Sample request
GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/upgradeProfiles/default?api-version=2024-01-01
/**
* Samples for ProvisionedClusterInstances GetUpgradeProfile.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/
* ProvisionedClusterInstanceGetUpgradeProfile.json
*/
/**
* Sample code: GetUpgradeProfileForProvisionedClusterInstance.
*
* @param manager Entry point to HybridContainerServiceManager.
*/
public static void getUpgradeProfileForProvisionedClusterInstance(
com.azure.resourcemanager.hybridcontainerservice.HybridContainerServiceManager manager) {
manager.provisionedClusterInstances().getUpgradeProfileWithResponse(
"subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster",
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 provisioned_cluster_instance_get_upgrade_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 = HybridContainerServiceMgmtClient(
credential=DefaultAzureCredential(),
subscription_id="SUBSCRIPTION_ID",
)
response = client.provisioned_cluster_instances.get_upgrade_profile(
connected_cluster_resource_uri="subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster",
)
print(response)
# x-ms-original-file: specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/ProvisionedClusterInstanceGetUpgradeProfile.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/ProvisionedClusterInstanceGetUpgradeProfile.json
func ExampleProvisionedClusterInstancesClient_GetUpgradeProfile() {
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.NewProvisionedClusterInstancesClient().GetUpgradeProfile(ctx, "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster", 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.ProvisionedClusterUpgradeProfile = armhybridcontainerservice.ProvisionedClusterUpgradeProfile{
// Name: to.Ptr("default"),
// Type: to.Ptr("Microsoft.HybridContainerService/provisionedClusterInstances/upgradeprofiles"),
// ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/upgradeprofiles/default"),
// Properties: &armhybridcontainerservice.ProvisionedClusterUpgradeProfileProperties{
// ControlPlaneProfile: &armhybridcontainerservice.ProvisionedClusterPoolUpgradeProfile{
// KubernetesVersion: to.Ptr("1.7.7"),
// OSType: to.Ptr(armhybridcontainerservice.OsTypeLinux),
// Upgrades: []*armhybridcontainerservice.ProvisionedClusterPoolUpgradeProfileProperties{
// {
// IsPreview: to.Ptr(true),
// KubernetesVersion: to.Ptr("1.7.9"),
// },
// {
// KubernetesVersion: to.Ptr("1.7.11"),
// }},
// },
// },
// }
}
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 Gets the upgrade profile of a provisioned cluster
*
* @summary Gets the upgrade profile of a provisioned cluster
* x-ms-original-file: specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/ProvisionedClusterInstanceGetUpgradeProfile.json
*/
async function getUpgradeProfileForProvisionedClusterInstance() {
const connectedClusterResourceUri =
"subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster";
const credential = new DefaultAzureCredential();
const client = new HybridContainerServiceClient(credential);
const result = await client.provisionedClusterInstances.getUpgradeProfile(
connectedClusterResourceUri,
);
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 System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HybridContainerService;
// Generated from example definition: specification/hybridaks/resource-manager/Microsoft.HybridContainerService/stable/2024-01-01/examples/ProvisionedClusterInstanceGetUpgradeProfile.json
// this example is just showing the usage of "provisionedClusterInstances_GetUpgradeProfile" 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 ProvisionedClusterUpgradeProfileResource created on azure
// for more information of creating ProvisionedClusterUpgradeProfileResource, please refer to the document of ProvisionedClusterUpgradeProfileResource
string connectedClusterResourceUri = "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster";
ResourceIdentifier provisionedClusterUpgradeProfileResourceId = ProvisionedClusterUpgradeProfileResource.CreateResourceIdentifier(connectedClusterResourceUri);
ProvisionedClusterUpgradeProfileResource provisionedClusterUpgradeProfile = client.GetProvisionedClusterUpgradeProfileResource(provisionedClusterUpgradeProfileResourceId);
// invoke the operation
ProvisionedClusterUpgradeProfileResource result = await provisionedClusterUpgradeProfile.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
ProvisionedClusterUpgradeProfileData 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
{
"id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/upgradeprofiles/default",
"name": "default",
"properties": {
"controlPlaneProfile": {
"kubernetesVersion": "1.7.7",
"osType": "Linux",
"upgrades": [
{
"kubernetesVersion": "1.7.9",
"isPreview": true
},
{
"kubernetesVersion": "1.7.11"
}
]
}
},
"type": "Microsoft.HybridContainerService/provisionedClusterInstances/upgradeprofiles"
}
Definitions
createdByType
Enumeration
The type of identity that created the resource.
| Value |
Description |
|
Application
|
|
|
Key
|
|
|
ManagedIdentity
|
|
|
User
|
|
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.
|
osType
Enumeration
OSType to be used to specify OS type for the VMs. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'
| Value |
Description |
|
Linux
|
|
|
Windows
|
|
ProvisionedClusterPoolUpgradeProfile
Object
The list of available kubernetes versions for upgrade.
| Name |
Type |
Default value |
Description |
|
kubernetesVersion
|
string
|
|
The Kubernetes version (major.minor.patch).
|
|
osType
|
osType
|
Linux
|
OSType to be used to specify OS type for the VMs. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'
|
|
upgrades
|
ProvisionedClusterPoolUpgradeProfileProperties[]
|
|
List of available kubernetes versions for upgrade.
|
ProvisionedClusterPoolUpgradeProfileProperties
Object
The upgrade properties.
| Name |
Type |
Description |
|
isPreview
|
boolean
|
Whether the Kubernetes version is currently in preview.
|
|
kubernetesVersion
|
string
|
The Kubernetes version (major.minor.patch).
|
ProvisionedClusterUpgradeProfile
Object
The list of available kubernetes version upgrades for the provisioned cluster.
| Name |
Type |
Description |
|
id
|
string
|
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.controlPlaneProfile
|
ProvisionedClusterPoolUpgradeProfile
|
The list of available kubernetes version upgrades for the control plane.
|
|
properties.provisioningState
|
ResourceProvisioningState
|
Provisioning state of the resource
|
|
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"
|
ResourceProvisioningState
Enumeration
Provisioning state of the resource
| Value |
Description |
|
Accepted
|
|
|
Canceled
|
|
|
Creating
|
|
|
Deleting
|
|
|
Failed
|
|
|
Pending
|
|
|
Succeeded
|
|
|
Updating
|
|
|
Upgrading
|
|
systemData
Object
Metadata pertaining to creation and last modification of the resource.
| Name |
Type |
Description |
|
createdAt
|
string
|
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
|
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.
|