Partager via

Agent Pools - Create Or Update

  • Référence
Service:
AKS
API Version:
2024-02-01

Crée ou met à jour un pool d’agents dans le cluster managé spécifié.

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

Paramètres URI

Nom Dans Obligatoire Type Description
agentPoolName
 path True

string

Nom du pool d’agents.

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

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.
resourceName
 path True

string

Nom de la ressource de cluster managé.

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 de l’abonnement cible. La valeur doit être un UUID.
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Type Description
properties.availabilityZones

string[]

Liste des zones de disponibilité à utiliser pour les nœuds. Cela ne peut être spécifié que si la propriété AgentPoolType est « VirtualMachineScaleSets ».
properties.capacityReservationGroupID

string

ID de ressource complet du groupe de réservations de capacité pour fournir des machines virtuelles à partir d’un groupe réservé de Machines Virtuelles.
AKS associe le pool d’agents spécifié au groupe de réservations de capacité.
properties.count

integer

Nombre d’agents (machines virtuelles) pour héberger des conteneurs Docker. Les valeurs autorisées doivent être comprises entre 0 et 1 000 (inclus) pour les pools d’utilisateurs et dans la plage de 1 à 1 000 (inclus) pour les pools système. La valeur par défaut est 1.
properties.creationData

CreationData

CreationData à utiliser pour spécifier l’ID d’instantané source si le pool de nœuds est créé/mis à niveau à l’aide d’un instantané.
properties.enableAutoScaling

boolean

Activation de la mise à l’échelle automatique
properties.enableEncryptionAtHost

boolean

Indique s’il faut activer le chiffrement du système d’exploitation et du lecteur de données basé sur l’hôte.
Cela est pris en charge uniquement sur certaines tailles de machine virtuelle et dans certaines régions Azure. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS

boolean

Indique s’il faut utiliser un système d’exploitation avec FIPS.
Pour plus d’informations, consultez Ajouter un pool de nœuds avec FIPS .
properties.enableNodePublicIP

boolean

Indique si chaque nœud est alloué à sa propre adresse IP publique.
Certains scénarios peuvent exiger que les nœuds d’un pool de nœuds reçoivent leurs propres adresses IP publiques dédiées. C’est par exemple le cas pour les charges de travail de gaming, où une console doit être directement connectée à une machine virtuelle du cloud afin de réduire les tronçons. Pour plus d’informations, consultez Affectation d’une adresse IP publique par nœud. La valeur par défaut est false.
properties.enableUltraSSD

boolean

Activer UltraSSD
properties.gpuInstanceProfile

GPUInstanceProfile

GPUInstanceProfile à utiliser pour spécifier le profil d’instance MIG GPU pour la référence SKU de machine virtuelle GPU prise en charge.
properties.hostGroupID

string

ID de ressource complet du groupe d’hôtes dédié à partir duquel provisionner des machines virtuelles, utilisé uniquement dans le scénario de création et non autorisé à être modifié une fois défini.
Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Pour plus d’informations, consultez Hôtes dédiés Azure.
properties.kubeletConfig

KubeletConfig

Configurations Kubelet des nœuds de l’agent.
Configuration Kubelet sur les nœuds du pool d’agents.
properties.kubeletDiskType

KubeletDiskType

Détermine l’emplacement des volumes emptyDir, de la racine des données du runtime de conteneur et du stockage éphémère Kubelet.
properties.linuxOSConfig

LinuxOSConfig

Configurations du système d’exploitation des nœuds de l’agent Linux.
Configuration du système d’exploitation des nœuds de l’agent Linux.
properties.maxCount

integer

Nombre maximal de nœuds pour la mise à l’échelle automatique
properties.maxPods

integer

Nombre maximal de pods pouvant s’exécuter sur un nœud.
properties.minCount

integer

Nombre minimal de nœuds pour la mise à l’échelle automatique
properties.mode

AgentPoolMode

Mode d’un pool d’agents.
Un cluster doit avoir au moins un pool d’agents « Système » à tout moment. Pour plus d’informations sur les restrictions de pool d’agents et les meilleures pratiques, consultez : https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile

AgentPoolNetworkProfile

Paramètres liés au réseau d’un pool d’agents.
properties.nodeLabels

object

Étiquettes de nœud à conserver sur tous les nœuds du pool d’agents.
properties.nodePublicIPPrefixID

string

ID de préfixe IP public à partir duquel les nœuds de machine virtuelle doivent utiliser les adresses IP.
Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints

string[]

Les teintes ajoutées aux nouveaux nœuds lors de la création et de la mise à l’échelle du pool de nœuds. Par exemple, key=value :NoSchedule.
properties.orchestratorVersion

string

