Agent Pools - Get

Serviço:: AKS

Versão API:: 2025-10-01

Obtém o pool de agentes de cluster gerenciado especificado.

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

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
agentPoolName	path	True	string minLength: 1 maxLength: 12 pattern: ^[a-z][a-z0-9]{0,11}$	O nome do pool de agentes.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
resourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$	O nome do recurso de cluster gerenciado.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Nome	Tipo	Descrição
200 OK	AgentPool	OK
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/authorize

Alcances

Nome	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get Agent Pool

Pedido de exemplo

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


/**
 * Samples for AgentPools Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-10-01/examples/
     * AgentPoolsGet.json
     */
    /**
     * Sample code: Get Agent Pool.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAgentPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getAgentPools().getWithResponse("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.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(
        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/2025-10-01/examples/AgentPoolsGet.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/v8"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9cc7633f842575274f715cc02e37c5769ac2742d/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-10-01/examples/AgentPoolsGet.json
func ExampleAgentPoolsClient_Get() {
	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().Get(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.AgentPool = armcontainerservice.AgentPool{
	// 	Name: to.Ptr("agentpool1"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1"),
	// 	Properties: &armcontainerservice.ManagedClusterAgentPoolProfileProperties{
	// 		Count: to.Ptr[int32](3),
	// 		CurrentOrchestratorVersion: to.Ptr("1.9.6"),
	// 		ETag: to.Ptr("ebwiyfneowv"),
	// 		MaxPods: to.Ptr[int32](110),
	// 		NodeImageVersion: to.Ptr("AKSUbuntu:1604:2020.03.11"),
	// 		OrchestratorVersion: to.Ptr("1.9.6"),
	// 		OSType: to.Ptr(armcontainerservice.OSTypeLinux),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		UpgradeSettings: &armcontainerservice.AgentPoolUpgradeSettings{
	// 			MaxSurge: to.Ptr("33%"),
	// 		},
	// 		VMSize: to.Ptr("Standard_DS1_v2"),
	// 	},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the specified managed cluster agent pool.
 *
 * @summary Gets the specified managed cluster agent pool.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-10-01/examples/AgentPoolsGet.json
 */
async function getAgentPool() {
  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.get(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

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

// Generated from example definition: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-10-01/examples/AgentPoolsGet.json
// this example is just showing the usage of "AgentPools_Get" 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 ContainerServiceAgentPoolResource created on azure
// for more information of creating ContainerServiceAgentPoolResource, please refer to the document of ContainerServiceAgentPoolResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string resourceName = "clustername1";
string agentPoolName = "agentpool1";
ResourceIdentifier containerServiceAgentPoolResourceId = ContainerServiceAgentPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceName, agentPoolName);
ContainerServiceAgentPoolResource containerServiceAgentPool = client.GetContainerServiceAgentPoolResource(containerServiceAgentPoolResourceId);

// invoke the operation
ContainerServiceAgentPoolResource result = await containerServiceAgentPool.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
ContainerServiceAgentPoolData 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

Resposta de exemplo

Código de estado:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "eTag": "ebwiyfneowv",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
    "upgradeSettings": {
      "maxSurge": "33%"
    }
  }
}

Definições

Nome	Descrição
AgentPool	Pool de agentes.
AgentPoolGatewayProfile	Perfil do pool de agentes de gateway de cluster gerenciado.
AgentPoolMode	O modo de um pool de agentes. Um cluster deve ter pelo menos um Pool de Agentes do 'Sistema' o tempo todo. Para obter informações adicionais sobre restrições e práticas recomendadas do pool de agentes, consulte: https://docs.microsoft.com/azure/aks/use-system-pools
AgentPoolNetworkProfile	Configurações de rede de um pool de agentes.
AgentPoolSecurityProfile	As configurações de segurança de um pool de agentes.
AgentPoolSSHAccess	Método de acesso SSH de um pool de agentes.
AgentPoolStatus	Contém informações somente leitura sobre o Pool de Agentes.
AgentPoolType	O tipo de pool de agentes.
AgentPoolUpgradeSettings	Configurações para atualizar um agentpool
AgentPoolWindowsProfile	O perfil específico do pool de agentes do Windows.
code	Informa se o cluster está em execução ou interrompido
CreationData	Dados usados ao criar um recurso de destino a partir de um recurso de origem.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GPUDriver	Se deseja instalar drivers de GPU. Quando não é especificado, o padrão é Instalar.
GPUInstanceProfile	GPUInstanceProfile a ser usado para especificar o perfil de instância MIG da GPU para GPU VM SKU suportado.
GPUProfile	Configurações de GPU para o pool de agentes.
IPTag	Contém o IPTag associado ao objeto.
KubeletConfig	Configurações Kubelet de nós de agente. Consulte de configuração de nó personalizado do AKS para obter mais detalhes.
KubeletDiskType	Determina o posicionamento de volumes emptyDir, raiz de dados de tempo de execução do contêiner e armazenamento efêmero do Kubelet.
LinuxOSConfig	Configurações de SO de nós de agente Linux. Consulte de configuração de nó personalizado do AKS para obter mais detalhes.
LocalDNSForwardDestination	Servidor de destino para consultas DNS a serem encaminhadas do localDNS.
LocalDNSForwardPolicy	Política de encaminhamento para selecionar o servidor DNS upstream. Consulte forward plugin para obter mais informações.
LocalDNSMode	Modo de ativação para localDNS.
LocalDNSOverride	Substitui o perfil localDNS.
LocalDNSProfile	Configura o DNS local por nó, com substituições de VnetDNS e KubeDNS. LocalDNS ajuda a melhorar o desempenho e a confiabilidade da resolução DNS em um cluster AKS. Para mais detalhes, ver aka.ms/aks/localdns.
LocalDNSProtocol	Imponha TCP ou prefira o protocolo UDP para conexões de localDNS para servidor DNS upstream.
LocalDNSQueryLogging	Nível de log para consultas DNS no localDNS.
LocalDNSServeStale	Política para servir dados obsoletos. Consulte o plug-in de cache para obter mais informações.
LocalDNSState	Estado gerado pelo sistema de localDNS.
ManualScaleProfile	Especificações sobre o número de máquinas.
OSDiskType	O tipo de disco do sistema operacional a ser usado para máquinas no pool de agentes. O padrão é 'Ephemeral' se a VM suportar e tiver um disco de cache maior do que o OSDiskSizeGB solicitado. Caso contrário, o padrão será 'Gerenciado'. Não pode ser alterado após a criação. Para obter mais informações, consulte Ephemeral OS.
OSSKU	Especifica a SKU do sistema operacional usada pelo pool de agentes. O padrão é Ubuntu se OSType é Linux. O padrão é Windows2019 quando o Kubernetes <= 1.24 ou Windows2022 quando o Kubernetes >= 1.25 se OSType for Windows.
OSType	O tipo de sistema operacional. O padrão é Linux.
PodIPAllocationMode	Modo de alocação de IP do pod. O modo de alocação de IP para pods no pool de agentes. Deve ser usado com podSubnetId. O padrão é 'DynamicIndividual'.
PortRange	O intervalo de portas.
PowerState	Descreve o estado de energia do cluster
Protocol	O protocolo de rede da porta.
ScaleDownMode	Descreve como as VMs são adicionadas ou removidas dos Pools de Agentes. Consulte os estados de faturação.
ScaleProfile	Especificações sobre como dimensionar um pool de agentes VirtualMachines.
ScaleSetEvictionPolicy	A política de remoção do Conjunto de Dimensionamento de Máquina Virtual. A política de remoção especifica o que fazer com a VM quando ela é removida. O padrão é Excluir. Para obter mais informações sobre remoção, consulte VMs spot
ScaleSetPriority	A prioridade do Conjunto de Dimensionamento de Máquina Virtual.
SysctlConfig	Configurações de sysctl para nós de agente Linux.
UndrainableNodeBehavior	Define o comportamento para nós não drenáveis durante a atualização. A causa mais comum de nós não drenáveis é Pod Disruption Budgets (PDBs), mas outros problemas, como o período de carência de término do pod está excedendo o tempo limite de drenagem por nó restante ou o pod ainda está em um estado de execução, também podem causar nós não drenáveis.
VirtualMachineNodes	Status atual em um grupo de nós do mesmo tamanho vm.
VirtualMachinesProfile	Especificações no pool de agentes do VirtualMachines.
WorkloadRuntime	Determina o tipo de carga de trabalho que um nó pode executar.

