Partilhar via

AgentPool interface

  • Referência
Pacote:
@azure/arm-containerservice

Pool de agentes.

Extends
SubResource

Propriedades

availabilityZones

A lista de zonas de disponibilidade a serem usadas para nós. Isso só pode ser especificado se a propriedade AgentPoolType for 'VirtualMachineScaleSets'.
capacityReservationGroupID

O AKS associará o pool de agentes especificado ao Grupo de Reserva de Capacidade.
count

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.
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.
currentOrchestratorVersion

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. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
enableAutoScaling

Se o dimensionador automático deve ser ativado
enableEncryptionAtHost

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
enableFips

Consulte Adicionar um pool de nós habilitado para FIPS para obter mais detalhes.
enableNodePublicIP

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.
enableUltraSSD

Se o UltraSSD deve ser ativado
eTag

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. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
gpuInstanceProfile

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

Este é o formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Para obter mais informações, consulte hosts dedicados do Azure.
kubeletConfig

A configuração do Kubelet nos nós do pool de agentes.
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

A configuração do sistema operacional dos nós do agente Linux.
maxCount

O número máximo de nós para dimensionamento automático
maxPods

O número máximo de pods que podem ser executados em um nó.
minCount

O número mínimo de nós para dimensionamento automático
mode

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
networkProfile

Configurações relacionadas à rede de um pool de agentes.
nodeImageVersion

A versão da imagem do nó NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
nodeLabels

Os rótulos de nó a serem persistidos em todos os nós no pool de agentes.
nodePublicIPPrefixID

Este é o formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
nodeTaints

As manchas adicionadas aos novos nós durante a criação e dimensionamento do pool de nós. Por exemplo, key=value:NoSchedule.
orchestratorVersion

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.
osDiskSizeGB

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.
osDiskType

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.
podSubnetID

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}
powerState

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
provisioningState

O estado atual de implantação ou provisionamento. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
proximityPlacementGroupID

A ID do Grupo de Posicionamento de Proximidade.
scaleDownMode

Isso também afeta o comportamento do autoscaler do cluster. Se não for especificado, o padrão será Excluir.
scaleSetEvictionPolicy

Isso não pode ser especificado, a menos que o scaleSetPriority seja 'Spot'. Se não for especificado, o padrão é 'Excluir'.
scaleSetPriority

A prioridade do Conjunto de Dimensionamento de Máquina Virtual. Se não for especificado, o padrão é 'Regular'.
securityProfile

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

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
tags

As marcas a serem persistidas no conjunto de dimensionamento de máquina virtual do pool de agentes.
typePropertiesType

O tipo de pool de agentes.
upgradeSettings

Configurações para atualizar o agentpool
vmSize

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
vnetSubnetID

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}
windowsProfile

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

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

Propriedades Herdadas

id

ID do recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name

O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
type

Tipo de recurso NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes de Propriedade

availabilityZones

A lista de zonas de disponibilidade a serem usadas para nós. Isso só pode ser especificado se a propriedade AgentPoolType for 'VirtualMachineScaleSets'.

availabilityZones?: string[]

Valor de Propriedade

string[]

capacityReservationGroupID

O AKS associará o pool de agentes especificado ao Grupo de Reserva de Capacidade.

capacityReservationGroupID?: string

Valor de Propriedade

string

count

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.

count?: number

Valor de Propriedade

number

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.

creationData?: CreationData

Valor de Propriedade

CreationData

currentOrchestratorVersion

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. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

currentOrchestratorVersion?: string

Valor de Propriedade

string

enableAutoScaling

Se o dimensionador automático deve ser ativado

enableAutoScaling?: boolean

Valor de Propriedade

boolean

enableEncryptionAtHost

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

enableEncryptionAtHost?: boolean

Valor de Propriedade

boolean

enableFips

Consulte Adicionar um pool de nós habilitado para FIPS para obter mais detalhes.

enableFips?: boolean

Valor de Propriedade

boolean

enableNodePublicIP

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.

enableNodePublicIP?: boolean

Valor de Propriedade

boolean

enableUltraSSD

Se o UltraSSD deve ser ativado

enableUltraSSD?: boolean

Valor de Propriedade

boolean

eTag

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. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

eTag?: string

Valor de Propriedade

string

gpuInstanceProfile

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

gpuInstanceProfile?: string

Valor de Propriedade

string

hostGroupID

Este é o formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Para obter mais informações, consulte hosts dedicados do Azure.