Version de Kubernetes spécifiée par l’utilisateur.
Les versions <de correctif major.minor.patch> (par exemple, 1.20.13) et <major.minor> (par exemple, 1.20) sont prises en charge. Lorsque <major.minor> est spécifié, la dernière version de correctif en disponibilité générale prise en charge est choisie automatiquement. La mise à jour du cluster avec le même <fichier major.minor> une fois qu’il a été créé (par exemple, 1.14.x -> 1.14) ne déclenche pas de mise à niveau, même si une version corrective plus récente est disponible. En guise de bonne pratique, vous devez mettre à niveau tous les pools de nœuds dans un cluster AKS vers la même version de Kubernetes. La version du pool de nœuds doit avoir la même version principale que le plan de contrôle. La version secondaire du pool de nœuds doit être située à deux versions secondaires de la version du plan de contrôle. La version du pool de nœuds ne peut pas être supérieure à la version du plan de contrôle. Pour plus d’informations, consultez Mise à niveau d’un pool de nœuds.
properties.osDiskSizeGB

integer

Taille du disque du système d’exploitation en Go à utiliser pour spécifier la taille du disque pour chaque ordinateur du pool master/agent. Si vous spécifiez 0, la taille osDisk par défaut est appliquée en fonction de la taille vmSize spécifiée.
properties.osDiskType

OSDiskType

Type de disque de système d’exploitation à utiliser pour les machines du pool d’agents.
La valeur par défaut est « Éphémère » si la machine virtuelle la prend en charge et possède un disque de cache supérieur à l’OSDiskSizeGB demandé. Dans le cas contraire, la valeur par défaut est « Managed ». Peut ne pas être modifié après la création. Pour plus d’informations, consultez Système d’exploitation éphémère.
properties.osSKU

OSSKU

Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est Ubuntu si OSType est Linux. La valeur par défaut est Windows2019 quand Kubernetes <= 1.24 ou Windows2022 quand Kubernetes >= 1.25 si OSType est Windows.
properties.osType

OSType

Type de système d’exploitation. La valeur par défaut est Linux.
properties.podSubnetID

string

ID du sous-réseau auquel les pods seront joints lors du lancement.
En cas d’omission, les adresses IP de pod sont affectées de manière statique sur le sous-réseau du nœud (voir vnetSubnetID pour plus d’informations). Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState

PowerState

Indique si le pool d’agents est en cours d’exécution ou arrêté.
Lorsqu’un pool d’agents est créé pour la première fois, il est initialement en cours d’exécution. Vous pouvez arrêter le pool d’agents en définissant ce champ sur Arrêté. Un pool d’agents arrêté arrête toutes ses machines virtuelles et n’accumule pas de frais de facturation. Un pool d’agents ne peut être arrêté que s’il est en cours d’exécution et si l’état d’approvisionnement est Réussi
properties.proximityPlacementGroupID

string

ID du groupe de placement de proximité.
properties.scaleDownMode

ScaleDownMode

Mode scale-down à utiliser lors de la mise à l’échelle du pool d’agents.
Cela affecte également le comportement du générateur de mise à l’échelle automatique du cluster. S’il n’est pas spécifié, la valeur par défaut est Delete.
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Stratégie d’éviction de groupe de machines virtuelles identiques à utiliser.
Cela ne peut pas être spécifié, sauf si le scaleSetPriority est « Spot ». Si elle n’est pas spécifiée, la valeur par défaut est « Delete ».
properties.scaleSetPriority

ScaleSetPriority

Priorité groupe de machines virtuelles identiques. S’il n’est pas spécifié, la valeur par défaut est « Regular ».
properties.spotMaxPrice

number

Prix maximal (en dollars américains) que vous êtes prêt à payer pour les instances spot. Les valeurs possibles sont toutes les valeurs décimales supérieures à zéro ou -1 qui indiquent que le prix par défaut est à la demande.
Les valeurs possibles sont toutes les valeurs décimales supérieures à zéro ou -1 qui indiquent la volonté de payer n’importe quel prix à la demande. Pour plus d’informations sur la tarification spot, consultez Tarification des machines virtuelles spot
properties.tags

object

Balises à conserver sur le groupe de machines virtuelles identiques du pool d’agents.
properties.type

AgentPoolType

Type de pool d’agents.
properties.upgradeSettings

AgentPoolUpgradeSettings

Paramètres de mise à niveau du pool d’agents
properties.vmSize

string

Taille des machines virtuelles du pool d’agents.
La disponibilité de la taille de machine virtuelle varie selon la région. Si un nœud contient des ressources de calcul insuffisantes (mémoire, processeur, etc.), les pods peuvent ne pas s’exécuter correctement. Pour plus d’informations sur les tailles de machine virtuelle restreintes, consultez : https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID

string