AgentPool

Objetivo

Pool de agentes.

Nome	Tipo	Valor padrão	Descrição
id	string		ID do recurso.
name	string		O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.availabilityZones	string[]		A lista de zonas de disponibilidade a serem usadas para nós. Isso só pode ser especificado se a propriedade AgentPoolType for 'VirtualMachineScaleSets'.
properties.capacityReservationGroupID	string (arm-id)		O AKS associará o pool de agentes especificado ao Grupo de Reserva de Capacidade.
properties.count	integer (int32)		Número de agentes (VMs) para hospedar contêineres do docker. Os valores permitidos devem estar no intervalo de 0 a 1000 (inclusive) para grupos de usuários e no intervalo de 1 a 1000 (inclusive) para pools de sistema. O valor padrão é 1.
properties.creationData	CreationData		CreationData a ser usado para especificar o ID do instantâneo de origem se o pool de nós for criado/atualizado usando um instantâneo.
properties.currentOrchestratorVersion	string		A versão do Kubernetes que o pool de agentes está executando. Se orchestratorVersion for uma versão totalmente especificada <>major.minor.patch, este campo será exatamente igual a ele. Se orchestratorVersion for <>major.minor , este campo conterá a versão completa <major.minor.patch> que está sendo usada.
properties.eTag	string		Cadeia de caracteres somente leitura exclusiva usada para implementar simultaneidade otimista. O valor eTag será alterado quando o recurso for atualizado. Especifique um cabeçalho if-match ou if-none-match com o valor eTag para uma solicitação subsequente para habilitar a simultaneidade otimista de acordo com a convenção eTag normal.
properties.enableAutoScaling	boolean		Se o dimensionador automático deve ser ativado
properties.enableEncryptionAtHost	boolean		Se é necessário habilitar o sistema operacional baseado em host e a criptografia de unidade de dados. Isso só é suportado em determinados tamanhos de VM e em determinadas regiões do Azure. Para mais informações, consulte: https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS	boolean		Se deve usar um sistema operacional habilitado para FIPS. Consulte Adicionar um pool de nós habilitado para FIPS para obter mais detalhes.
properties.enableNodePublicIP	boolean		Se cada nó recebe seu próprio IP público. Alguns cenários podem exigir que os nós em um pool de nós recebam seus próprios endereços IP públicos dedicados. Um cenário comum é para cargas de trabalho de jogos, onde um console precisa fazer uma conexão direta com uma máquina virtual em nuvem para minimizar saltos. Para obter mais informações, consulte atribuição de um IP público por nó. O padrão é "false".
properties.enableUltraSSD	boolean		Se o UltraSSD deve ser ativado
properties.gatewayProfile	AgentPoolGatewayProfile		Perfil específico para um pool de agentes gerenciados no modo Gateway. Este campo não pode ser definido se o modo de pool de agentes não for Gateway.
properties.gpuInstanceProfile	GPUInstanceProfile		GPUInstanceProfile a ser usado para especificar o perfil de instância MIG da GPU para GPU VM SKU suportado.
properties.gpuProfile	GPUProfile		Configurações de GPU para o pool de agentes.
properties.hostGroupID	string (arm-id)		O ID de recurso totalmente qualificado do Grupo de Hosts Dedicado para provisionar máquinas virtuais, usado somente no cenário de criação e não pode ser alterado uma vez definido. Este é o formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Para obter mais informações, consulte hosts dedicados do Azure.
properties.kubeletConfig	KubeletConfig		A configuração do Kubelet nos nós do pool de agentes.
properties.kubeletDiskType	KubeletDiskType		Determina o posicionamento de volumes emptyDir, raiz de dados de tempo de execução do contêiner e armazenamento efêmero do Kubelet.
properties.linuxOSConfig	LinuxOSConfig		A configuração do sistema operacional dos nós do agente Linux.
properties.localDNSProfile	LocalDNSProfile		Configura o DNS local por nó, com substituições de VnetDNS e KubeDNS. LocalDNS ajuda a melhorar o desempenho e a confiabilidade da resolução DNS em um cluster AKS. Para mais detalhes, ver aka.ms/aks/localdns.
properties.maxCount	integer (int32)		O número máximo de nós para dimensionamento automático
properties.maxPods	integer (int32)		O número máximo de pods que podem ser executados em um nó.
properties.messageOfTheDay	string		Mensagem do dia para nós Linux, codificada em base64. Uma string codificada em base64 que será gravada em /etc/motd após a decodificação. Isso permite a personalização da mensagem do dia para nós Linux. Ele não deve ser especificado para nós do Windows. Deve ser uma string estática (ou seja, será impressa crua e não será executada como um script).
properties.minCount	integer (int32)		O número mínimo de nós para dimensionamento automático
properties.mode	AgentPoolMode		O modo de um pool de agentes. Um cluster deve ter pelo menos um Pool de Agentes do 'Sistema' o tempo todo. Para obter informações adicionais sobre restrições e práticas recomendadas do pool de agentes, consulte: https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile	AgentPoolNetworkProfile		Configurações relacionadas à rede de um pool de agentes.
properties.nodeImageVersion	string		A versão da imagem do nó
properties.nodeLabels	object		Os rótulos de nó a serem persistidos em todos os nós no pool de agentes.
properties.nodePublicIPPrefixID	string (arm-id)		O ID de prefixo IP público do qual os nós de VM devem usar IPs. Este é o formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints	string[]		As manchas adicionadas aos novos nós durante a criação e dimensionamento do pool de nós. Por exemplo, key=value:NoSchedule.
properties.orchestratorVersion	string		A versão do Kubernetes especificada pelo usuário. A versão do patch <> major.minor.patch (por exemplo, 1.20.13) e <> major.minor (por exemplo, 1.20) são suportadas. Quando <> major.minor é especificado, a versão mais recente do patch GA suportada é escolhida automaticamente. Atualizar o cluster com o mesmo <> major.minor depois de criado (por exemplo, 1.14.x -> 1.14) não acionará uma atualização, mesmo que uma versão de patch mais recente esteja disponível. Como prática recomendada, você deve atualizar todos os pools de nós em um cluster AKS para a mesma versão do Kubernetes. A versão do pool de nós deve ter a mesma versão principal do plano de controle. A versão secundária do pool de nós deve estar dentro de duas versões secundárias da versão do plano de controle. A versão do pool de nós não pode ser maior do que a versão do plano de controle. Para obter mais informações, consulte atualizando um pool de nós.
properties.osDiskSizeGB	integer (int32) minimum: 0 maximum: 2048		Tamanho do disco do SO em GB a ser usado para especificar o tamanho do disco para cada máquina no pool mestre/agente. Se você especificar 0, ele aplicará o tamanho osDisk padrão de acordo com o vmSize especificado.
properties.osDiskType	OSDiskType		O tipo de disco do sistema operacional a ser usado para máquinas no pool de agentes. O padrão é 'Ephemeral' se a VM suportar e tiver um disco de cache maior do que o OSDiskSizeGB solicitado. Caso contrário, o padrão será 'Gerenciado'. Não pode ser alterado após a criação. Para obter mais informações, consulte Ephemeral OS.
properties.osSKU	OSSKU		Especifica a SKU do sistema operacional usada pelo pool de agentes. O padrão é Ubuntu se OSType é Linux. O padrão é Windows2019 quando o Kubernetes <= 1.24 ou Windows2022 quando o Kubernetes >= 1.25 se OSType for Windows.
properties.osType	OSType	Linux	O tipo de sistema operacional. O padrão é Linux.
properties.podIPAllocationMode	PodIPAllocationMode		Modo de alocação de IP do pod. O modo de alocação de IP para pods no pool de agentes. Deve ser usado com podSubnetId. O padrão é 'DynamicIndividual'.
properties.podSubnetID	string (arm-id)		A ID da sub-rede à qual os pods se juntarão quando iniciados. Se omitidos, os IPs pod são atribuídos estaticamente na sub-rede do nó (consulte vnetSubnetID para obter mais detalhes). Este é o formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState	PowerState		Se o Pool de Agentes está em execução ou parado. Quando um pool de agentes é criado pela primeira vez, ele é inicialmente em execução. O Pool de Agentes pode ser interrompido definindo este campo como Parado. Um Pool de Agentes interrompido interrompe todas as suas VMs e não acumula encargos de cobrança. Um pool de agentes só pode ser interrompido se estiver em execução e o estado de provisionamento for bem-sucedido
properties.provisioningState	string		O estado atual de implantação ou provisionamento.
properties.proximityPlacementGroupID	string (arm-id)		A ID do Grupo de Posicionamento de Proximidade.
properties.scaleDownMode	ScaleDownMode		O modo de redução de escala a ser usado ao dimensionar o pool de agentes. Isso também afeta o comportamento do autoscaler do cluster. Se não for especificado, o padrão será Excluir.
properties.scaleSetEvictionPolicy	ScaleSetEvictionPolicy	Delete	A política de remoção do Conjunto de Dimensionamento de Máquina Virtual a ser usada. Isso não pode ser especificado, a menos que o scaleSetPriority seja 'Spot'. Se não for especificado, o padrão é 'Excluir'.
properties.scaleSetPriority	ScaleSetPriority	Regular	A prioridade do Conjunto de Dimensionamento de Máquina Virtual. Se não for especificado, o padrão é 'Regular'.
properties.securityProfile	AgentPoolSecurityProfile		As configurações de segurança de um pool de agentes.
properties.spotMaxPrice	number	-1	O preço máximo (em dólares americanos) que você está disposto a pagar por instâncias à vista. Os valores possíveis são qualquer valor decimal maior que zero ou -1 que indica o preço padrão a ser up-to sob demanda. Os valores possíveis são qualquer valor decimal superior a zero ou -1 que indique a vontade de pagar qualquer preço sob demanda. Para obter mais detalhes sobre preços spot, consulte de preços de VMs spot
properties.status	AgentPoolStatus		Contém informações somente leitura sobre o Pool de Agentes.
properties.tags	object		As marcas a serem persistidas no conjunto de dimensionamento de máquina virtual do pool de agentes.
properties.type	AgentPoolType		O tipo de pool de agentes.
properties.upgradeSettings	AgentPoolUpgradeSettings		Configurações para atualizar o agentpool
properties.virtualMachineNodesStatus	VirtualMachineNodes[]		O status dos nós em um pool de agentes VirtualMachines.
properties.virtualMachinesProfile	VirtualMachinesProfile		Especificações no pool de agentes do VirtualMachines.
properties.vmSize	string		O tamanho das VMs do pool de agentes. A disponibilidade do tamanho da VM varia de acordo com a região. Se um nó contiver recursos de computação insuficientes (memória, cpu, etc), os pods podem falhar ao funcionar corretamente. Para obter mais detalhes sobre tamanhos restritos de VM, consulte: https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID	string (arm-id)		A ID da sub-rede à qual os agentes, os nós do pool e, opcionalmente, os pods ingressarão na inicialização. Se isso não for especificado, uma VNET e uma sub-rede serão geradas e usadas. Se nenhum podSubnetID for especificado, isso se aplicará a nós e pods, caso contrário, se aplicará apenas a nós. Este é o formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile	AgentPoolWindowsProfile		O perfil específico do pool de agentes do Windows.
properties.workloadRuntime	WorkloadRuntime		Determina o tipo de carga de trabalho que um nó pode executar.
type	string		Tipo de recurso