hostGroupID?: string

Valor de Propriedade

string

kubeletConfig

A configuração do Kubelet nos nós do pool de agentes.

kubeletConfig?: KubeletConfig

Valor de Propriedade

KubeletConfig

kubeletDiskType

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

kubeletDiskType?: string

Valor de Propriedade

string

linuxOSConfig

A configuração do sistema operacional dos nós do agente Linux.

linuxOSConfig?: LinuxOSConfig

Valor de Propriedade

LinuxOSConfig

maxCount

O número máximo de nós para dimensionamento automático

maxCount?: number

Valor de Propriedade

number

maxPods

O número máximo de pods que podem ser executados em um nó.

maxPods?: number

Valor de Propriedade

number

minCount

O número mínimo de nós para dimensionamento automático

minCount?: number

Valor de Propriedade

number

mode

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

mode?: string

Valor de Propriedade

string

networkProfile

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

networkProfile?: AgentPoolNetworkProfile

Valor de Propriedade

AgentPoolNetworkProfile

nodeImageVersion

A versão da imagem do nó NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

nodeImageVersion?: string

Valor de Propriedade

string

nodeLabels

Os rótulos de nó a serem persistidos em todos os nós no pool de agentes.

nodeLabels?: {[propertyName: string]: string}

Valor de Propriedade

{[propertyName: string]: string}

nodePublicIPPrefixID

Este é o formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodePublicIPPrefixID?: string

Valor de Propriedade

string

nodeTaints

As manchas adicionadas aos novos nós durante a criação e dimensionamento do pool de nós. Por exemplo, key=value:NoSchedule.

nodeTaints?: string[]

Valor de Propriedade

string[]

orchestratorVersion

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.

orchestratorVersion?: string

Valor de Propriedade

string

osDiskSizeGB

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.

osDiskSizeGB?: number

Valor de Propriedade

number

osDiskType

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.

osDiskType?: string

Valor de Propriedade

string

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.

osSKU?: string

Valor de Propriedade

string

osType

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

osType?: string

Valor de Propriedade

string

podSubnetID

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}

podSubnetID?: string

Valor de Propriedade

string

powerState

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

powerState?: PowerState

Valor de Propriedade

PowerState

provisioningState

O estado atual de implantação ou provisionamento. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

provisioningState?: string

Valor de Propriedade

string

proximityPlacementGroupID

A ID do Grupo de Posicionamento de Proximidade.

proximityPlacementGroupID?: string

Valor de Propriedade

string

scaleDownMode

Isso também afeta o comportamento do autoscaler do cluster. Se não for especificado, o padrão será Excluir.

scaleDownMode?: string

Valor de Propriedade

string

scaleSetEvictionPolicy

Isso não pode ser especificado, a menos que o scaleSetPriority seja 'Spot'. Se não for especificado, o padrão é 'Excluir'.

scaleSetEvictionPolicy?: string

Valor de Propriedade

string

scaleSetPriority

A prioridade do Conjunto de Dimensionamento de Máquina Virtual. Se não for especificado, o padrão é 'Regular'.

scaleSetPriority?: string

Valor de Propriedade

string

securityProfile

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

securityProfile?: AgentPoolSecurityProfile

Valor de Propriedade

AgentPoolSecurityProfile

spotMaxPrice

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

spotMaxPrice?: number

Valor de Propriedade

number

tags

As marcas a serem persistidas no conjunto de dimensionamento de máquina virtual do pool de agentes.

tags?: {[propertyName: string]: string}

Valor de Propriedade

{[propertyName: string]: string}

typePropertiesType

O tipo de pool de agentes.

typePropertiesType?: string

Valor de Propriedade

string

upgradeSettings

Configurações para atualizar o agentpool

upgradeSettings?: AgentPoolUpgradeSettings

Valor de Propriedade

AgentPoolUpgradeSettings

vmSize

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

vmSize?: string

Valor de Propriedade

string

vnetSubnetID

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}

vnetSubnetID?: string

Valor de Propriedade

string

windowsProfile

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

windowsProfile?: AgentPoolWindowsProfile

Valor de Propriedade

AgentPoolWindowsProfile

workloadRuntime

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

workloadRuntime?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

id

ID do recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor de Propriedade

string

herdada deSubResource.id

name

O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor de Propriedade

string

herdada deSubResource.name

type

Tipo de recurso NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor de Propriedade

string

herdado de SubResource.type