ID du sous-réseau auquel les nœuds de pool d’agents et éventuellement les pods rejoindront au démarrage.
Si ce n’est pas spécifié, un réseau virtuel et un sous-réseau seront générés et utilisés. Si aucun podSubnetID n’est spécifié, cela s’applique aux nœuds et aux pods, sinon, elle s’applique uniquement aux nœuds. Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile

AgentPoolWindowsProfile

Profil spécifique du pool d’agents Windows.
properties.workloadRuntime

WorkloadRuntime

Détermine le type de charge de travail qu’un nœud peut exécuter.

Réponses

Nom Type Description
200 OK

AgentPool

Le pool d’agents existant a été correctement mis à jour.
201 Created

AgentPool

Le nouveau pool d’agents a été créé avec succès.
Other Status Codes

CloudError

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom Description
AgentPool

Pool d’agents.
AgentPoolMode

Mode d’un pool d’agents.
AgentPoolNetworkProfile

Paramètres réseau d’un pool d’agents.
AgentPoolType

Type de pool d’agents.
AgentPoolUpgradeSettings

Paramètres de mise à niveau d’un pool d’agents
AgentPoolWindowsProfile

Profil spécifique du pool d’agents Windows.
CloudError

Réponse d’erreur du service conteneur.
CloudErrorBody

Réponse d’erreur du service conteneur.
code

Indique si le cluster est en cours d’exécution ou arrêté
CreationData

Données utilisées lors de la création d’une ressource cible à partir d’une ressource source.
GPUInstanceProfile

GPUInstanceProfile à utiliser pour spécifier le profil d’instance MIG GPU pour la référence SKU de machine virtuelle GPU prise en charge.
IPTag

Contient l’IPTag associé à l’objet .
KubeletConfig

Configurations Kubelet des nœuds de l’agent.
KubeletDiskType

Détermine l’emplacement des volumes emptyDir, de la racine des données du runtime de conteneur et du stockage éphémère Kubelet.
LinuxOSConfig

Configurations du système d’exploitation des nœuds de l’agent Linux.
OSDiskType

Type de disque de système d’exploitation à utiliser pour les machines du pool d’agents.
OSSKU

Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est Ubuntu si OSType est Linux. La valeur par défaut est Windows2019 quand Kubernetes <= 1.24 ou Windows2022 quand Kubernetes >= 1.25 si OSType est Windows.
OSType

Type de système d’exploitation. La valeur par défaut est Linux.
PortRange

Plage de ports.
PowerState

Décrit l’état d’alimentation du cluster
Protocol

Protocole réseau du port.
ScaleDownMode

Décrit comment les machines virtuelles sont ajoutées ou supprimées des pools d’agents. Consultez États de facturation.
ScaleSetEvictionPolicy

Stratégie d’éviction de groupe de machines virtuelles identiques.
ScaleSetPriority

Priorité groupe de machines virtuelles identiques.
SysctlConfig

Paramètres Sysctl pour les nœuds de l’agent Linux.
WorkloadRuntime

Détermine le type de charge de travail qu’un nœud peut exécuter.

AgentPool

Pool d’agents.

Nom Type Valeur par défaut Description
id

string

ID de la ressource
name

string

Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
properties.availabilityZones

string[]

Liste des zones de disponibilité à utiliser pour les nœuds. Cela ne peut être spécifié que si la propriété AgentPoolType est « VirtualMachineScaleSets ».
properties.capacityReservationGroupID

string

ID de ressource complet du groupe de réservations de capacité pour fournir des machines virtuelles à partir d’un groupe réservé de Machines Virtuelles.
AKS associe le pool d’agents spécifié au groupe de réservations de capacité.
properties.count

integer

Nombre d’agents (machines virtuelles) pour héberger des conteneurs Docker. Les valeurs autorisées doivent être comprises entre 0 et 1 000 (inclus) pour les pools d’utilisateurs et dans la plage de 1 à 1 000 (inclus) pour les pools système. La valeur par défaut est 1.
properties.creationData

CreationData

CreationData à utiliser pour spécifier l’ID d’instantané source si le pool de nœuds est créé/mis à niveau à l’aide d’un instantané.
properties.currentOrchestratorVersion

string

Version de Kubernetes que le pool d’agents exécute.
Si orchestratorVersion est une version <entièrement spécifiée major.minor.patch>, ce champ sera exactement égal à celui-ci. Si orchestratorVersion est <major.minor>, ce champ contient la version complète <de major.minor.patch> utilisée.
properties.enableAutoScaling

boolean

Activation de la mise à l’échelle automatique
properties.enableEncryptionAtHost

boolean

Indique s’il faut activer le chiffrement du système d’exploitation et du lecteur de données basé sur l’hôte.
Cela est pris en charge uniquement sur certaines tailles de machine virtuelle et dans certaines régions Azure. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS

boolean

Indique s’il faut utiliser un système d’exploitation avec FIPS.
Pour plus d’informations, consultez Ajouter un pool de nœuds avec FIPS .
properties.enableNodePublicIP