AgentPoolGatewayProfile

Objetivo

Perfil do pool de agentes de gateway de cluster gerenciado.

Nome	Tipo	Valor padrão	Descrição
publicIPPrefixSize	integer (int32) minimum: 28 maximum: 31	31	O pool de agentes de gateway associa um IPPrefix público para cada gateway de saída estático para fornecer saída pública. O tamanho do IPPrefix público deve ser selecionado pelo usuário. Cada nó no pool de agentes é atribuído com um IP do IPPrefix. O tamanho do IPPrefix serve, portanto, como um limite no tamanho do pool de agentes do Gateway. Devido à limitação de tamanho do IPPrefix público do Azure, o intervalo de valores válido é [28, 31] (/31 = 2 nós/IPs, /30 = 4 nós/IPs, /29 = 8 nós/IPs, /28 = 16 nós/IPs). O valor padrão é 31.

AgentPoolMode

Enumeração

O modo de um pool de agentes. Um cluster deve ter pelo menos um Pool de Agentes do 'Sistema' o tempo todo. Para obter informações adicionais sobre restrições e práticas recomendadas do pool de agentes, consulte: https://docs.microsoft.com/azure/aks/use-system-pools

Valor	Descrição
System	Os pools de agentes do sistema são principalmente para hospedar pods críticos do sistema, como CoreDNS e metrics-server. Os pools de agentes do sistema osType devem ser Linux. Os pools de agentes do sistema VM SKU devem ter pelo menos 2vCPUs e 4GB de memória.
User	Os pools de agentes de usuário são principalmente para hospedar seus pods de aplicativo.
Gateway	Os pools de agentes de gateway são dedicados a fornecer IPs de saída estáticos para pods. Para obter mais detalhes, veja https://aka.ms/aks/static-egress-gateway.

