Condividi tramite

Agent Pools - Create Or Update

  • Riferimento
Service:
AKS
API Version:
2024-02-01

Crea o aggiorna un pool di agenti nel cluster gestito specificato.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
agentPoolName
 path True

string

Nome del pool di agenti.

Regex pattern: ^[a-z][a-z0-9]{0,11}$
resourceGroupName
 path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
resourceName
 path True

string

Nome della risorsa del cluster gestito.

Regex pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
subscriptionId
 path True

string

uuid

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Tipo Descrizione
properties.availabilityZones

string[]

Elenco delle zone di disponibilità da usare per i nodi. Questa opzione può essere specificata solo se la proprietà AgentPoolType è "VirtualMachineScaleSets".
properties.capacityReservationGroupID

string

ID risorsa completo del gruppo di prenotazioni della capacità per fornire macchine virtuali da un gruppo riservato di Macchine virtuali.
Il servizio Azure Kubernetes associa il pool di agenti specificato al gruppo di prenotazioni di capacità.
properties.count

integer

Numero di agenti (VM) per ospitare contenitori Docker. I valori consentiti devono essere compresi nell'intervallo compreso tra 0 e 1000 (inclusi) per i pool di utenti e nell'intervallo compreso tra 1 e 1000 (inclusi) per i pool di sistema. Il valore predefinito è 1.
properties.creationData

CreationData

CreationData da usare per specificare l'ID snapshot di origine se il pool di nodi verrà creato/aggiornato usando uno snapshot.
properties.enableAutoScaling

boolean

Se abilitare il ridimensionamento automatico
properties.enableEncryptionAtHost

boolean

Se abilitare la crittografia del sistema operativo e dell'unità dati basata su host.
Questa funzionalità è supportata solo in determinate dimensioni della macchina virtuale e in determinate aree di Azure. Per altre informazioni, vedere: https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS

boolean

Se usare un sistema operativo abilitato per FIPS.
Per altre informazioni, vedere Aggiungere un pool di nodi abilitato per FIPS .
properties.enableNodePublicIP

boolean

Se ogni nodo viene allocato un indirizzo IP pubblico.
Alcuni scenari possono richiedere nodi in un pool di nodi per ricevere i propri indirizzi IP pubblici dedicati. Uno scenario comune è per i carichi di lavoro di gioco, in cui una console deve creare una connessione diretta a una macchina virtuale cloud per ridurre al minimo gli hop. Per altre informazioni, vedere l'assegnazione di un indirizzo IP pubblico per nodo. Il valore predefinito è false.
properties.enableUltraSSD

boolean

Se abilitare UltraSSD
properties.gpuInstanceProfile

GPUInstanceProfile

GPUInstanceProfile da usare per specificare il profilo di istanza DI GPU MIG per lo SKU della macchina virtuale GPU supportato.
properties.hostGroupID

string

ID risorsa completo del gruppo host dedicato per effettuare il provisioning di macchine virtuali da, usato solo nello scenario di creazione e non consentito di modificare una volta impostato.
Si tratta del modulo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Per altre informazioni, vedere Host dedicati di Azure.
properties.kubeletConfig

KubeletConfig

Configurazioni kubelet dei nodi dell'agente.
Configurazione di Kubelet nei nodi del pool di agenti.
properties.kubeletDiskType

KubeletDiskType

Determina il posizionamento dei volumi emptyDir, della radice dei dati del runtime del contenitore e dell'archiviazione temporanea kubelet.
properties.linuxOSConfig

LinuxOSConfig

Configurazioni del sistema operativo dei nodi dell'agente Linux.
Configurazione del sistema operativo dei nodi dell'agente Linux.
properties.maxCount

integer

Numero massimo di nodi per il ridimensionamento automatico
properties.maxPods

integer

Numero massimo di pod che possono essere eseguiti in un nodo.
properties.minCount

integer

Numero minimo di nodi per il ridimensionamento automatico
properties.mode

AgentPoolMode

Modalità di un pool di agenti.
Un cluster deve avere almeno un pool di agenti "System" in ogni momento. Per altre informazioni sulle restrizioni del pool di agenti e sulle procedure consigliate, vedere: https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile

AgentPoolNetworkProfile

Impostazioni correlate alla rete di un pool di agenti.
properties.nodeLabels

object

Le etichette dei nodi da rendere persistenti in tutti i nodi nel pool di agenti.
properties.nodePublicIPPrefixID

string

ID prefisso IP pubblico da cui devono essere usati i nodi della macchina virtuale.
Si tratta del modulo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints

string[]

I taints aggiunti ai nuovi nodi durante la creazione e la scalabilità del pool di nodi. Ad esempio, key=value:NoSchedule.
properties.orchestratorVersion

string

Versione di Kubernetes specificata dall'utente.
Sono supportate entrambe le versioni <patch major.minor.patch> (ad esempio 1.20.13) e <major.minor> (ad esempio 1.20). Quando <viene specificato major.minor> , viene scelta automaticamente la versione più recente della patch ga supportata. L'aggiornamento del cluster con lo stesso <major.minor> una volta creato (ad esempio 1.14.x -> 1.14) non attiverà un aggiornamento, anche se è disponibile una versione di patch più recente. Come procedura consigliata, è consigliabile aggiornare tutti i pool di nodi in un cluster del servizio Azure Kubernetes alla stessa versione di Kubernetes. La versione del pool di nodi deve avere la stessa versione principale del piano di controllo. La versione secondaria del pool di nodi deve essere inclusa in due versioni secondarie della versione del piano di controllo. La versione del pool di nodi non può essere maggiore della versione del piano di controllo. Per altre informazioni, vedere Aggiornamento di un pool di nodi.
properties.osDiskSizeGB