boolean

Indique si chaque nœud est alloué à sa propre adresse IP publique.
Certains scénarios peuvent exiger que les nœuds d’un pool de nœuds reçoivent leurs propres adresses IP publiques dédiées. C’est par exemple le cas pour les charges de travail de gaming, où une console doit être directement connectée à une machine virtuelle du cloud afin de réduire les tronçons. Pour plus d’informations, consultez Affectation d’une adresse IP publique par nœud. La valeur par défaut est false.
properties.enableUltraSSD

boolean

Activer UltraSSD
properties.gpuInstanceProfile

GPUInstanceProfile

GPUInstanceProfile à utiliser pour spécifier le profil d’instance MIG GPU pour la référence SKU de machine virtuelle GPU prise en charge.
properties.hostGroupID

string

ID de ressource complet du groupe d’hôtes dédié à partir duquel provisionner des machines virtuelles, utilisé uniquement dans le scénario de création et non autorisé à être modifié une fois défini.
Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Pour plus d’informations, consultez Hôtes dédiés Azure.
properties.kubeletConfig

KubeletConfig

Configurations Kubelet des nœuds de l’agent.
Configuration Kubelet sur les nœuds du pool d’agents.
properties.kubeletDiskType

KubeletDiskType

Détermine l’emplacement des volumes emptyDir, de la racine des données du runtime de conteneur et du stockage éphémère Kubelet.
properties.linuxOSConfig

LinuxOSConfig

Configurations du système d’exploitation des nœuds de l’agent Linux.
Configuration du système d’exploitation des nœuds de l’agent Linux.
properties.maxCount

integer

Nombre maximal de nœuds pour la mise à l’échelle automatique
properties.maxPods

integer

Nombre maximal de pods pouvant s’exécuter sur un nœud.
properties.minCount

integer

Nombre minimal de nœuds pour la mise à l’échelle automatique
properties.mode

AgentPoolMode

Mode d’un pool d’agents.
Un cluster doit avoir au moins un pool d’agents « Système » à tout moment. Pour plus d’informations sur les restrictions de pool d’agents et les meilleures pratiques, consultez : https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile

AgentPoolNetworkProfile

Paramètres liés au réseau d’un pool d’agents.
properties.nodeImageVersion

string

Version de l’image de nœud
properties.nodeLabels

object

Étiquettes de nœud à conserver sur tous les nœuds du pool d’agents.
properties.nodePublicIPPrefixID

string

ID de préfixe IP public à partir duquel les nœuds de machine virtuelle doivent utiliser les adresses IP.
Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints

string[]

Les teintes ajoutées aux nouveaux nœuds lors de la création et de la mise à l’échelle du pool de nœuds. Par exemple, key=value :NoSchedule.
properties.orchestratorVersion

string

Version de Kubernetes spécifiée par l’utilisateur.
Les versions <de correctif major.minor.patch> (par exemple, 1.20.13) et <major.minor> (par exemple, 1.20) sont prises en charge. Lorsque <major.minor> est spécifié, la dernière version de correctif en disponibilité générale prise en charge est choisie automatiquement. La mise à jour du cluster avec le même <fichier major.minor> une fois qu’il a été créé (par exemple, 1.14.x -> 1.14) ne déclenche pas de mise à niveau, même si une version corrective plus récente est disponible. En guise de bonne pratique, vous devez mettre à niveau tous les pools de nœuds dans un cluster AKS vers la même version de Kubernetes. La version du pool de nœuds doit avoir la même version principale que le plan de contrôle. La version secondaire du pool de nœuds doit être située à deux versions secondaires de la version du plan de contrôle. La version du pool de nœuds ne peut pas être supérieure à la version du plan de contrôle. Pour plus d’informations, consultez Mise à niveau d’un pool de nœuds.
properties.osDiskSizeGB

integer

Taille du disque du système d’exploitation en Go à utiliser pour spécifier la taille du disque pour chaque ordinateur du pool master/agent. Si vous spécifiez 0, la taille osDisk par défaut est appliquée en fonction de la valeur vmSize spécifiée.
properties.osDiskType

OSDiskType

Type de disque de système d’exploitation à utiliser pour les machines du pool d’agents.
La valeur par défaut est « Éphémère » si la machine virtuelle la prend en charge et a un disque de cache supérieur à l’OSDiskSizeGB demandé. Sinon, la valeur par défaut est « Managed ». Ne peut pas être modifié après la création. Pour plus d’informations, consultez Système d’exploitation éphémère.
properties.osSKU

OSSKU

Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est Ubuntu si OSType est Linux. La valeur par défaut est Windows2019 quand Kubernetes <= 1.24 ou Windows2022 quand Kubernetes >= 1.25 si OSType est Windows.
properties.osType

OSType