AgentPoolNetworkProfile

Objetivo

Configurações de rede de um pool de agentes.

Nome	Tipo	Descrição
allowedHostPorts	PortRange[]	Os intervalos de porta que têm permissão para acessar. Os intervalos especificados podem sobrepor-se.
applicationSecurityGroups	string[] (arm-id)	As IDs dos grupos de segurança de aplicativos que o pool de agentes associará quando criado.
nodePublicIPTags	IPTag[]	IPTags de IPs públicos de nível de instância.

AgentPoolSecurityProfile

Objetivo

As configurações de segurança de um pool de agentes.

Nome	Tipo	Descrição
enableSecureBoot	boolean	A Inicialização Segura é um recurso do Trusted Launch que garante que apenas sistemas operacionais e drivers assinados possam inicializar. Para obter mais detalhes, consulte aka.ms/aks/trustedlaunch. Se não for especificado, o padrão será false.
enableVTPM	boolean	O vTPM é um recurso de inicialização confiável para configurar um cofre seguro dedicado para chaves e medições mantidas localmente no nó. Para obter mais detalhes, consulte aka.ms/aks/trustedlaunch. Se não for especificado, o padrão será false.
sshAccess	AgentPoolSSHAccess	Método de acesso SSH de um pool de agentes.

AgentPoolSSHAccess

Enumeração

Método de acesso SSH de um pool de agentes.

Valor	Descrição
LocalUser	Pode SSH no nó como um usuário local usando chave privada.
Disabled	O serviço SSH será desativado no nó.

AgentPoolStatus

Objetivo

Contém informações somente leitura sobre o Pool de Agentes.

Nome	Tipo	Descrição
provisioningError	ErrorDetail	As informações de detalhes do erro do pool de agentes. Preserva as informações detalhadas da falha. Se não houve erro, este campo é omitido.

AgentPoolType

Enumeração

O tipo de pool de agentes.

Valor	Descrição
VirtualMachineScaleSets	Crie um Pool de Agentes apoiado por um Conjunto de Dimensionamento de Máquina Virtual.
AvailabilitySet	O seu uso é fortemente desencorajado.
VirtualMachines	Crie um pool de agentes apoiado por um modo de orquestração de VM de instância única.

AgentPoolUpgradeSettings

Objetivo

Configurações para atualizar um agentpool

