Agent Pools - List By Kubernetes Cluster

Служба:

Operator Nexus - Network Cloud

Версия API:

2024-07-01

Вывод списка пулов агентов кластера Kubernetes.
Получите список пулов агентов для предоставленного кластера Kubernetes.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools?api-version=2024-07-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
kubernetesClusterName	path	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$	Имя кластера Kubernetes.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	AgentPoolList	Список ресурсов успешно получен.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List agent pools of the Kubernetes cluster

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools?api-version=2024-07-01

Java

/**
 * Samples for AgentPools ListByKubernetesCluster.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/
     * AgentPools_ListByKubernetesCluster.json
     */
    /**
     * Sample code: List agent pools of the Kubernetes cluster.
     * 
     * @param manager Entry point to NetworkCloudManager.
     */
    public static void
        listAgentPoolsOfTheKubernetesCluster(com.azure.resourcemanager.networkcloud.NetworkCloudManager manager) {
        manager.agentPools().listByKubernetesCluster("resourceGroupName", "kubernetesClusterName",
            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.networkcloud import NetworkCloudMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-networkcloud
# USAGE
    python agent_pools_list_by_kubernetes_cluster.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 = NetworkCloudMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="123e4567-e89b-12d3-a456-426655440000",
    )

    response = client.agent_pools.list_by_kubernetes_cluster(
        resource_group_name="resourceGroupName",
        kubernetes_cluster_name="kubernetesClusterName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_ListByKubernetesCluster.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 armnetworkcloud_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/networkcloud/armnetworkcloud"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c0a12a75b702054cf1e7fcd8c014d0fc116dea6e/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_ListByKubernetesCluster.json
func ExampleAgentPoolsClient_NewListByKubernetesClusterPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetworkcloud.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAgentPoolsClient().NewListByKubernetesClusterPager("resourceGroupName", "kubernetesClusterName", 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.AgentPoolList = armnetworkcloud.AgentPoolList{
		// 	Value: []*armnetworkcloud.AgentPool{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.NetworkCloud/kubernetesClusters/agentPools"),
		// 			ID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName"),
		// 			SystemData: &armnetworkcloud.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:27:03.008Z"); return t}()),
		// 				CreatedBy: to.Ptr("identityA"),
		// 				CreatedByType: to.Ptr(armnetworkcloud.CreatedByTypeApplication),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:29:03.001Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("identityB"),
		// 				LastModifiedByType: to.Ptr(armnetworkcloud.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("location"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("myvalue1"),
		// 				"key2": to.Ptr("myvalue2"),
		// 			},
		// 			ExtendedLocation: &armnetworkcloud.ExtendedLocation{
		// 				Name: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"),
		// 				Type: to.Ptr("CustomLocation"),
		// 			},
		// 			Properties: &armnetworkcloud.AgentPoolProperties{
		// 				AdministratorConfiguration: &armnetworkcloud.AdministratorConfiguration{
		// 					AdminUsername: to.Ptr("azure"),
		// 					SSHPublicKeys: []*armnetworkcloud.SSHPublicKey{
		// 						{
		// 							KeyData: to.Ptr("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"),
		// 					}},
		// 				},
		// 				AgentOptions: &armnetworkcloud.AgentOptions{
		// 					HugepagesCount: to.Ptr[int64](96),
		// 					HugepagesSize: to.Ptr(armnetworkcloud.HugepagesSizeOneG),
		// 				},
		// 				AttachedNetworkConfiguration: &armnetworkcloud.AttachedNetworkConfiguration{
		// 					L2Networks: []*armnetworkcloud.L2NetworkAttachmentConfiguration{
		// 						{
		// 							NetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName"),
		// 							PluginType: to.Ptr(armnetworkcloud.KubernetesPluginTypeDPDK),
		// 					}},
		// 					L3Networks: []*armnetworkcloud.L3NetworkAttachmentConfiguration{
		// 						{
		// 							IpamEnabled: to.Ptr(armnetworkcloud.L3NetworkConfigurationIpamEnabledFalse),
		// 							NetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName"),
		// 							PluginType: to.Ptr(armnetworkcloud.KubernetesPluginTypeSRIOV),
		// 					}},
		// 					TrunkedNetworks: []*armnetworkcloud.TrunkedNetworkAttachmentConfiguration{
		// 						{
		// 							NetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName"),
		// 							PluginType: to.Ptr(armnetworkcloud.KubernetesPluginTypeMACVLAN),
		// 					}},
		// 				},
		// 				AvailabilityZones: []*string{
		// 					to.Ptr("1"),
		// 					to.Ptr("2"),
		// 					to.Ptr("3")},
		// 					Count: to.Ptr[int64](3),
		// 					DetailedStatus: to.Ptr(armnetworkcloud.AgentPoolDetailedStatusAvailable),
		// 					DetailedStatusMessage: to.Ptr("Agent pool is available"),
		// 					KubernetesVersion: to.Ptr("1.XX.Y"),
		// 					Labels: []*armnetworkcloud.KubernetesLabel{
		// 						{
		// 							Key: to.Ptr("kubernetes.label"),
		// 							Value: to.Ptr("true"),
		// 					}},
		// 					Mode: to.Ptr(armnetworkcloud.AgentPoolModeSystem),
		// 					ProvisioningState: to.Ptr(armnetworkcloud.AgentPoolProvisioningStateSucceeded),
		// 					Taints: []*armnetworkcloud.KubernetesLabel{
		// 						{
		// 							Key: to.Ptr("kubernetes.taint"),
		// 							Value: to.Ptr("true:NoSchedule"),
		// 					}},
		// 					UpgradeSettings: &armnetworkcloud.AgentPoolUpgradeSettings{
		// 						MaxSurge: to.Ptr("1"),
		// 					},
		// 					VMSKUName: to.Ptr("NC_P46_224_v1"),
		// 				},
		// 		}},
		// 	}
	}
}

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 { NetworkCloud } = require("@azure/arm-networkcloud");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get a list of agent pools for the provided Kubernetes cluster.
 *
 * @summary Get a list of agent pools for the provided Kubernetes cluster.
 * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_ListByKubernetesCluster.json
 */
async function listAgentPoolsOfTheKubernetesCluster() {
  const subscriptionId =
    process.env["NETWORKCLOUD_SUBSCRIPTION_ID"] || "123e4567-e89b-12d3-a456-426655440000";
  const resourceGroupName = process.env["NETWORKCLOUD_RESOURCE_GROUP"] || "resourceGroupName";
  const kubernetesClusterName = "kubernetesClusterName";
  const credential = new DefaultAzureCredential();
  const client = new NetworkCloud(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.agentPools.listByKubernetesCluster(
    resourceGroupName,
    kubernetesClusterName,
  )) {
    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

dotnet

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

// Generated from example definition: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_ListByKubernetesCluster.json
// this example is just showing the usage of "AgentPools_ListByKubernetesCluster" 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 NetworkCloudKubernetesClusterResource created on azure
// for more information of creating NetworkCloudKubernetesClusterResource, please refer to the document of NetworkCloudKubernetesClusterResource
string subscriptionId = "123e4567-e89b-12d3-a456-426655440000";
string resourceGroupName = "resourceGroupName";
string kubernetesClusterName = "kubernetesClusterName";
ResourceIdentifier networkCloudKubernetesClusterResourceId = NetworkCloudKubernetesClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, kubernetesClusterName);
NetworkCloudKubernetesClusterResource networkCloudKubernetesCluster = client.GetNetworkCloudKubernetesClusterResource(networkCloudKubernetesClusterResourceId);

// get the collection of this NetworkCloudAgentPoolResource
NetworkCloudAgentPoolCollection collection = networkCloudKubernetesCluster.GetNetworkCloudAgentPools();

// invoke the operation and iterate over the result
await foreach (NetworkCloudAgentPoolResource item in collection.GetAllAsync())
{
    // the variable item 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
    NetworkCloudAgentPoolData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Пример ответа

Код состояния:

200

{
  "value": [
    {
      "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName",
      "name": "default",
      "systemData": {
        "createdAt": "2021-01-22T13:27:03.008Z",
        "createdBy": "identityA",
        "createdByType": "Application",
        "lastModifiedAt": "2021-01-22T13:29:03.001Z",
        "lastModifiedBy": "identityB",
        "lastModifiedByType": "User"
      },
      "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools",
      "location": "location",
      "tags": {
        "key1": "myvalue1",
        "key2": "myvalue2"
      },
      "extendedLocation": {
        "type": "CustomLocation",
        "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
      },
      "properties": {
        "administratorConfiguration": {
          "adminUsername": "azure",
          "sshPublicKeys": [
            {
              "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
            }
          ]
        },
        "agentOptions": {
          "hugepagesCount": 96,
          "hugepagesSize": "1G"
        },
        "attachedNetworkConfiguration": {
          "l2Networks": [
            {
              "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName",
              "pluginType": "DPDK"
            }
          ],
          "l3Networks": [
            {
              "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
              "pluginType": "SRIOV",
              "ipamEnabled": "False"
            }
          ],
          "trunkedNetworks": [
            {
              "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName",
              "pluginType": "MACVLAN"
            }
          ]
        },
        "availabilityZones": [
          "1",
          "2",
          "3"
        ],
        "count": 3,
        "labels": [
          {
            "key": "kubernetes.label",
            "value": "true"
          }
        ],
        "mode": "System",
        "taints": [
          {
            "key": "kubernetes.taint",
            "value": "true:NoSchedule"
          }
        ],
        "upgradeSettings": {
          "maxSurge": "1"
        },
        "vmSkuName": "NC_P46_224_v1",
        "provisioningState": "Succeeded",
        "kubernetesVersion": "1.XX.Y",
        "detailedStatus": "Available",
        "detailedStatusMessage": "Agent pool is available"
      }
    }
  ],
  "nextLink": "https://fully.qualified.hyperlink"
}

Определения

Имя	Описание
AdministratorConfiguration	AdministratorConfiguration представляет административные учетные данные, которые будут применены к узлам уровня управления и пула агентов в кластерах Kubernetes.
AgentOptions	AgentOptions — это конфигурации, которые будут применяться к каждому агенту в пуле агентов.
AgentPool	AgentPool представляет пул агентов кластера Kubernetes.
AgentPoolDetailedStatus	Текущее состояние пула агентов.
AgentPoolList	AgentPoolList представляет список пулов агентов кластера Kubernetes.
AgentPoolMode	Выбор способа использования этого пула агентов в качестве системного пула или пула пользователей. Системные пулы выполняют функции и критически важные службы для кластера Kubernetes, а пулы пользователей предназначены для рабочих нагрузок пользователей. Каждый кластер Kubernetes должен содержать по крайней мере один системный пул узлов по крайней мере с одним узлом.
AgentPoolProvisioningState	Состояние подготовки пула агентов.
AgentPoolUpgradeSettings	AgentPoolUpgradeSettings указывает параметры обновления для пула агентов.
AttachedNetworkConfiguration	AttachNetworkConfiguration представляет набор сетей рабочей нагрузки для подключения к ресурсу.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ExtendedLocation	ExtendedLocation представляет пользовательское расположение Azure, в котором будет создан ресурс.
HugepagesSize	Размер огромных страниц для выделения.
KubernetesLabel	KubernetesLabel представляет одну запись для метки Kubernetes или ненамеренно, например используемых на узле или модуле pod.
KubernetesPluginType	Индикатор использования этой сети кластером Kubernetes.
L2NetworkAttachmentConfiguration	L2NetworkAttachmentConfiguration представляет конфигурацию вложения сети уровня 2.
L3NetworkAttachmentConfiguration	L3NetworkAttachmentConfiguration представляет конфигурацию вложения сети уровня 3.
L3NetworkConfigurationIpamEnabled	Указание того, будет ли эта сеть выполнять управление IP-адресами и выделять IP-адреса при подключении.
SshPublicKey	SshPublicKey представляет открытый ключ, используемый для проверки подлинности с помощью ресурса через SSH.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TrunkedNetworkAttachmentConfiguration	TrunkedNetworkAttachmentConfiguration представляет конфигурацию вложения магистральной сети.

AdministratorConfiguration

Object

AdministratorConfiguration представляет административные учетные данные, которые будут применены к узлам уровня управления и пула агентов в кластерах Kubernetes.

Имя	Тип	Описание
adminUsername	string	Имя пользователя администратора, которое будет применено к операционным системам, на которые выполняются узлы Kubernetes. Если он не указан, имя пользователя будет выбрано службой.
sshPublicKeys	SshPublicKey[]	Конфигурация SSH для операционных систем, запускающих узлы в кластере Kubernetes. В некоторых случаях для создания рабочей среды может потребоваться спецификация открытых ключей.

AgentOptions

Object

AgentOptions — это конфигурации, которые будут применяться к каждому агенту в пуле агентов.

Имя	Тип	Default value	Описание
hugepagesCount	integer (int64)		Количество огромных страниц для выделения.
hugepagesSize	HugepagesSize	2M	Размер огромных страниц для выделения.

AgentPool

Object

AgentPool представляет пул агентов кластера Kubernetes.

Имя	Тип	Описание
extendedLocation	ExtendedLocation	ExtendedLocation представляет пользовательское расположение Azure, в котором будет создан ресурс. Расширенное расположение кластера, связанного с ресурсом.
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.administratorConfiguration	AdministratorConfiguration	AdministratorConfiguration представляет административные учетные данные, которые будут применены к узлам уровня управления и пула агентов в кластерах Kubernetes. Учетные данные администратора, которые будут использоваться для узлов в этом пуле агентов.
properties.agentOptions	AgentOptions	AgentOptions — это конфигурации, которые будут применяться к каждому агенту в пуле агентов. Конфигурации, которые будут применяться к каждому агенту в этом пуле агентов.
properties.attachedNetworkConfiguration	AttachedNetworkConfiguration	AttachNetworkConfiguration представляет набор сетей рабочей нагрузки для подключения к ресурсу. Конфигурация сетей, подключенных к пулу агентов для использования рабочими нагрузками, которые выполняются в этом кластере Kubernetes.
properties.availabilityZones	string[]	Список зон доступности кластера Network Cloud, используемый для подготовки узлов в этом пуле агентов. Если не указано, будут использоваться все зоны доступности.
properties.count	integer (int64)	Количество виртуальных машин, использующих эту конфигурацию.
properties.detailedStatus	AgentPoolDetailedStatus	Текущее состояние пула агентов.
properties.detailedStatusMessage	string	Описательное сообщение о текущем подробном состоянии.
properties.kubernetesVersion	string	Версия Kubernetes, запущенная в этом пуле агентов.
properties.labels	KubernetesLabel[]	Метки, примененные к узлам в этом пуле агентов.
properties.mode	AgentPoolMode	Выбор способа использования этого пула агентов в качестве системного пула или пула пользователей. Системные пулы выполняют функции и критически важные службы для кластера Kubernetes, а пулы пользователей предназначены для рабочих нагрузок пользователей. Каждый кластер Kubernetes должен содержать по крайней мере один системный пул узлов по крайней мере с одним узлом.
properties.provisioningState	AgentPoolProvisioningState	Состояние подготовки пула агентов.
properties.taints	KubernetesLabel[]	Фрагменты, примененные к узлам в этом пуле агентов.
properties.upgradeSettings	AgentPoolUpgradeSettings	AgentPoolUpgradeSettings указывает параметры обновления для пула агентов. Конфигурация пула агентов.
properties.vmSkuName	string	Имя SKU виртуальной машины, определяющего размер ресурсов, выделенных для виртуальных машин узла.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

AgentPoolDetailedStatus

Перечисление

Текущее состояние пула агентов.

Значение	Описание
Available
Error
Provisioning

AgentPoolList

Object

AgentPoolList представляет список пулов агентов кластера Kubernetes.

Имя	Тип	Описание
nextLink	string	Ссылка, используемая для получения следующей страницы операций.
value	AgentPool[]	Список пулов агентов.

AgentPoolMode

Перечисление

Выбор способа использования этого пула агентов в качестве системного пула или пула пользователей. Системные пулы выполняют функции и критически важные службы для кластера Kubernetes, а пулы пользователей предназначены для рабочих нагрузок пользователей. Каждый кластер Kubernetes должен содержать по крайней мере один системный пул узлов по крайней мере с одним узлом.

Значение	Описание
NotApplicable
System
User

AgentPoolProvisioningState

Перечисление

Состояние подготовки пула агентов.

Значение	Описание
Accepted
Canceled
Deleting
Failed
InProgress
Succeeded
Updating

AgentPoolUpgradeSettings

Object

AgentPoolUpgradeSettings указывает параметры обновления для пула агентов.

Имя	Тип	Описание
drainTimeout	integer (int64) minimum: 60 maximum: 86400	Максимальное время в секундах, которое разрешено для завершения очистки узлов, прежде чем продолжить обновление пула агентов. Если не указано во время создания, используется значение 1800 секунд.
maxSurge	string	Максимальное число или процент узлов, которые резко возросли во время обновления. Для этого можно задать целое число (например, "5") или процент (например, "50%". Если указан процент, это процент общего размера пула агентов во время обновления. В процентах дробные узлы округляются вверх. Если не указано во время создания, используется значение 1. Один из MaxSurge и MaxUnavailable должен быть больше 0.
maxUnavailable	string	Максимальное число узлов или процент узлов, которые могут быть недоступны во время обновления. Для этого можно задать целое число (например, "5") или процент (например, "50%". Если указан процент, это процент общего размера пула агентов во время обновления. В процентах дробные узлы округляются вверх. Если значение не указано во время создания, используется значение 0. Один из MaxSurge и MaxUnavailable должен быть больше 0.

AttachedNetworkConfiguration

Object

AttachNetworkConfiguration представляет набор сетей рабочей нагрузки для подключения к ресурсу.

Имя	Тип	Описание
l2Networks	L2NetworkAttachmentConfiguration[]	Список сетей уровня 2 и связанная конфигурация для вложения.
l3Networks	L3NetworkAttachmentConfiguration[]	Список сетей уровня 3 и связанной конфигурации для вложения.
trunkedNetworks	TrunkedNetworkAttachmentConfiguration[]	Список магистральных сетей и связанной конфигурации для вложения.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ExtendedLocation

Object

ExtendedLocation представляет пользовательское расположение Azure, в котором будет создан ресурс.

Имя	Тип	Описание
name	string	Идентификатор ресурса расширенного расположения, в котором будет создан ресурс.
type	string	Тип расширенного расположения, например CustomLocation.

HugepagesSize

Перечисление

Размер огромных страниц для выделения.

Значение	Описание
1G
2M

KubernetesLabel

Object

KubernetesLabel представляет одну запись для метки Kubernetes или ненамеренно, например используемых на узле или модуле pod.

Имя	Тип	Описание
key	string	Имя метки или тэйнта.
value	string	Значение метки или тэйнта.

KubernetesPluginType

Перечисление

Индикатор использования этой сети кластером Kubernetes.

Значение	Описание
DPDK
IPVLAN
MACVLAN
OSDevice
SRIOV

L2NetworkAttachmentConfiguration

Object

L2NetworkAttachmentConfiguration представляет конфигурацию вложения сети уровня 2.

Имя	Тип	Default value	Описание
networkId	string (arm-id)		Идентификатор ресурса сети, настроенной для вложения.
pluginType	KubernetesPluginType	SRIOV	Индикатор использования этой сети кластером Kubernetes.

L3NetworkAttachmentConfiguration

Object

L3NetworkAttachmentConfiguration представляет конфигурацию вложения сети уровня 3.

Имя	Тип	Default value	Описание
ipamEnabled	L3NetworkConfigurationIpamEnabled	False	Указание того, будет ли эта сеть выполнять управление IP-адресами и выделять IP-адреса при подключении.
networkId	string (arm-id)		Идентификатор ресурса сети, настроенной для вложения.
pluginType	KubernetesPluginType	SRIOV	Индикатор использования этой сети кластером Kubernetes.

L3NetworkConfigurationIpamEnabled

Перечисление

Указание того, будет ли эта сеть выполнять управление IP-адресами и выделять IP-адреса при подключении.

Значение	Описание
False
True

SshPublicKey

Object

SshPublicKey представляет открытый ключ, используемый для проверки подлинности с помощью ресурса через SSH.

Имя	Тип	Описание
keyData	string minLength: 1	Данные открытого ключа SSH.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

TrunkedNetworkAttachmentConfiguration

Object

TrunkedNetworkAttachmentConfiguration представляет конфигурацию вложения магистральной сети.

Имя	Тип	Default value	Описание
networkId	string (arm-id)		Идентификатор ресурса сети, настроенной для вложения.
pluginType	KubernetesPluginType	SRIOV	Индикатор использования этой сети кластером Kubernetes.