Linux

Type de système d’exploitation. La valeur par défaut est Linux.
properties.podSubnetID

string

ID du sous-réseau auquel les pods seront joints lors du lancement.
Si elles sont omises, les adresses IP de pod sont affectées de manière statique sur le sous-réseau de nœud (consultez vnetSubnetID pour plus d’informations). Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState

PowerState

Indique si le pool d’agents est en cours d’exécution ou arrêté.
Lorsqu’un pool d’agents est créé pour la première fois, il est initialement en cours d’exécution. Vous pouvez arrêter le pool d’agents en définissant ce champ sur Arrêté. Un pool d’agents arrêté arrête toutes ses machines virtuelles et n’accumule pas de frais de facturation. Un pool d’agents ne peut être arrêté que s’il est en cours d’exécution et si l’état d’approvisionnement est Réussi
properties.provisioningState

string

État actuel du déploiement ou de l’approvisionnement.
properties.proximityPlacementGroupID

string

ID du groupe de placement de proximité.
properties.scaleDownMode

ScaleDownMode

Mode scale-down à utiliser lors de la mise à l’échelle du pool d’agents.
Cela affecte également le comportement du générateur de mise à l’échelle automatique du cluster. S’il n’est pas spécifié, la valeur par défaut est Delete.
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Delete

Stratégie d’éviction de groupe de machines virtuelles identiques à utiliser.
Cela ne peut pas être spécifié, sauf si le scaleSetPriority est « Spot ». Si elle n’est pas spécifiée, la valeur par défaut est « Delete ».
properties.scaleSetPriority

ScaleSetPriority

Regular

Priorité groupe de machines virtuelles identiques. S’il n’est pas spécifié, la valeur par défaut est « Regular ».
properties.spotMaxPrice

number

-1

Prix maximal (en dollars américains) que vous êtes prêt à payer pour les instances spot. Les valeurs possibles sont toutes les valeurs décimales supérieures à zéro ou -1 qui indiquent que le prix par défaut est à la demande.
Les valeurs possibles sont toutes les valeurs décimales supérieures à zéro ou -1 qui indiquent la volonté de payer n’importe quel prix à la demande. Pour plus d’informations sur la tarification spot, consultez Tarification des machines virtuelles spot
properties.tags

object

Balises à conserver sur le groupe de machines virtuelles identiques du pool d’agents.
properties.type

AgentPoolType

Type de pool d’agents.
properties.upgradeSettings

AgentPoolUpgradeSettings

Paramètres de mise à niveau du pool d’agents
properties.vmSize

string

Taille des machines virtuelles du pool d’agents.
La disponibilité de la taille de machine virtuelle varie selon la région. Si un nœud contient des ressources de calcul insuffisantes (mémoire, processeur, etc.), les pods peuvent ne pas s’exécuter correctement. Pour plus d’informations sur les tailles de machines virtuelles restreintes, consultez : https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID

string

ID du sous-réseau auquel les nœuds du pool d’agents et éventuellement les pods seront joints au démarrage.
Si ce n’est pas spécifié, un réseau virtuel et un sous-réseau sont générés et utilisés. Si aucun podSubnetID n’est spécifié, cela s’applique aux nœuds et aux pods ; sinon, cela s’applique uniquement aux nœuds. Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile

AgentPoolWindowsProfile

Profil spécifique du pool d’agents Windows.
properties.workloadRuntime

WorkloadRuntime

Détermine le type de charge de travail qu’un nœud peut exécuter.
type

string

Type de ressource

AgentPoolMode

Mode d’un pool d’agents.

Nom Type Description
System

string

Les pools d’agents système sont principalement destinés à héberger des pods système critiques tels que CoreDNS et metrics-server. Les pools d’agents système osType doivent être Linux. La référence SKU de machine virtuelle des pools d’agents système doit avoir au moins 2 processeurs virtuels et 4 Go de mémoire.
User

string

Les pools d’agents utilisateur sont principalement destinés à héberger vos pods d’application.

AgentPoolNetworkProfile

Paramètres réseau d’un pool d’agents.

Nom Type Description
allowedHostPorts

PortRange[]

Plages de ports autorisées à accéder. Les plages spécifiées sont autorisées à se chevaucher.
applicationSecurityGroups

string[]

ID des groupes de sécurité d’application que le pool d’agents associera lors de sa création.
nodePublicIPTags

IPTag[]

IPTags d’adresses IP publiques de niveau instance.

AgentPoolType

Type de pool d’agents.

Nom Type Description
AvailabilitySet

string

Il est fortement déconseillé d’en faire usage.
VirtualMachineScaleSets

string

Créez un pool d’agents soutenu par un groupe de machines virtuelles identiques.

AgentPoolUpgradeSettings

Paramètres de mise à niveau d’un pool d’agents