Nome	Tipo	Descrição
drainTimeoutInMinutes	integer (int32) minimum: 1 maximum: 1440	O tempo limite de drenagem para um nó. A quantidade de tempo (em minutos) para aguardar a remoção de pods e terminação graciosa por nó. Este tempo de espera de despejo honra a espera em orçamentos de interrupção de pod. Se esse tempo for excedido, a atualização falhará. Se não for especificado, o padrão é 30 minutos.
maxSurge	string	O número máximo ou a porcentagem de nós que são aumentados durante a atualização. Este valor pode ser definido como um número inteiro (por exemplo, «5») ou uma percentagem (por exemplo, «50%»). Se uma porcentagem for especificada, será a porcentagem do tamanho total do pool de agentes no momento da atualização. Para porcentagens, os nós fracionários são arredondados para cima. Se não for especificado, o padrão será 10%. Para obter mais informações, incluindo práticas recomendadas, consulte: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
maxUnavailable	string	O número máximo ou a porcentagem de nós que podem estar simultaneamente indisponíveis durante a atualização. Este valor pode ser definido como um número inteiro (por exemplo, «1») ou uma percentagem (por exemplo, «5%»). Se uma porcentagem for especificada, será a porcentagem do tamanho total do pool de agentes no momento da atualização. Para porcentagens, os nós fracionários são arredondados para cima. Se não for especificado, o padrão será 0. Para obter mais informações, incluindo práticas recomendadas, consulte: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
nodeSoakDurationInMinutes	integer (int32) minimum: 0 maximum: 30	A duração de imersão de um nó. A quantidade de tempo (em minutos) para esperar depois de drenar um nó e antes de recriar a imagem e passar para o próximo nó. Se não for especificado, o padrão será 0 minutos.
undrainableNodeBehavior	UndrainableNodeBehavior	Define o comportamento para nós não drenáveis durante a atualização. A causa mais comum de nós não drenáveis é Pod Disruption Budgets (PDBs), mas outros problemas, como o período de carência de término do pod está excedendo o tempo limite de drenagem por nó restante ou o pod ainda está em um estado de execução, também podem causar nós não drenáveis.

AgentPoolWindowsProfile

Objetivo

O perfil específico do pool de agentes do Windows.

Nome	Tipo	Descrição
disableOutboundNat	boolean	Se deseja desativar OutboundNAT em nós do Windows. O valor predefinido é false. O NAT de saída só pode ser desabilitado se o cluster outboundType for NAT Gateway e o pool de agentes do Windows não tiver o IP público do nó habilitado.

code

Enumeração

Informa se o cluster está em execução ou interrompido

Valor	Descrição
Running	O cluster está em execução.
Stopped	O cluster é interrompido.

CreationData

Objetivo

Dados usados ao criar um recurso de destino a partir de um recurso de origem.

Nome	Tipo	Descrição
sourceResourceId	string (arm-id)	Este é o ID ARM do objeto de origem a ser usado para criar o objeto de destino.

ErrorAdditionalInfo

Objetivo

O erro de gerenciamento de recursos informações adicionais.

Nome	Tipo	Descrição
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objetivo

O detalhe do erro.

Nome	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objetivo

Resposta de erro

Nome	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

GPUDriver

Enumeração

Se deseja instalar drivers de GPU. Quando não é especificado, o padrão é Instalar.

Valor	Descrição
Install	Instale o driver.
None	Ignorar a instalação do driver.

GPUInstanceProfile

Enumeração

GPUInstanceProfile a ser usado para especificar o perfil de instância MIG da GPU para GPU VM SKU suportado.

Valor	Descrição
MIG1g
MIG2g
MIG3g
MIG4g
MIG7g

GPUProfile

Objetivo

Configurações de GPU para o pool de agentes.

Nome	Tipo	Descrição
driver	GPUDriver	Se deseja instalar drivers de GPU. Quando não é especificado, o padrão é Instalar.

IPTag

Objetivo

Contém o IPTag associado ao objeto.

Nome	Tipo	Descrição
ipTagType	string	O tipo de tag IP. Exemplo: RoutingPreference.
tag	string	O valor da tag IP associada ao IP público. Exemplo: Internet.

KubeletConfig

Objetivo

Configurações Kubelet de nós de agente. Consulte de configuração de nó personalizado do AKS para obter mais detalhes.

Nome	Tipo	Descrição
allowedUnsafeSysctls	string[]	Lista permitida de sysctls não seguros ou padrões de sysctl não seguros (terminando em `*`).
containerLogMaxFiles	integer (int32) minimum: 2	O número máximo de arquivos de log de contêiner que podem estar presentes para um contêiner. O número deve ser ≥ 2.
containerLogMaxSizeMB	integer (int32)	O tamanho máximo (por exemplo, 10Mi) do arquivo de log do contêiner antes de ser girado.
cpuCfsQuota	boolean	Se a imposição de cota CFS da CPU estiver habilitada para contêineres que especificam limites de CPU. O padrão é verdadeiro.
cpuCfsQuotaPeriod	string	O valor do período de cota CFS da CPU. O padrão é '100ms'. Os valores válidos são uma sequência de números decimais com uma fração opcional e um sufixo unitário. Por exemplo: '300ms', '2h45m'. As unidades suportadas são 'ns', 'us', 'ms', 's', 'm' e 'h'.
cpuManagerPolicy	string	A política do CPU Manager a ser usada. O padrão é 'nenhum'. Consulte Políticas de gerenciamento de CPU do Kubernetes para obter mais informações. Os valores permitidos são 'nenhum' e 'estático'.
failSwapOn	boolean	Se definido como true, fará com que o Kubelet falhe ao iniciar se a troca estiver habilitada no nó.
imageGcHighThreshold	integer (int32)	A porcentagem de uso do disco após a qual a coleta de lixo de imagem é sempre executada. Para desativar a coleta de lixo de imagem, defina como 100. O padrão é 85%
imageGcLowThreshold	integer (int32)	A porcentagem de uso do disco antes da qual a coleta de lixo de imagem nunca é executada. Isso não pode ser definido acima de imageGcHighThreshold. O padrão é 80%
podMaxPids	integer (int32)	O número máximo de processos por pod.
topologyManagerPolicy	string	A política do Gerenciador de Topologias a ser usada. Para obter mais informações, consulte Gerenciador de topologia do Kubernetes. O padrão é 'nenhum'. Os valores permitidos são 'none', 'best-effort', 'restricted' e 'single-numa-node'.

KubeletDiskType

Enumeração

Determina o posicionamento de volumes emptyDir, raiz de dados de tempo de execução do contêiner e armazenamento efêmero do Kubelet.

Valor	Descrição
OS	Kubelet usará o disco do sistema operacional para seus dados.
Temporary	Kubelet usará o disco temporário para seus dados.

LinuxOSConfig

Objetivo

Configurações de SO de nós de agente Linux. Consulte de configuração de nó personalizado do AKS para obter mais detalhes.