integer

Dimensioni disco del sistema operativo in GB da usare per specificare le dimensioni del disco per ogni computer nel pool master/agente. Se si specifica 0, verrà applicata la dimensione osDisk predefinita in base alla vmSize specificata.
properties.osDiskType

OSDiskType

Tipo di disco del sistema operativo da usare per i computer nel pool di agenti.
Il valore predefinito è "Ephemeral" se la macchina virtuale la supporta e ha un disco della cache maggiore di OSDiskSizeGB richiesto. In caso contrario, il valore predefinito è "Gestito". Non può essere modificato dopo la creazione. Per altre informazioni, vedere Sistema operativo temporaneo.
properties.osSKU

OSSKU

Specifica lo SKU del sistema operativo usato dal pool di agenti. Il valore predefinito è Ubuntu se OSType è Linux. Il valore predefinito è Windows2019 quando Kubernetes = 1.24 o Windows2022 quando Kubernetes <>= 1.25 se OSType è Windows.
properties.osType

OSType

Tipo di sistema operativo. Il valore predefinito è Linux.
properties.podSubnetID

string

ID della subnet a cui verranno aggiunti i pod al momento dell'avvio.
Se omesso, gli INDIRIZZI IP pod vengono assegnati staticamente nella subnet del nodo (vedere vnetSubnetID per altri dettagli). Si tratta del modulo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState

PowerState

Indica se il pool di agenti è in esecuzione o arrestato.
Quando viene creato inizialmente un pool di agenti, viene eseguito inizialmente. Il pool di agenti può essere arrestato impostando questo campo su Arrestato. Un pool di agenti arrestato arresta tutte le macchine virtuali e non accumula addebiti di fatturazione. Un pool di agenti può essere arrestato solo se è in esecuzione e lo stato di provisioning è Riuscito
properties.proximityPlacementGroupID

string

ID per il gruppo di posizionamento di prossimità.
properties.scaleDownMode

ScaleDownMode

Modalità di ridimensionamento da usare durante il ridimensionamento del pool di agenti.
Ciò influisce anche sul comportamento del ridimensionamento automatico del cluster. Se non specificato, il valore predefinito viene eliminato.
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Criteri di rimozione del set di scalabilità di macchine virtuali da usare.
Non è possibile specificare a meno che la scalaSetPriority non sia "Spot". Se non specificato, il valore predefinito è "Delete".
properties.scaleSetPriority

ScaleSetPriority

Priorità del set di scalabilità di macchine virtuali. Se non specificato, il valore predefinito è "Regular".
properties.spotMaxPrice

number

Il prezzo massimo (in dollari statunitensi) è disposto a pagare per le istanze spot. I valori possibili sono un valore decimale maggiore di zero o -1, che indica che il prezzo predefinito deve essere aggiornato a su richiesta.
I valori possibili sono un valore decimale maggiore di zero o -1 che indica la disponibilità a pagare qualsiasi prezzo su richiesta. Per altre informazioni sui prezzi spot, vedere prezzi delle macchine virtuali spot
properties.tags

object

I tag da rendere persistenti nel set di scalabilità di macchine virtuali del pool di agenti.
properties.type

AgentPoolType

Tipo di pool di agenti.
properties.upgradeSettings

AgentPoolUpgradeSettings

Impostazioni per l'aggiornamento del agentpool
properties.vmSize

string

Dimensioni delle macchine virtuali del pool di agenti.
La disponibilità delle dimensioni della macchina virtuale varia in base all'area. Se un nodo contiene risorse di calcolo insufficienti (memoria, CPU e così via) i pod potrebbero non essere eseguiti correttamente. Per altri dettagli sulle dimensioni delle macchine virtuali con restrizioni, vedere: https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID

string

ID della subnet a cui verranno aggiunti i nodi del pool di agenti e facoltativamente i pod all'avvio.
Se non viene specificato, verrà generata e usata una rete virtuale e una subnet. Se non viene specificato alcun podSubnetID, questo vale per nodi e pod, in caso contrario si applica solo ai nodi. Modulo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile

AgentPoolWindowsProfile

Profilo specifico del pool di agenti di Windows.
properties.workloadRuntime

WorkloadRuntime

Determina il tipo di carico di lavoro che un nodo può eseguire.

Risposte

Nome Tipo Descrizione
200 OK

AgentPool

Il pool di agenti esistente è stato aggiornato correttamente.
201 Created

AgentPool

Il nuovo pool di agenti è stato creato correttamente.
Other Status Codes

CloudError

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Create Agent Pool using an agent pool snapshot
Create Agent Pool with Capacity Reservation Group
Create Agent Pool with Dedicated Host Group
Create Agent Pool with EncryptionAtHost enabled
Create Agent Pool with Ephemeral OS Disk
Create Agent Pool with FIPS enabled OS
Create Agent Pool with GPUMIG
Create Agent Pool with Krustlet and the WASI runtime
Create Agent Pool with KubeletConfig and LinuxOSConfig
Create Agent Pool with OSSKU
Create Agent Pool with PPG
Create Agent Pool with UltraSSD enabled
Create Agent Pool with Windows OSSKU
Create Spot Agent Pool
Create Windows Agent Pool with disabling OutboundNAT
Create/Update Agent Pool
Start Agent Pool
Stop Agent Pool
Update Agent Pool