Nom Type Description
drainTimeoutInMinutes

integer

Délai d’expiration du drainage pour un nœud
Durée (en minutes) d’attente de l’éviction des pods et de l’arrêt normal par nœud. Ce temps d’attente d’éviction honore l’attente sur les budgets d’interruption de pod. Si ce délai est dépassé, la mise à niveau échoue. Si elle n’est pas spécifiée, la valeur par défaut est de 30 minutes.
maxSurge

string

Nombre maximal ou pourcentage de nœuds qui sont augmentés pendant la mise à niveau.
Cette valeur peut être définie sur un entier (par exemple, « 5 ») ou un pourcentage (par exemple, « 50 % »). Si un pourcentage est spécifié, il s’agit du pourcentage de la taille totale du pool d’agents au moment de la mise à niveau. Pour les pourcentages, les nœuds fractionnaires sont arrondis vers le haut. Si cet argument n'est pas spécifié, la valeur par défaut est 1. Pour plus d’informations, notamment les meilleures pratiques, consultez : https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade
nodeSoakDurationInMinutes

integer

Durée de trempage d’un nœud
Durée (en minutes) d’attente après le drainage d’un nœud et avant de le réimaginer et de passer au nœud suivant. S’il n’est pas spécifié, la valeur par défaut est 0 minutes.

AgentPoolWindowsProfile

Profil spécifique du pool d’agents Windows.

Nom Type Description
disableOutboundNat

boolean

Indique s’il faut désactiver OutboundNAT dans les nœuds Windows
La valeur par défaut est false. La NAT sortante ne peut être désactivée que si le type sortant du cluster est une passerelle NAT et si l’adresse IP publique du nœud n’est pas activée dans le pool d’agents Windows.

CloudError

Réponse d’erreur du service conteneur.

Nom Type Description
error

CloudErrorBody

Détails sur l’erreur.

CloudErrorBody

Réponse d’erreur du service conteneur.

Nom Type Description
code

string

Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
details

CloudErrorBody[]

Liste de détails supplémentaires sur l’erreur.
message

string

Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target

string

Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

code

Indique si le cluster est en cours d’exécution ou arrêté

Nom Type Description
Running

string

Le cluster est en cours d’exécution.
Stopped

string

Le cluster est arrêté.

CreationData

Données utilisées lors de la création d’une ressource cible à partir d’une ressource source.

Nom Type Description
sourceResourceId

string

Il s’agit de l’ID ARM de l’objet source à utiliser pour créer l’objet cible.

GPUInstanceProfile

GPUInstanceProfile à utiliser pour spécifier le profil d’instance MIG GPU pour la référence SKU de machine virtuelle GPU prise en charge.

Nom Type Description
MIG1g

string

MIG2g

string

MIG3g

string

MIG4g

string

MIG7g

string

IPTag

Contient l’IPTag associé à l’objet .

Nom Type Description
ipTagType

string

Type de balise IP. Exemple : RoutingPreference.
tag

string

Valeur de la balise IP associée à l’adresse IP publique. Exemple : Internet.

KubeletConfig

Configurations Kubelet des nœuds de l’agent.

Nom Type Description
allowedUnsafeSysctls

string[]

Liste autorisée de sysctls non sécurisés ou de modèles sysctl non sécurisés (se terminant par *).
containerLogMaxFiles

integer

Nombre maximal de fichiers journaux de conteneur pouvant être présents pour un conteneur. Le nombre doit être ≥ 2.
containerLogMaxSizeMB

integer

Taille maximale (par exemple, 10Mi) du fichier journal du conteneur avant sa rotation.
cpuCfsQuota

boolean

Si l’application du quota CFS du processeur est activée pour les conteneurs qui spécifient des limites de processeur.
La valeur par défaut est true.
cpuCfsQuotaPeriod

string

Valeur de la période de quota CFS du processeur.
La valeur par défaut est « 100 ms ». Les valeurs valides sont une séquence de nombres décimaux avec une fraction facultative et un suffixe d’unité. Par exemple : « 300 ms », « 2h45m ». Les unités prises en charge sont « ns », « us », « ms », « s », « m » et « h ».
cpuManagerPolicy

string

Stratégie du gestionnaire d’uc à utiliser.
La valeur par défaut est « none ». Pour plus d’informations, consultez Stratégies de gestion du processeur Kubernetes . Les valeurs autorisées sont « none » et « static ».
failSwapOn

boolean

Si la valeur est true, kubelet ne démarre pas si l’échange est activé sur le nœud.
imageGcHighThreshold

integer

Pourcentage d’utilisation du disque après lequel le nettoyage de la mémoire d’images est toujours exécuté.
Pour désactiver le nettoyage de la mémoire d’images, définissez sur 100. La valeur par défaut est 85 %
imageGcLowThreshold

integer