Nome	Tipo	Descrição
swapFileSizeMB	integer (int32)	O tamanho em MB de um arquivo de permuta que será criado em cada nó.
sysctls	SysctlConfig	Configurações de sysctl para nós de agente Linux.
transparentHugePageDefrag	string	Se o kernel deve fazer uso agressivo da compactação de memória para disponibilizar mais páginas enormes. Os valores válidos são 'sempre', 'defer', 'defer+madvise', 'madvise' e 'never'. O padrão é 'madvise'. Para obter mais informações, consulte Transparent Hugepages.
transparentHugePageEnabled	string	Se as páginas enormes transparentes estão habilitadas. Os valores válidos são 'sempre', 'madvise' e 'nunca'. O padrão é 'sempre'. Para obter mais informações, consulte Transparent Hugepages.

LocalDNSForwardDestination

Enumeração

Servidor de destino para consultas DNS a serem encaminhadas do localDNS.

Valor	Descrição
ClusterCoreDNS	Encaminhe consultas DNS de localDNS para cluster CoreDNS.
VnetDNS	Encaminhe consultas DNS de localDNS para o servidor DNS configurado na VNET. Uma VNET pode ter vários servidores DNS configurados.

LocalDNSForwardPolicy

Enumeração

Política de encaminhamento para selecionar o servidor DNS upstream. Consulte forward plugin para obter mais informações.

Valor	Descrição
Sequential	Implementa a seleção sequencial de servidores DNS upstream. Consulte forward plugin para obter mais informações.
RoundRobin	Implementa a seleção de servidor DNS upstream round robin. Consulte forward plugin para obter mais informações.
Random	Implementa a seleção aleatória de servidor DNS upstream. Consulte forward plugin para obter mais informações.

LocalDNSMode

Enumeração

Modo de ativação para localDNS.

Valor	Descrição
Preferred	Se a versão atual do orquestrador suportar esse recurso, prefira habilitar o localDNS.
Required	Habilite o localDNS.
Disabled	Desative localDNS.

LocalDNSOverride

Objetivo

Substitui o perfil localDNS.

Nome	Tipo	Valor padrão	Descrição
cacheDurationInSeconds	integer (int32)	3600	Cache máximo TTL em segundos. Consulte o plug-in de cache para obter mais informações.
forwardDestination	LocalDNSForwardDestination	ClusterCoreDNS	Servidor de destino para consultas DNS a serem encaminhadas do localDNS.
forwardPolicy	LocalDNSForwardPolicy	Sequential	Política de encaminhamento para selecionar o servidor DNS upstream. Consulte forward plugin para obter mais informações.
maxConcurrent	integer (int32)	1000	Número máximo de consultas simultâneas. Consulte forward plugin para obter mais informações.
protocol	LocalDNSProtocol	PreferUDP	Imponha TCP ou prefira o protocolo UDP para conexões de localDNS para servidor DNS upstream.
queryLogging	LocalDNSQueryLogging	Error	Nível de log para consultas DNS no localDNS.
serveStale	LocalDNSServeStale	Immediate	Política para servir dados obsoletos. Consulte o plug-in de cache para obter mais informações.
serveStaleDurationInSeconds	integer (int32)	3600	Sirva a duração obsoleta em segundos. Consulte o plug-in de cache para obter mais informações.

LocalDNSProfile

Objetivo

Configura o DNS local por nó, com substituições de VnetDNS e KubeDNS. LocalDNS ajuda a melhorar o desempenho e a confiabilidade da resolução DNS em um cluster AKS. Para mais detalhes, ver aka.ms/aks/localdns.

Nome	Tipo	Valor padrão	Descrição
kubeDNSOverrides	<string, LocalDNSOverride>		As substituições do KubeDNS aplicam-se ao tráfego DNS de pods com dnsPolicy:ClusterFirst (referido como tráfego KubeDNS).
mode	LocalDNSMode	Preferred	Modo de ativação para localDNS.
state	LocalDNSState		Estado gerado pelo sistema de localDNS.
vnetDNSOverrides	<string, LocalDNSOverride>		As substituições de VnetDNS aplicam-se ao tráfego DNS de pods com dnsPolicy:default ou kubelet (referido como tráfego VnetDNS).

LocalDNSProtocol

Enumeração

Imponha TCP ou prefira o protocolo UDP para conexões de localDNS para servidor DNS upstream.

Valor	Descrição
PreferUDP	Prefira o protocolo UDP para conexões de localDNS para servidor DNS upstream.
ForceTCP	Aplique o protocolo TCP para conexões de localDNS para servidor DNS upstream.

LocalDNSQueryLogging

Enumeração

Nível de log para consultas DNS no localDNS.

Valor	Descrição
Error	Permite o registo de erros no localDNS. Consulte o plugin de erros para obter mais informações.
Log	Permite o registo de consultas no localDNS. Consulte o plug-in de log para obter mais informações.

LocalDNSServeStale

Enumeração

Política para servir dados obsoletos. Consulte o plug-in de cache para obter mais informações.

Valor	Descrição
Verify	Forneça dados obsoletos com verificação. Primeiro, verifique se uma entrada ainda não está disponível na fonte antes de enviar a entrada expirada para o cliente. Consulte o plug-in de cache para obter mais informações.
Immediate	Sirva dados obsoletos imediatamente. Envie a entrada expirada para o cliente antes de verificar se a entrada está disponível na fonte. Consulte o plug-in de cache para obter mais informações.
Disable	Desative o serviço de dados obsoletos.

LocalDNSState

Enumeração

Estado gerado pelo sistema de localDNS.

Valor	Descrição
Enabled	localDNS está habilitado.
Disabled	localDNS está desativado.

ManualScaleProfile

Objetivo

Especificações sobre o número de máquinas.

Nome	Tipo	Descrição
count	integer (int32)	Número de nós.
size	string	Tamanho da VM que o AKS usará ao criar e dimensionar, por exemplo, 'Standard_E4s_v3', 'Standard_E16s_v3' ou 'Standard_D16s_v5'.

OSDiskType

Enumeração

O tipo de disco do sistema operacional a ser usado para máquinas no pool de agentes. O padrão é 'Ephemeral' se a VM suportar e tiver um disco de cache maior do que o OSDiskSizeGB solicitado. Caso contrário, o padrão será 'Gerenciado'. Não pode ser alterado após a criação. Para obter mais informações, consulte Ephemeral OS.

Valor

Descrição

Managed

