Agent Pools - Get Upgrade Profile

Reference

Service:: AKS

API Version:: 2024-02-01

Získá profil upgradu pro fond agentů.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default?api-version=2024-02-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
agentPoolName	path	True	string	Název fondu agentů. Regex pattern: `^[a-z][a-z0-9]{0,11}$`
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
resourceName	path	True	string	Název prostředku spravovaného clusteru. 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 cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	AgentPoolUpgradeProfile	OK
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get Upgrade Profile for Agent Pool

Sample Request

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


/**
 * Samples for AgentPools GetUpgradeProfile.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/
     * AgentPoolsGetUpgradeProfile.json
     */
    /**
     * Sample code: Get Upgrade Profile for Agent Pool.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getUpgradeProfileForAgentPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getAgentPools().getUpgradeProfileWithResponse("rg1",
            "clustername1", "agentpool1", 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.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python agent_pools_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 = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.agent_pools.get_upgrade_profile(
        resource_group_name="rg1",
        resource_name="clustername1",
        agent_pool_name="agentpool1",
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/AgentPoolsGetUpgradeProfile.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 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/AgentPoolsGetUpgradeProfile.json
func ExampleAgentPoolsClient_GetUpgradeProfile() {
	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.NewAgentPoolsClient().GetUpgradeProfile(ctx, "rg1", "clustername1", "agentpool1", 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.AgentPoolUpgradeProfile = armcontainerservice.AgentPoolUpgradeProfile{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default"),
	// 	Properties: &armcontainerservice.AgentPoolUpgradeProfileProperties{
	// 		KubernetesVersion: to.Ptr("1.12.8"),
	// 		LatestNodeImageVersion: to.Ptr("AKSUbuntu:1604:2020.03.11"),
	// 		OSType: to.Ptr(armcontainerservice.OSTypeLinux),
	// 		Upgrades: []*armcontainerservice.AgentPoolUpgradeProfilePropertiesUpgradesItem{
	// 			{
	// 				KubernetesVersion: to.Ptr("1.13.5"),
	// 		}},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Gets the upgrade profile for an agent pool.
 *
 * @summary Gets the upgrade profile for an agent pool.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/AgentPoolsGetUpgradeProfile.json
 */
async function getUpgradeProfileForAgentPool() {
  const subscriptionId =
    process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERSERVICE_RESOURCE_GROUP"] || "rg1";
  const resourceName = "clustername1";
  const agentPoolName = "agentpool1";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.agentPools.getUpgradeProfile(
    resourceGroupName,
    resourceName,
    agentPoolName,
  );
  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/agentPools/agentpool1/upgradeprofiles/default",
  "name": "default",
  "properties": {
    "kubernetesVersion": "1.12.8",
    "osType": "Linux",
    "upgrades": [
      {
        "kubernetesVersion": "1.13.5"
      }
    ],
    "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11"
  },
  "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles"
}

Definice

Name	Description
AgentPoolUpgradeProfile	Seznam dostupných upgradů pro fond agentů
CloudError	Chybová odpověď ze služby Container Service.
CloudErrorBody	Chybová odpověď ze služby Container Service.
OSType	Typ operačního systému. Výchozí hodnota je Linux.
Upgrades	Seznam typů a verzí orchestrátoru, které jsou k dispozici pro upgrade

AgentPoolUpgradeProfile

Seznam dostupných upgradů pro fond agentů

Name	Typ	Výchozí hodnota	Description
id	string		ID profilu upgradu fondu agentů.
name	string		Název profilu upgradu fondu agentů.
properties.kubernetesVersion	string		Verze Kubernetes (major.minor.patch)
properties.latestNodeImageVersion	string		Nejnovější podporovaná verze image uzlu AKS
properties.osType	OSType	Linux	Typ operačního systému. Výchozí hodnota je Linux.
properties.upgrades	Upgrades[]		Seznam typů a verzí orchestrátoru, které jsou k dispozici pro upgrade
type	string		Typ profilu upgradu fondu agentů.

CloudError

Chybová odpověď ze služby Container Service.

Name	Typ	Description
error	CloudErrorBody	Podrobnosti o chybě

CloudErrorBody

Chybová odpověď ze služby Container Service.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

OSType

Typ operačního systému. Výchozí hodnota je Linux.

Name	Typ	Description
Linux	string	Použijte Linux.
Windows	string	Používejte Windows.

Upgrades

Seznam typů a verzí orchestrátoru, které jsou k dispozici pro upgrade

Name	Typ	Description
isPreview	boolean	Jestli je verze Kubernetes aktuálně ve verzi Preview.
kubernetesVersion	string	Verze Kubernetes (major.minor.patch)

Agent Pools - Get Upgrade Profile

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

Get Upgrade Profile for Agent Pool

Sample Request

Sample Response

Definice

AgentPoolUpgradeProfile

CloudError

CloudErrorBody

OSType

Upgrades

Další materiály