Pourcentage d’utilisation du disque avant lequel le nettoyage de la mémoire d’images n’est jamais exécuté.
Cette valeur ne peut pas être définie plus haut que imageGcHighThreshold. La valeur par défaut est 80 %
podMaxPids

integer

Nombre maximal de processus par pod.
topologyManagerPolicy

string

Stratégie du Gestionnaire de topologie à utiliser.
Pour plus d’informations, consultez Gestionnaire de topologie Kubernetes. La valeur par défaut est « none ». Les valeurs autorisées sont « none », « best-effort », « restricted » et « single-numa-node ».

KubeletDiskType

Détermine l’emplacement des volumes emptyDir, de la racine des données du runtime de conteneur et du stockage éphémère Kubelet.

Nom Type Description
OS

string

Kubelet utilisera le disque du système d’exploitation pour ses données.
Temporary

string

Kubelet utilisera le disque temporaire pour ses données.

LinuxOSConfig

Configurations du système d’exploitation des nœuds de l’agent Linux.

Nom Type Description
swapFileSizeMB

integer

Taille en Mo d’un fichier d’échange qui sera créé sur chaque nœud.
sysctls

SysctlConfig

Paramètres Sysctl pour les nœuds de l’agent Linux.
transparentHugePageDefrag

string

Indique si le noyau doit utiliser agressivement le compactage de la mémoire pour rendre plus de pages énormes disponibles.
Les valeurs valides sont « always », « defer », « defer+ madvise », « madvise » et « never ». La valeur par défaut est 'madvise'. Pour plus d’informations, consultez Transparent Hugepages.
transparentHugePageEnabled

string

Indique si les pages énormes transparentes sont activées.
Les valeurs valides sont « always », « madvise » et « never ». La valeur par défaut est « always ». Pour plus d’informations, consultez Transparent Hugepages.

OSDiskType

Type de disque de système d’exploitation à utiliser pour les machines du pool d’agents.

Nom Type Description
Ephemeral

string

Les disques de système d’exploitation éphémères sont stockés uniquement sur l’ordinateur hôte, tout comme un disque temporaire. Cela permet de réduire la latence en lecture/écriture, tout en accélérant la mise à l’échelle des nœuds et la mise à niveau des clusters.
Managed

string

Azure réplique le disque du système d’exploitation d’une machine virtuelle dans le stockage Azure afin d’éviter la perte de données si la machine virtuelle doit être déplacée vers un autre hôte. Étant donné que les conteneurs ne sont pas conçus pour que l’état local soit persistant, ce comportement offre une valeur limitée tout en fournissant certains inconvénients, notamment un approvisionnement de nœuds plus lent et une latence plus élevée en lecture/écriture.

OSSKU

Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est Ubuntu si OSType est Linux. La valeur par défaut est Windows2019 quand Kubernetes <= 1.24 ou Windows2022 quand Kubernetes >= 1.25 si OSType est Windows.

Nom Type Description
AzureLinux

string

Utilisez AzureLinux comme système d’exploitation pour les images de nœud. Azure Linux est une distribution Linux optimisée pour les conteneurs créée par Microsoft. Pour plus d’informations, consultez https://aka.ms/azurelinux .
CBLMariner

string

Référence OSSku dépréciée. Microsoft recommande aux nouveaux déploiements de choisir « AzureLinux » à la place.
Ubuntu

string

Utilisez Ubuntu comme système d’exploitation pour les images de nœud.
Windows2019

string

Utilisez Windows2019 comme système d’exploitation pour les images de nœud. Non pris en charge pour les pools de nœuds système. Windows2019 prend uniquement en charge les conteneurs Windows2019 ; il ne peut pas exécuter les conteneurs Windows2022 et vice versa.
Windows2022

string

Utilisez Windows2022 comme système d’exploitation pour les images de nœud. Non pris en charge pour les pools de nœuds système. Windows2022 prend uniquement en charge les conteneurs Windows2022 ; il ne peut pas exécuter des conteneurs Windows2019 et vice versa.

OSType

Type de système d’exploitation. La valeur par défaut est Linux.

Nom Type Description
Linux

string

Utilisez Linux.
Windows

string

Utilisez Windows.

PortRange

Plage de ports.

Nom Type Description
portEnd

integer

Port maximal inclus dans la plage. Elle doit être comprise entre 1 et 65535 et être supérieure ou égale à portStart.
portStart

integer

Port minimal inclus dans la plage. Elle doit être comprise entre 1 et 65535 et être inférieure ou égale à portEnd.
protocol

Protocol

Protocole réseau du port.

PowerState

Décrit l’état d’alimentation du cluster

Nom Type Description
code

code

Indique si le cluster est en cours d’exécution ou arrêté

Protocol

Protocole réseau du port.

Nom Type Description
TCP

string

Protocole TCP.
UDP

string

Protocole UDP.