Create Agent Pool using an agent pool snapshot

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableFIPS": true,
    "creationData": {
      "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true,
    "creationData": {
      "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true,
    "creationData": {
      "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
    }
  }
}

Create Agent Pool with Capacity Reservation Group

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1"
  }
}

Create Agent Pool with Dedicated Host Group

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
  }
}

Create Agent Pool with EncryptionAtHost enabled

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableEncryptionAtHost": true
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableEncryptionAtHost": true
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableEncryptionAtHost": true
  }
}

Create Agent Pool with Ephemeral OS Disk

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osDiskType": "Ephemeral",
    "osDiskSizeGB": 64
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskType": "Ephemeral",
    "osDiskSizeGB": 64
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskType": "Ephemeral",
    "kubeletDiskType": "OS",
    "osDiskSizeGB": 64
  }
}

Create Agent Pool with FIPS enabled OS

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableFIPS": true
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true
  }
}

Create Agent Pool with GPUMIG

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_ND96asr_v4",
    "osType": "Linux",
    "gpuInstanceProfile": "MIG2g",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_ND96asr_v4",
    "maxPods": 110,
    "osType": "Linux",
    "gpuInstanceProfile": "MIG2g",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_ND96asr_v4",
    "maxPods": 110,
    "osType": "Linux",
    "gpuInstanceProfile": "MIG2g",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false,
      "podMaxPids": 100
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 65536,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Create Agent Pool with Krustlet and the WASI runtime

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "workloadRuntime": "WasmWasi"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "workloadRuntime": "WasmWasi"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "workloadRuntime": "WasmWasi"
  }
}

Create Agent Pool with KubeletConfig and LinuxOSConfig

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false,
      "podMaxPids": 100
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 65536,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Create Agent Pool with OSSKU

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osSKU": "AzureLinux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osSKU": "AzureLinux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osSKU": "AzureLinux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false,
      "podMaxPids": 100
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 65536,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Create Agent Pool with PPG

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
  }
}

Create Agent Pool with UltraSSD enabled

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableUltraSSD": true
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableUltraSSD": true
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableUltraSSD": true
  }
}

Create Agent Pool with Windows OSSKU

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "1.23.3",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "osType": "Windows",
    "osSKU": "Windows2022"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "wnp2",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.23.3",
    "currentOrchestratorVersion": "1.23.3",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "maxPods": 110,
    "osType": "Windows",
    "osSKU": "Windows2022"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "wnp2",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.23.3",
    "currentOrchestratorVersion": "1.23.3",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "maxPods": 110,
    "osType": "Windows",
    "osSKU": "Windows2022"
  }
}

Create Spot Agent Pool

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "spotMaxPrice": -1
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "spotMaxPrice": -1
  }
}

Create Windows Agent Pool with disabling OutboundNAT

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "1.23.8",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "osType": "Windows",
    "osSKU": "Windows2022",
    "windowsProfile": {
      "disableOutboundNat": true
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "wnp2",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.23.8",
    "currentOrchestratorVersion": "1.23.8",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "maxPods": 110,
    "osType": "Windows",
    "osSKU": "Windows2022",
    "windowsProfile": {
      "disableOutboundNat": true
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "wnp2",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.23.8",
    "currentOrchestratorVersion": "1.23.8",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "maxPods": 110,
    "osType": "Windows",
    "osSKU": "Windows2022",
    "windowsProfile": {
      "disableOutboundNat": true
    }
  }
}

Create/Update Agent Pool

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "mode": "User"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "mode": "User",
    "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "mode": "User"
  }
}

Start Agent Pool

Sample Request

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