O Azure replica o disco do sistema operacional de uma máquina virtual para o armazenamento do Azure para evitar perda de dados caso a VM precise ser realocada para outro host. Como os contêineres não foram projetados para que o estado local persista, esse comportamento oferece valor limitado enquanto fornece algumas desvantagens, incluindo provisionamento de nó mais lento e latência de leitura/gravação mais alta.

Ephemeral

Os discos efêmeros do sistema operacional são armazenados apenas na máquina host, assim como um disco temporário. Isso proporciona menor latência de leitura/gravação, juntamente com escalonamento de nó mais rápido e atualizações de cluster.

OSSKU

Enumeração

Especifica a SKU do sistema operacional usada pelo pool de agentes. O padrão é Ubuntu se OSType é Linux. O padrão é Windows2019 quando o Kubernetes <= 1.24 ou Windows2022 quando o Kubernetes >= 1.25 se OSType for Windows.

Valor	Descrição
AzureLinux	Use AzureLinux como o sistema operacional para imagens de nó. O Azure Linux é uma distro Linux otimizada para contêiner criada pela Microsoft, visite https://aka.ms/azurelinux para obter mais informações.
AzureLinux3	Use AzureLinux3 como o sistema operacional para imagens de nó. O Azure Linux é uma distro Linux otimizada para contêiner criada pela Microsoft, visite https://aka.ms/azurelinux para obter mais informações. Para limitações, visite https://aka.ms/aks/node-images. Para obter orientações sobre migração de SO, consulte https://aka.ms/aks/upgrade-os-version.
CBLMariner	OSSKU preterido. A Microsoft recomenda que as novas implantações escolham 'AzureLinux' em vez disso.
Ubuntu	Use o Ubuntu como o sistema operacional para imagens de nós.
Ubuntu2204	Use o Ubuntu2204 como o sistema operacional para imagens de nós, no entanto, o Ubuntu 22.04 pode não ser suportado para todos os nodepools. Para limitações e versões kubernetes suportadas, consulte https://aka.ms/aks/supported-ubuntu-versions
Ubuntu2404	Use o Ubuntu2404 como o sistema operacional para imagens de nós, no entanto, o Ubuntu 24.04 pode não ser suportado para todos os nodepools. Para limitações e versões kubernetes suportadas, consulte https://aka.ms/aks/supported-ubuntu-versions
Windows2019	Use o Windows2019 como o sistema operacional para imagens de nó. Não suportado para pools de nós do sistema. Windows2019 suporta apenas contêineres do Windows2019; ele não pode executar contêineres do Windows2022 e vice-versa.
Windows2022	Use o Windows2022 como o sistema operacional para imagens de nó. Não suportado para pools de nós do sistema. O Windows2022 suporta apenas contêineres do Windows2022; ele não pode executar contêineres do Windows2019 e vice-versa.

OSType

Enumeração

O tipo de sistema operacional. O padrão é Linux.

Valor	Descrição
Linux	Usa Linux.
Windows	Usa o Windows.

PodIPAllocationMode

Enumeração

Modo de alocação de IP do pod. O modo de alocação de IP para pods no pool de agentes. Deve ser usado com podSubnetId. O padrão é 'DynamicIndividual'.

Valor

Descrição

DynamicIndividual

Cada nó é alocado com uma lista não contígua de endereços IP atribuíveis a pods. Isso é melhor para maximizar uma sub-rede pequena a média de tamanho /16 ou menor. O cluster CNI do Azure com alocação de IP dinâmica assume como padrão esse modo se o cliente não especificar explicitamente um podIPAllocationMode

StaticBlock

Cada nó é alocado estaticamente bloco(s) CIDR de tamanho /28 = 16 IPs por bloco para satisfazer os maxPods por nó. Número de blocos CIDR >= (maxPods / 16). O bloco, em vez de um único IP, conta contra o limite de IP privado do Azure Vnet de 65K. Portanto, o modo de bloco é adequado para executar cargas de trabalho maiores com mais do que o limite atual de 65K pods em um cluster. Este modo é mais adequado para escalar com sub-redes maiores de /15 ou maiores

PortRange

Objetivo

O intervalo de portas.

Nome	Tipo	Descrição
portEnd	integer (int32) minimum: 1 maximum: 65535	A porta máxima incluída no intervalo. Deve ser variado de 1 a 65535, e ser maior ou igual a portStart.
portStart	integer (int32) minimum: 1 maximum: 65535	A porta mínima incluída no intervalo. Deve ser variado de 1 a 65535, e ser menor ou igual a portEnd.
protocol	Protocol	O protocolo de rede da porta.

PowerState

Objetivo

Descreve o estado de energia do cluster

Nome	Tipo	Descrição
code	code	Informa se o cluster está em execução ou interrompido

Protocol

Enumeração

O protocolo de rede da porta.

Valor	Descrição
TCP	Protocolo TCP.
UDP	Protocolo UDP.

ScaleDownMode

Enumeração

Descreve como as VMs são adicionadas ou removidas dos Pools de Agentes. Consulte os estados de faturação.

Valor	Descrição
Delete	Crie novas instâncias durante o aumento de escala e remova instâncias durante a redução de escala.
Deallocate	Tente iniciar instâncias desalocadas (se existirem) durante o aumento de escala e desalocar instâncias durante a redução de escala.

ScaleProfile

Objetivo

Especificações sobre como dimensionar um pool de agentes VirtualMachines.

Nome	Tipo	Descrição
manual	ManualScaleProfile[]	Especificações sobre como dimensionar o pool de agentes do VirtualMachines para um tamanho fixo.

ScaleSetEvictionPolicy

Enumeração

A política de remoção do Conjunto de Dimensionamento de Máquina Virtual. A política de remoção especifica o que fazer com a VM quando ela é removida. O padrão é Excluir. Para obter mais informações sobre remoção, consulte VMs spot

Valor	Descrição
Delete	Os nós no Conjunto de Escala subjacente do pool de nós são excluídos quando são removidos.
Deallocate	Os nós no Conjunto de Escala subjacente do pool de nós são definidos para o estado de desalocação interrompida após a remoção. Os nós no estado de desalocação interrompida contam em relação à sua cota de computação e podem causar problemas com o dimensionamento ou atualização do cluster.

ScaleSetPriority

Enumeração