ScaleDownMode

Décrit comment les machines virtuelles sont ajoutées ou supprimées des pools d’agents. Consultez États de facturation.

Nom Type Description
Deallocate

string

Essayez de démarrer des instances libérées (si elles existent) pendant le scale-up et de désallouer les instances pendant le scale-down.
Delete

string

Créez de nouvelles instances pendant le scale-up et supprimez des instances pendant le scale-down.

ScaleSetEvictionPolicy

Stratégie d’éviction de groupe de machines virtuelles identiques.

Nom Type Description
Deallocate

string

Les nœuds du groupe identique sous-jacent du pool de nœuds sont définis sur l’état arrêté-libéré lors de l’éviction. Les nœuds dans l’état stopped-deallocated sont comptabilisés dans votre quota de calcul, et peuvent provoquer des problèmes de mise à l’échelle ou de mise à niveau du cluster.
Delete

string

Les nœuds du groupe identique sous-jacent du pool de nœuds sont supprimés lorsqu’ils sont supprimés.

ScaleSetPriority

Priorité groupe de machines virtuelles identiques.

Nom Type Description
Regular

string

Les machines virtuelles standard seront utilisées.
Spot

string

Les machines virtuelles à priorité spot seront utilisées. Il n’existe aucun contrat SLA pour les nœuds spot. Pour plus d’informations , consultez spot sur AKS .

SysctlConfig

Paramètres Sysctl pour les nœuds de l’agent Linux.

Nom Type Description
fsAioMaxNr

integer

Paramètre Sysctl fs.aio-max-nr.
fsFileMax

integer

Paramètre Sysctl fs.file-max.
fsInotifyMaxUserWatches

integer

Paramètre Sysctl fs.inotify.max_user_watches.
fsNrOpen

integer

Paramètre Sysctl fs.nr_open.
kernelThreadsMax

integer

Sysctl définissant kernel.threads-max.
netCoreNetdevMaxBacklog

integer

Paramètre Sysctl net.core.netdev_max_backlog.
netCoreOptmemMax

integer

Paramètre Sysctl net.core.optmem_max.
netCoreRmemDefault

integer

Paramètre Sysctl net.core.rmem_default.
netCoreRmemMax

integer

Paramètre Sysctl net.core.rmem_max.
netCoreSomaxconn

integer

Sysctl définissant net.core.somaxconn.
netCoreWmemDefault

integer

Paramètre Sysctl net.core.wmem_default.
netCoreWmemMax

integer

Paramètre Sysctl net.core.wmem_max.
netIpv4IpLocalPortRange

string

Paramètre Sysctl net.ipv4.ip_local_port_range.
netIpv4NeighDefaultGcThresh1

integer

Paramètre Sysctl net.ipv4.neigh.default.gc_thresh1.
netIpv4NeighDefaultGcThresh2

integer

Paramètre Sysctl net.ipv4.neigh.default.gc_thresh2.
netIpv4NeighDefaultGcThresh3

integer

Paramètre Sysctl net.ipv4.neigh.default.gc_thresh3.
netIpv4TcpFinTimeout

integer

Paramètre Sysctl net.ipv4.tcp_fin_timeout.
netIpv4TcpKeepaliveProbes

integer

Paramètre Sysctl net.ipv4.tcp_keepalive_probes.
netIpv4TcpKeepaliveTime

integer

Paramètre Sysctl net.ipv4.tcp_keepalive_time.
netIpv4TcpMaxSynBacklog

integer

Paramètre Sysctl net.ipv4.tcp_max_syn_backlog.
netIpv4TcpMaxTwBuckets

integer

Paramètre Sysctl net.ipv4.tcp_max_tw_buckets.
netIpv4TcpTwReuse

boolean

Paramètre Sysctl net.ipv4.tcp_tw_reuse.
netIpv4TcpkeepaliveIntvl

integer

Paramètre Sysctl net.ipv4.tcp_keepalive_intvl.
netNetfilterNfConntrackBuckets

integer

Paramètre Sysctl net.netfilter.nf_conntrack_buckets.
netNetfilterNfConntrackMax

integer

Paramètre Sysctl net.netfilter.nf_conntrack_max.
vmMaxMapCount

integer

Paramètre Sysctl vm.max_map_count.
vmSwappiness

integer

Paramètre Sysctl vm.swappiness.
vmVfsCachePressure

integer

Paramètre Sysctl vm.vfs_cache_pressure.

WorkloadRuntime

Détermine le type de charge de travail qu’un nœud peut exécuter.

Nom Type Description
OCIContainer

string

Les nœuds utilisent Kubelet pour exécuter des charges de travail de conteneur OCI standard.
WasmWasi

string

Les nœuds utilisent Krustlet pour exécuter des charges de travail WASM à l’aide du fournisseur WASI (préversion).