{
  "properties": {
    "powerState": {
      "code": "Running"
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Starting",
    "count": 50,
    "enableAutoScaling": true,
    "minCount": 3,
    "maxCount": 55,
    "powerState": {
      "code": "Running"
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Starting",
    "count": 50,
    "enableAutoScaling": true,
    "minCount": 3,
    "maxCount": 55,
    "powerState": {
      "code": "Running"
    }
  }
}

Stop Agent Pool

Sample Request

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

{
  "properties": {
    "powerState": {
      "code": "Stopped"
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Stopping",
    "count": 0,
    "enableAutoScaling": false,
    "minCount": null,
    "maxCount": null,
    "powerState": {
      "code": "Stopped"
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Stopping",
    "count": 0,
    "enableAutoScaling": false,
    "minCount": null,
    "maxCount": null,
    "powerState": {
      "code": "Stopped"
    }
  }
}

Update Agent Pool

Sample Request

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "enableAutoScaling": true,
    "minCount": 2,
    "maxCount": 2,
    "vmSize": "Standard_DS1_v2",
    "osType": "Linux",
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "enableAutoScaling": true,
    "minCount": 2,
    "maxCount": 2,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Updating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "enableAutoScaling": true,
    "minCount": 2,
    "maxCount": 2,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

Definizioni

Nome Descrizione
AgentPool

Pool di agenti.
AgentPoolMode

Modalità di un pool di agenti.
AgentPoolNetworkProfile

Impostazioni di rete di un pool di agenti.
AgentPoolType

Tipo di pool di agenti.
AgentPoolUpgradeSettings

Impostazioni per l'aggiornamento di un agentpool
AgentPoolWindowsProfile

Profilo specifico del pool di agenti di Windows.
CloudError

Risposta di errore dal servizio Contenitore.
CloudErrorBody

Risposta di errore dal servizio Contenitore.
code

Indica se il cluster è in esecuzione o arrestato
CreationData

Dati usati durante la creazione di una risorsa di destinazione da una risorsa di origine.
GPUInstanceProfile

GPUInstanceProfile da usare per specificare il profilo di istanza MIG della GPU per lo SKU della macchina virtuale GPU supportato.
IPTag

Contiene l'IPTag associato all'oggetto .
KubeletConfig

Configurazioni kubelet dei nodi dell'agente.
KubeletDiskType

Determina il posizionamento dei volumi emptyDir, della radice dei dati del runtime del contenitore e dell'archiviazione temporanea kubelet.
LinuxOSConfig

Configurazioni del sistema operativo dei nodi dell'agente Linux.
OSDiskType

Tipo di disco del sistema operativo da usare per i computer nel pool di agenti.
OSSKU

Specifica lo SKU del sistema operativo usato dal pool di agenti. Il valore predefinito è Ubuntu se OSType è Linux. Il valore predefinito è Windows2019 quando Kubernetes <= 1.24 o Windows2022 quando Kubernetes >= 1.25 se OSType è Windows.
OSType

Tipo di sistema operativo. Il valore predefinito è Linux.
PortRange

Intervallo di porte.
PowerState

Descrive lo stato di Alimentazione del cluster
Protocol

Protocollo di rete della porta.
ScaleDownMode

Descrive il modo in cui le macchine virtuali vengono aggiunte o rimosse dai pool di agenti. Vedere stati di fatturazione.
ScaleSetEvictionPolicy

Criterio di rimozione del set di scalabilità di macchine virtuali.
ScaleSetPriority

Priorità del set di scalabilità di macchine virtuali.
SysctlConfig

Impostazioni sysctl per i nodi dell'agente Linux.
WorkloadRuntime

Determina il tipo di carico di lavoro che un nodo può eseguire.

AgentPool

Pool di agenti.

Nome Tipo Valore predefinito Descrizione
id

string

ID risorsa.
name

string

Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.availabilityZones

string[]

Elenco delle zone di disponibilità da usare per i nodi. Questa opzione può essere specificata solo se la proprietà AgentPoolType è "VirtualMachineScaleSets".
properties.capacityReservationGroupID

string

ID risorsa completo del gruppo di prenotazioni della capacità per fornire macchine virtuali da un gruppo riservato di Macchine virtuali.
Il servizio Azure Kubernetes associa il pool di agenti specificato al gruppo di prenotazioni di capacità.
properties.count

integer

Numero di agenti (VM) per ospitare contenitori docker. I valori consentiti devono trovarsi nell'intervallo compreso tra 0 e 1000 (incluso) per i pool di utenti e nell'intervallo compreso tra 1 e 1000 (inclusivo) per i pool di sistema. Il valore predefinito è 1.
properties.creationData

CreationData

CreationData da usare per specificare l'ID snapshot di origine se il pool di nodi verrà creato/aggiornato usando uno snapshot.
properties.currentOrchestratorVersion

string

La versione di Kubernetes del pool di agenti è in esecuzione.
Se orchestratorVersion è una versione <completamente specificata major.minor.patch>, questo campo sarà esattamente uguale a esso. Se orchestratorVersion è <major.minor, questo campo conterrà la versione principale.minor.patch>> completa <usata.
properties.enableAutoScaling

boolean

Se abilitare il ridimensionamento automatico
properties.enableEncryptionAtHost

boolean

Se abilitare la crittografia del sistema operativo e dell'unità dati basata su host.
Questa funzionalità è supportata solo in determinate dimensioni della macchina virtuale e in determinate aree di Azure. Per altre informazioni, vedere: https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS

boolean

Se usare un sistema operativo abilitato per FIPS.
Per altre informazioni, vedere Aggiungere un pool di nodi abilitato per FIPS .
properties.enableNodePublicIP

boolean

Se ogni nodo viene allocato un indirizzo IP pubblico.
Alcuni scenari possono richiedere nodi in un pool di nodi per ricevere i propri indirizzi IP pubblici dedicati. Uno scenario comune è per i carichi di lavoro di gioco, in cui una console deve creare una connessione diretta a una macchina virtuale cloud per ridurre al minimo gli hop. Per altre informazioni, vedere l'assegnazione di un indirizzo IP pubblico per nodo. Il valore predefinito è false.
properties.enableUltraSSD

boolean

Se abilitare UltraSSD
properties.gpuInstanceProfile

GPUInstanceProfile

GPUInstanceProfile da usare per specificare il profilo di istanza DI GPU MIG per lo SKU della macchina virtuale GPU supportato.
properties.hostGroupID

string

ID risorsa completo del gruppo host dedicato per effettuare il provisioning di macchine virtuali da, usato solo nello scenario di creazione e non consentito di modificare una volta impostato.
Si tratta del modulo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Per altre informazioni, vedere Host dedicati di Azure.
properties.kubeletConfig

KubeletConfig

Configurazioni kubelet dei nodi dell'agente.
Configurazione di Kubelet nei nodi del pool di agenti.
properties.kubeletDiskType

KubeletDiskType

Determina il posizionamento di volumi vuotiDir, radice dei dati del runtime del contenitore e archiviazione temporanea kubelet.
properties.linuxOSConfig

LinuxOSConfig

Configurazioni del sistema operativo dei nodi dell'agente Linux.
Configurazione del sistema operativo dei nodi dell'agente Linux.
properties.maxCount

integer

Numero massimo di nodi per il ridimensionamento automatico
properties.maxPods

integer

Numero massimo di pod che possono essere eseguiti in un nodo.
properties.minCount

integer

Numero minimo di nodi per il ridimensionamento automatico
properties.mode

AgentPoolMode

Modalità di un pool di agenti.
Un cluster deve avere almeno un pool di agenti "System" in ogni momento. Per altre informazioni sulle restrizioni del pool di agenti e sulle procedure consigliate, vedere: https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile

AgentPoolNetworkProfile

Impostazioni correlate alla rete di un pool di agenti.
properties.nodeImageVersion

string

Versione dell'immagine del nodo
properties.nodeLabels

object

Le etichette dei nodi da rendere persistenti in tutti i nodi nel pool di agenti.
properties.nodePublicIPPrefixID

string

ID prefisso IP pubblico da cui devono essere usati i nodi della macchina virtuale.
Si tratta del modulo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints

string[]

I taints aggiunti ai nuovi nodi durante la creazione e la scalabilità del pool di nodi. Ad esempio, key=value:NoSchedule.
properties.orchestratorVersion

string

Versione di Kubernetes specificata dall'utente.
Sono supportate entrambe le versioni <patch major.minor.patch> (ad esempio 1.20.13) e <major.minor> (ad esempio 1.20). Quando <viene specificato major.minor> , viene scelta automaticamente la versione più recente della patch ga supportata. L'aggiornamento del cluster con lo stesso <major.minor> una volta creato (ad esempio 1.14.x -> 1.14) non attiverà un aggiornamento, anche se è disponibile una versione di patch più recente. Come procedura consigliata, è consigliabile aggiornare tutti i pool di nodi in un cluster del servizio Azure Kubernetes alla stessa versione di Kubernetes. La versione del pool di nodi deve avere la stessa versione principale del piano di controllo. La versione secondaria del pool di nodi deve essere inclusa in due versioni secondarie della versione del piano di controllo. La versione del pool di nodi non può essere maggiore della versione del piano di controllo. Per altre informazioni, vedere Aggiornamento di un pool di nodi.
properties.osDiskSizeGB

integer

Dimensioni del disco del sistema operativo in GB da usare per specificare le dimensioni del disco per ogni computer nel pool master/agent. Se si specifica 0, verrà applicata la dimensione osDisk predefinita in base alla vmSize specificata.
properties.osDiskType

OSDiskType

Tipo di disco del sistema operativo da usare per i computer nel pool di agenti.
Il valore predefinito è "Ephemeral" se la macchina virtuale lo supporta e ha un disco della cache più grande rispetto a OSDiskSizeGB richiesto. In caso contrario, il valore predefinito è "Managed". Potrebbe non essere modificato dopo la creazione. Per altre informazioni, vedere Sistema operativo temporaneo.
properties.osSKU

OSSKU

Specifica lo SKU del sistema operativo usato dal pool di agenti. Il valore predefinito è Ubuntu se OSType è Linux. Il valore predefinito è Windows2019 quando Kubernetes = 1.24 o Windows2022 quando Kubernetes <>= 1.25 se OSType è Windows.
properties.osType

OSType

Linux

Tipo di sistema operativo. Il valore predefinito è Linux.
properties.podSubnetID

string

ID della subnet a cui verranno aggiunti i pod al momento dell'avvio.
Se omesso, gli INDIRIZZI IP pod vengono assegnati staticamente nella subnet del nodo (vedere vnetSubnetID per altri dettagli). Si tratta del modulo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState

PowerState

Indica se il pool di agenti è in esecuzione o arrestato.
Quando viene creato inizialmente un pool di agenti, viene eseguito inizialmente. Il pool di agenti può essere arrestato impostando questo campo su Arrestato. Un pool di agenti arrestato arresta tutte le macchine virtuali e non accumula addebiti di fatturazione. Un pool di agenti può essere arrestato solo se è in esecuzione e lo stato di provisioning è Riuscito
properties.provisioningState

string

Stato di distribuzione o provisioning corrente.
properties.proximityPlacementGroupID

string

ID per il gruppo di posizionamento di prossimità.
properties.scaleDownMode

ScaleDownMode

Modalità di ridimensionamento da usare durante il ridimensionamento del pool di agenti.
Ciò influisce anche sul comportamento del ridimensionamento automatico del cluster. Se non specificato, il valore predefinito viene eliminato.
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Delete

Criteri di rimozione del set di scalabilità di macchine virtuali da usare.
Non è possibile specificare a meno che la scalaSetPriority non sia "Spot". Se non specificato, il valore predefinito è "Delete".
properties.scaleSetPriority

ScaleSetPriority

Regular

Priorità del set di scalabilità di macchine virtuali. Se non specificato, il valore predefinito è "Regular".
properties.spotMaxPrice

number

-1

Il prezzo massimo (in dollari statunitensi) è disposto a pagare per le istanze spot. I valori possibili sono un valore decimale maggiore di zero o -1, che indica che il prezzo predefinito deve essere aggiornato a su richiesta.
I valori possibili sono un valore decimale maggiore di zero o -1 che indica la disponibilità a pagare qualsiasi prezzo su richiesta. Per altre informazioni sui prezzi spot, vedere prezzi delle macchine virtuali spot
properties.tags

object

I tag da rendere persistenti nel set di scalabilità di macchine virtuali del pool di agenti.
properties.type

AgentPoolType

Tipo di pool di agenti.
properties.upgradeSettings

AgentPoolUpgradeSettings

Impostazioni per l'aggiornamento del agentpool
properties.vmSize

string

Dimensioni delle macchine virtuali del pool di agenti.
La disponibilità delle dimensioni della macchina virtuale varia in base all'area. Se un nodo contiene risorse di calcolo insufficienti (memoria, CPU e così via) i pod potrebbero non riuscire a essere eseguiti correttamente. Per altre informazioni sulle dimensioni della macchina virtuale con restrizioni, vedere: https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID

string

ID della subnet in cui vengono aggiunti i nodi del pool di agenti e facoltativamente i pod all'avvio.
Se non viene specificato, verrà generata e usata una rete virtuale e una subnet. Se non viene specificato alcun podSubnetID, questo vale per i nodi e i pod, in caso contrario si applica solo ai nodi. Si tratta del modulo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile

AgentPoolWindowsProfile

Profilo specifico del pool di agenti di Windows.
properties.workloadRuntime

WorkloadRuntime

Determina il tipo di carico di lavoro che un nodo può eseguire.
type

string

Tipo di risorsa

AgentPoolMode

Modalità di un pool di agenti.

Nome Tipo Descrizione
System

string

I pool di agenti di sistema sono principalmente per l'hosting di pod di sistema critici, ad esempio CoreDNS e metrics-server. I pool di agenti di sistema osType devono essere Linux. Lo SKU della macchina virtuale dei pool di agenti di sistema deve avere almeno 2 vCPU e 4 GB di memoria.
User

string

I pool di agenti utente sono principalmente per ospitare i pod dell'applicazione.

AgentPoolNetworkProfile

Impostazioni di rete di un pool di agenti.

Nome Tipo Descrizione
allowedHostPorts

PortRange[]

Intervalli di porte consentiti per l'accesso. Gli intervalli specificati possono sovrapporsi.
applicationSecurityGroups

string[]

ID dei gruppi di sicurezza dell'applicazione associati al pool di agenti al momento della creazione.
nodePublicIPTags

IPTag[]

IPTag di indirizzi IP pubblici a livello di istanza.

AgentPoolType

Tipo di pool di agenti.

Nome Tipo Descrizione
AvailabilitySet

string

L'uso di questo è fortemente sconsigliato.
VirtualMachineScaleSets

string

Creare un pool di agenti supportato da un set di scalabilità di macchine virtuali.

AgentPoolUpgradeSettings

Impostazioni per l'aggiornamento di un agentpool

Nome Tipo Descrizione
drainTimeoutInMinutes

integer

Timeout di scarico per un nodo
Tempo di attesa (in minuti) per l'eliminazione dei pod e la terminazione grazia per ogni nodo. Questo tempo di attesa di rimozione rispetta l'attesa sui budget di interruzione del pod. Se questa volta viene superata, l'aggiornamento ha esito negativo. Se non specificato, il valore predefinito è di 30 minuti.
maxSurge

string

Numero massimo o percentuale di nodi che vengono distribuiti durante l'aggiornamento.
Può essere impostato su un intero (ad esempio '5') o una percentuale (ad esempio '50%'). Se viene specificata una percentuale, è la percentuale delle dimensioni totali del pool di agenti al momento dell'aggiornamento. Per le percentuali, i nodi frazionari vengono arrotondati. Se non specificato, il valore predefinito è 1. Per altre informazioni, incluse le procedure consigliate, vedere: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade
nodeSoakDurationInMinutes

integer

Durata di immersione per un nodo
Quantità di tempo (in minuti) da attendere dopo aver svuotato un nodo e prima di riimagarlo e passare al nodo successivo. Se non specificato, il valore predefinito è 0 minuti.

AgentPoolWindowsProfile

Profilo specifico del pool di agenti di Windows.

Nome Tipo Descrizione
disableOutboundNat

boolean

Se disabilitare OutboundNAT nei nodi windows
Il valore predefinito è false. NAT in uscita può essere disabilitato solo se il cluster in uscita è gateway NAT e il pool di agenti Windows non dispone di un indirizzo IP pubblico del nodo abilitato.

CloudError

Risposta di errore dal servizio Contenitore.

Nome Tipo Descrizione
error

CloudErrorBody

Dettagli sull'errore.

CloudErrorBody

Risposta di errore dal servizio Contenitore.

Nome Tipo Descrizione
code

string

Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details

CloudErrorBody[]

Elenco di dettagli aggiuntivi sull'errore.
message

string

Messaggio che descrive l'errore, che deve essere adatto per la visualizzazione in un'interfaccia utente.
target

string

Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

code

Indica se il cluster è in esecuzione o arrestato

Nome Tipo Descrizione
Running

string

Il cluster è in esecuzione.
Stopped

string

Il cluster viene arrestato.

CreationData

Dati usati durante la creazione di una risorsa di destinazione da una risorsa di origine.

Nome Tipo Descrizione
sourceResourceId

string

Si tratta dell'ID ARM dell'oggetto di origine da usare per creare l'oggetto di destinazione.

GPUInstanceProfile

GPUInstanceProfile da usare per specificare il profilo di istanza MIG della GPU per lo SKU della macchina virtuale GPU supportato.

Nome Tipo Descrizione
MIG1g

string

MIG2g

string

MIG3g

string

MIG4g

string

MIG7g

string

IPTag

Contiene l'IPTag associato all'oggetto .

Nome Tipo Descrizione
ipTagType

string

Tipo di tag IP. Esempio: RoutingPreference.
tag

string

Valore del tag IP associato all'indirizzo IP pubblico. Esempio: Internet.

KubeletConfig

Configurazioni kubelet dei nodi dell'agente.

Nome Tipo Descrizione
allowedUnsafeSysctls

string[]

Elenco consentito di sysctls non sicuri o criteri sysctl non sicuri (che terminano in *).
containerLogMaxFiles

integer

Numero massimo di file di log del contenitore che possono essere presenti per un contenitore. Il numero deve essere ≥ 2.
containerLogMaxSizeMB

integer

Dimensioni massime (ad esempio 10Mi) del file di log del contenitore prima della rotazione.
cpuCfsQuota

boolean

Se l'applicazione della quota CFS della CPU è abilitata per i contenitori che specificano i limiti della CPU.
Il valore predefinito è true.
cpuCfsQuotaPeriod

string

Valore del periodo di quota CPU CFS.
Il valore predefinito è '100ms'. I valori validi sono una sequenza di numeri decimali con una frazione facoltativa e un suffisso unitario. Ad esempio: '300ms', '2h45m'. Le unità supportate sono 'ns', 'us', 'ms', 's', 'm'e 'h'.
cpuManagerPolicy

string

Criteri di Gestione CPU da usare.
Il valore predefinito è 'nessuno'. Per altre informazioni, vedere Criteri di gestione della CPU Kubernetes . I valori consentiti sono 'nessuno' e 'static'.
failSwapOn

boolean

Se impostato su true, il valore Kubelet avrà esito negativo se lo scambio è abilitato nel nodo.
imageGcHighThreshold

integer

Percentuale di utilizzo del disco dopo cui viene sempre eseguita l'immagine Garbage Collection.
Per disabilitare la Garbage Collection delle immagini, impostare su 100. Il valore predefinito è 85%
imageGcLowThreshold

integer

Percentuale di utilizzo del disco prima dell'esecuzione di Garbage Collection dell'immagine.
Impossibile impostare un valore superiore a imageGcHighThreshold. Il valore predefinito è 80%
podMaxPids

integer

Numero massimo di processi per pod.
topologyManagerPolicy

string

Criteri di Gestione topologia da usare.
Per altre informazioni, vedere Gestione topologia Kubernetes. Il valore predefinito è 'nessuno'. I valori consentiti sono 'nessuno', 'best-effort', 'restricted' e 'single-numa-node'.

KubeletDiskType

Determina il posizionamento dei volumi emptyDir, della radice dei dati del runtime del contenitore e dell'archiviazione temporanea kubelet.

Nome Tipo Descrizione
OS

string

Kubelet userà il disco del sistema operativo per i dati.
Temporary

string

Kubelet userà il disco temporaneo per i dati.

LinuxOSConfig

Configurazioni del sistema operativo dei nodi dell'agente Linux.

Nome Tipo Descrizione
swapFileSizeMB

integer

Dimensioni in MB di un file di scambio che verrà creato in ogni nodo.
sysctls

SysctlConfig

Impostazioni sysctl per i nodi dell'agente Linux.
transparentHugePageDefrag

string

Se il kernel deve usare aggressiva la compattazione della memoria per rendere disponibili più enormi pagine.
I valori validi sono 'always', 'defer', 'defer+madvise', 'madvise' e 'never'. Il valore predefinito è "madvise". Per altre informazioni, vedere Transparent Hugepages.
transparentHugePageEnabled

string

Se le enormi pagine trasparenti sono abilitate.
I valori validi sono 'always', 'madvise' e 'never'. Il valore predefinito è "sempre". Per altre informazioni, vedere Transparent Hugepages.

OSDiskType

Tipo di disco del sistema operativo da usare per i computer nel pool di agenti.

Nome Tipo Descrizione
Ephemeral

string

I dischi temporanei del sistema operativo vengono archiviati solo nel computer host, proprio come un disco temporaneo. Ciò garantisce una latenza di lettura/scrittura inferiore, oltre a un ridimensionamento dei nodi e aggiornamenti del cluster più rapidi.
Managed

string

Azure replica il disco del sistema operativo per una macchina virtuale in Archiviazione di Azure per evitare la perdita di dati se la macchina virtuale deve essere spostata in un altro host. Poiché i contenitori non sono progettati per rendere persistente lo stato locale, questo comportamento offre un valore limitato, fornendo alcuni svantaggi, tra cui il provisioning dei nodi più lento e una latenza di lettura/scrittura superiore.

OSSKU

Specifica lo SKU del sistema operativo usato dal pool di agenti. Il valore predefinito è Ubuntu se OSType è Linux. Il valore predefinito è Windows2019 quando Kubernetes <= 1.24 o Windows2022 quando Kubernetes >= 1.25 se OSType è Windows.

Nome Tipo Descrizione
AzureLinux

string

Usare AzureLinux come sistema operativo per le immagini del nodo. Linux di Azure è una distribuzione Linux ottimizzata per i contenitori creata da Microsoft. Per altre informazioni, vedere https://aka.ms/azurelinux .
CBLMariner

string

OSSKU deprecato. Microsoft consiglia di scegliere invece "AzureLinux" per le nuove distribuzioni.
Ubuntu

string

Usare Ubuntu come sistema operativo per le immagini dei nodi.
Windows2019

string

Usare Windows2019 come sistema operativo per le immagini del nodo. Non supportato per i pool di nodi di sistema. Windows2019 supporta solo i contenitori Windows2019; non può eseguire contenitori Windows2022 e viceversa.
Windows2022

string

Usare Windows2022 come sistema operativo per le immagini del nodo. Non supportato per i pool di nodi di sistema. Windows2022 supporta solo contenitori Windows2022; non può eseguire contenitori Windows2019 e viceversa.

OSType

Tipo di sistema operativo. Il valore predefinito è Linux.

Nome Tipo Descrizione
Linux

string

Usare Linux.
Windows

string

Usare Windows.

PortRange

Intervallo di porte.

Nome Tipo Descrizione
portEnd

integer

Porta massima inclusa nell'intervallo. Deve essere compreso tra 1 e 65535 e deve essere maggiore o uguale a portStart.
portStart

integer

Porta minima inclusa nell'intervallo. Deve essere compreso tra 1 e 65535 e deve essere minore o uguale a portEnd.
protocol

Protocol

Protocollo di rete della porta.

PowerState

Descrive lo stato di Alimentazione del cluster

Nome Tipo Descrizione
code

code

Indica se il cluster è in esecuzione o arrestato

Protocol

Protocollo di rete della porta.

Nome Tipo Descrizione
TCP

string

Protocollo TCP.
UDP

string

Protocollo UDP.

ScaleDownMode

Descrive il modo in cui le macchine virtuali vengono aggiunte o rimosse dai pool di agenti. Vedere stati di fatturazione.

Nome Tipo Descrizione
Deallocate

string

Tentare di avviare istanze deallocate (se esistenti) durante l'aumento e la deallocazione delle istanze durante la riduzione delle prestazioni.
Delete

string

Creare nuove istanze durante l'aumento e la rimozione di istanze durante la riduzione delle prestazioni.

ScaleSetEvictionPolicy

Criterio di rimozione del set di scalabilità di macchine virtuali.

Nome Tipo Descrizione
Deallocate

string

I nodi nel set di scalabilità sottostante del pool di nodi vengono impostati sullo stato arrestato-deallocato in caso di rimozione. I nodi nel conteggio dello stato deallocato arrestato rispetto alla quota di calcolo e possono causare problemi con il ridimensionamento o l'aggiornamento del cluster.
Delete

string

I nodi nel set di scalabilità sottostante del pool di nodi vengono eliminati quando vengono rimossi.

ScaleSetPriority

Priorità del set di scalabilità di macchine virtuali.

Nome Tipo Descrizione
Regular

string

Verranno usate le normali macchine virtuali.
Spot

string

Verranno usate macchine virtuali con priorità spot. Non esiste alcun contratto di servizio per i nodi spot. Per altre informazioni , vedere spot nel servizio Azure Kubernetes .

SysctlConfig

Impostazioni sysctl per i nodi dell'agente Linux.

Nome Tipo Descrizione
fsAioMaxNr

integer

Impostazione sysctl fs.aio-max-nr.
fsFileMax

integer

Impostazione sysctl fs.file-max.
fsInotifyMaxUserWatches

integer

Impostazione sysctl fs.inotify.max_user_watches.
fsNrOpen

integer

Impostazione sysctl fs.nr_open.
kernelThreadsMax

integer

Impostazione sysctl kernel.threads-max.
netCoreNetdevMaxBacklog

integer

Impostazione sysctl net.core.netdev_max_backlog.
netCoreOptmemMax

integer

Impostazione sysctl net.core.optmem_max.
netCoreRmemDefault

integer

Impostazione sysctl net.core.rmem_default.
netCoreRmemMax

integer

Impostazione sysctl net.core.rmem_max.
netCoreSomaxconn

integer

Impostazione sysctl net.core.somaxconn.
netCoreWmemDefault

integer

Impostazione sysctl net.core.wmem_default.
netCoreWmemMax

integer

Impostazione sysctl net.core.wmem_max.
netIpv4IpLocalPortRange

string

Impostazione sysctl net.ipv4.ip_local_port_range.
netIpv4NeighDefaultGcThresh1

integer

Impostazione sysctl net.ipv4.neigh.default.gc_thresh1.
netIpv4NeighDefaultGcThresh2

integer

Impostazione sysctl net.ipv4.neigh.default.gc_thresh2.
netIpv4NeighDefaultGcThresh3

integer

Impostazione sysctl net.ipv4.neigh.default.gc_thresh3.
netIpv4TcpFinTimeout

integer

Impostazione sysctl net.ipv4.tcp_fin_timeout.
netIpv4TcpKeepaliveProbes

integer

Impostazione sysctl net.ipv4.tcp_keepalive_probes.
netIpv4TcpKeepaliveTime

integer

Impostazione sysctl net.ipv4.tcp_keepalive_time.
netIpv4TcpMaxSynBacklog

integer

Impostazione sysctl net.ipv4.tcp_max_syn_backlog.
netIpv4TcpMaxTwBuckets

integer

Impostazione sysctl net.ipv4.tcp_max_tw_buckets.
netIpv4TcpTwReuse

boolean

Impostazione sysctl net.ipv4.tcp_tw_reuse.
netIpv4TcpkeepaliveIntvl

integer

Impostazione sysctl net.ipv4.tcp_keepalive_intvl.
netNetfilterNfConntrackBuckets

integer

Impostazione sysctl net.netfilter.nf_conntrack_buckets.
netNetfilterNfConntrackMax

integer

Impostazione sysctl net.netfilter.nf_conntrack_max.
vmMaxMapCount

integer

Impostazione sysctl vm.max_map_count.
vmSwappiness

integer

Impostazione sysctl vm.swappiness.
vmVfsCachePressure

integer

Impostazione sysctl vm.vfs_cache_pressure.

WorkloadRuntime

Determina il tipo di carico di lavoro che un nodo può eseguire.

Nome Tipo Descrizione
OCIContainer

string

I nodi useranno Kubelet per eseguire carichi di lavoro di contenitori OCI standard.
WasmWasi

string

I nodi useranno Krustlet per eseguire carichi di lavoro WASM usando il provider WASI (anteprima).