A prioridade do Conjunto de Dimensionamento de Máquina Virtual.

Valor	Descrição
Spot	Serão utilizadas VMs com prioridade pontual. Não há SLA para nós spot. Consulte local no AKS para obter mais informações.
Regular	Serão utilizadas VMs regulares.

SysctlConfig

Objetivo

Configurações de sysctl para nós de agente Linux.

Nome	Tipo	Descrição
fsAioMaxNr	integer (int32)	Configuração do Sysctl fs.aio-max-nr.
fsFileMax	integer (int32)	Configuração do Sysctl fs.file-max.
fsInotifyMaxUserWatches	integer (int32)	Configuração do Sysctl fs.inotify.max_user_watches.
fsNrOpen	integer (int32)	Configuração do Sysctl fs.nr_open.
kernelThreadsMax	integer (int32)	Configuração do Sysctl kernel.threads-max.
netCoreNetdevMaxBacklog	integer (int32)	Configuração do Sysctl net.core.netdev_max_backlog.
netCoreOptmemMax	integer (int32)	Configuração do Sysctl net.core.optmem_max.
netCoreRmemDefault	integer (int32)	Configuração do Sysctl net.core.rmem_default.
netCoreRmemMax	integer (int32)	Configuração do Sysctl net.core.rmem_max.
netCoreSomaxconn	integer (int32)	Configuração de sysctl net.core.somaxconn.
netCoreWmemDefault	integer (int32)	Configuração do Sysctl net.core.wmem_default.
netCoreWmemMax	integer (int32)	Configuração do Sysctl net.core.wmem_max.
netIpv4IpLocalPortRange	string	Configuração do Sysctl net.ipv4.ip_local_port_range.
netIpv4NeighDefaultGcThresh1	integer (int32)	Configuração do Sysctl net.ipv4.neigh.default.gc_thresh1.
netIpv4NeighDefaultGcThresh2	integer (int32)	Configuração do Sysctl net.ipv4.neigh.default.gc_thresh2.
netIpv4NeighDefaultGcThresh3	integer (int32)	Configuração do Sysctl net.ipv4.neigh.default.gc_thresh3.
netIpv4TcpFinTimeout	integer (int32)	Configuração do Sysctl net.ipv4.tcp_fin_timeout.
netIpv4TcpKeepaliveProbes	integer (int32)	Configuração do Sysctl net.ipv4.tcp_keepalive_probes.
netIpv4TcpKeepaliveTime	integer (int32)	Configuração do Sysctl net.ipv4.tcp_keepalive_time.
netIpv4TcpMaxSynBacklog	integer (int32)	Configuração do Sysctl net.ipv4.tcp_max_syn_backlog.
netIpv4TcpMaxTwBuckets	integer (int32)	Configuração do Sysctl net.ipv4.tcp_max_tw_buckets.
netIpv4TcpTwReuse	boolean	Configuração do Sysctl net.ipv4.tcp_tw_reuse.
netIpv4TcpkeepaliveIntvl	integer (int32) minimum: 10 maximum: 90	Configuração do Sysctl net.ipv4.tcp_keepalive_intvl.
netNetfilterNfConntrackBuckets	integer (int32) minimum: 65536 maximum: 524288	Configuração do Sysctl net.netfilter.nf_conntrack_buckets.
netNetfilterNfConntrackMax	integer (int32) minimum: 131072 maximum: 2097152	Configuração do Sysctl net.netfilter.nf_conntrack_max.
vmMaxMapCount	integer (int32)	Configuração do Sysctl vm.max_map_count.
vmSwappiness	integer (int32)	Configuração do Sysctl vm.swappiness.
vmVfsCachePressure	integer (int32)	Configuração do Sysctl vm.vfs_cache_pressure.

UndrainableNodeBehavior

Enumeração

Define o comportamento para nós não drenáveis durante a atualização. A causa mais comum de nós não drenáveis é Pod Disruption Budgets (PDBs), mas outros problemas, como o período de carência de término do pod está excedendo o tempo limite de drenagem por nó restante ou o pod ainda está em um estado de execução, também podem causar nós não drenáveis.

Valor

Descrição

Schedule

O AKS marcará os nós bloqueados como escalonáveis, mas os nós bloqueados não serão atualizados. Será feita uma tentativa de melhor esforço para excluir todos os nós de surto. A operação de atualização e o cluster gerenciado estarão em estado de falha se houver nós bloqueados.

Cordon

O AKS fará o cordão dos nós bloqueados e os substituirá por nós de surto durante a atualização. Os nós bloqueados serão isolados e substituídos por nós de surto. Os nós bloqueados terão o rótulo 'kubernetes.azure.com/upgrade-status:Quarantined'. Um nó de surto será mantido para cada nó bloqueado. Será feita uma tentativa de melhor esforço para excluir todos os outros nós de surto. Se houver nós de aumento suficientes para substituir os nós bloqueados, a operação de atualização e o cluster gerenciado estarão em estado de falha. Caso contrário, a operação de atualização e o cluster gerenciado estarão em estado cancelado.

VirtualMachineNodes

Objetivo

Status atual em um grupo de nós do mesmo tamanho vm.

Nome	Tipo	Descrição
count	integer (int32)	Número de nós.
size	string	O tamanho da VM dos agentes usados para hospedar esse grupo de nós.

VirtualMachinesProfile

Objetivo

Especificações no pool de agentes do VirtualMachines.

Nome	Tipo	Descrição
scale	ScaleProfile	Especificações sobre como dimensionar um pool de agentes VirtualMachines.

WorkloadRuntime

Enumeração

Determina o tipo de carga de trabalho que um nó pode executar.

Valor	Descrição
OCIContainer	Os nós usarão o Kubelet para executar cargas de trabalho de contêiner OCI padrão.
WasmWasi	Os nós usarão o Krustlet para executar cargas de trabalho WASM usando o provedor WASI (Visualização).
KataVmIsolation	Os nós podem usar (Kata + Cloud Hypervisor + Hyper-V) para habilitar pods baseados em VM aninhados. Devido ao uso do Hyper-V, o próprio sistema operacional do nó AKS é uma VM aninhada (o sistema operacional raiz) do Hyper-V. Assim, ele só pode ser usado com séries de VM que suportam virtualização aninhada, como a série Dv3.