Share via

Agent Pools - Create Or Update

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

Hiermee maakt of werkt u een agentgroep bij in het opgegeven beheerde cluster.

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

URI-parameters

Name In Vereist Type Description
agentPoolName
 path True

string

De naam van de agentpool.

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

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
resourceName
 path True

string

De naam van de beheerde clusterresource.

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

De id van het doelabonnement. De waarde moet een UUID zijn.
api-version
 query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Type Description
properties.availabilityZones

string[]

De lijst met beschikbaarheidszones die moeten worden gebruikt voor knooppunten. Dit kan alleen worden opgegeven als de eigenschap AgentPoolType 'VirtualMachineScaleSets' is.
properties.capacityReservationGroupID

string

De volledig gekwalificeerde resource-id van de capaciteitsreserveringsgroep voor het leveren van virtuele machines uit een gereserveerde groep Virtual Machines.
AKS koppelt de opgegeven agentpool aan de capaciteitsreserveringsgroep.
properties.count

integer

Aantal agents (VM's) voor het hosten van Docker-containers. Toegestane waarden moeten tussen 0 en 1000 (inclusief) liggen voor gebruikersgroepen en in het bereik van 1 tot 1000 (inclusief) voor systeemgroepen. De standaardwaarde is 1.
properties.creationData

CreationData

CreationData die moet worden gebruikt om de bronmomentopname-id op te geven als de knooppuntgroep wordt gemaakt/bijgewerkt met behulp van een momentopname.
properties.enableAutoScaling

boolean

Of automatisch schalen moet worden ingeschakeld
properties.enableEncryptionAtHost

boolean

Of u versleuteling van besturingssysteem en gegevensstations op basis van een host wilt inschakelen.
Dit wordt alleen ondersteund op bepaalde VM-grootten en in bepaalde Azure-regio's. Zie voor meer informatie: https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS

boolean

Of u een besturingssysteem met FIPS wilt gebruiken.
Zie Een FIPS-knooppuntgroep toevoegen voor meer informatie.
properties.enableNodePublicIP

boolean

Of aan elk knooppunt een eigen openbaar IP-adres wordt toegewezen.
In sommige scenario's moeten knooppunten in een knooppuntgroep hun eigen toegewezen openbare IP-adressen ontvangen. Een veelvoorkomend scenario is voor gamingworkloads, waarbij een console een directe verbinding moet maken met een virtuele cloudmachine om hops te minimaliseren. Zie Een openbaar IP-adres per knooppunt toewijzen voor meer informatie. De standaardwaarde is false.
properties.enableUltraSSD

boolean

Of UltraSSD moet worden ingeschakeld
properties.gpuInstanceProfile

GPUInstanceProfile

GPUInstanceProfile dat moet worden gebruikt om het GPU MIG-exemplaarprofiel op te geven voor de ondersteunde GPU VM-SKU.
properties.hostGroupID

string

De volledig gekwalificeerde resource-id van de toegewezen hostgroep voor het inrichten van virtuele machines, die alleen wordt gebruikt in het scenario voor het maken en niet mag worden gewijzigd nadat deze is ingesteld.
Dit heeft de volgende vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Zie Toegewezen Azure-hosts voor meer informatie.
properties.kubeletConfig

KubeletConfig

Kubelet-configuraties van agentknooppunten.
De Kubelet-configuratie op de agentpoolknooppunten.
properties.kubeletDiskType

KubeletDiskType

Bepaalt de plaatsing van emptyDir-volumes, de hoofdmap van de containerruntimegegevens en de tijdelijke opslag van Kubelet.
properties.linuxOSConfig

LinuxOSConfig

Besturingssysteemconfiguraties van Linux-agentknooppunten.
De besturingssysteemconfiguratie van Linux-agentknooppunten.
properties.maxCount

integer

Het maximum aantal knooppunten voor automatisch schalen
properties.maxPods

integer

Het maximum aantal pods dat op een knooppunt kan worden uitgevoerd.
properties.minCount

integer

Het minimale aantal knooppunten voor automatisch schalen
properties.mode

AgentPoolMode

De modus van een agentpool.
Een cluster moet te allen tijde ten minste één 'Systeem'-agentgroep hebben. Zie voor meer informatie over beperkingen en best practices voor agentgroepen: https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile

AgentPoolNetworkProfile

Netwerkinstellingen van een agentgroep.
properties.nodeLabels

object

De knooppuntlabels die moeten worden opgeslagen op alle knooppunten in de agentgroep.
properties.nodePublicIPPrefixID

string

De openbare IP-voorvoegsel-id waarvan VM-knooppunten IP-adressen moeten gebruiken.
Dit heeft de volgende vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints

string[]

De taints die worden toegevoegd aan nieuwe knooppunten tijdens het maken en schalen van de knooppuntgroep. Bijvoorbeeld key=value:NoSchedule.
properties.orchestratorVersion

string

De versie van Kubernetes die is opgegeven door de gebruiker.
Zowel patchversie <major.minor.patch> (bijvoorbeeld 1.20.13) als <major.minor> (bijvoorbeeld 1.20) worden ondersteund. Wanneer <major.minor> is opgegeven, wordt automatisch de meest recente ondersteunde versie van de ga-patch gekozen. Als u het cluster bijwerkt met dezelfde <major.minor> nadat het is gemaakt (bijvoorbeeld 1.14.x -> 1.14), wordt er geen upgrade geactiveerd, zelfs niet als er een nieuwere patchversie beschikbaar is. Als best practice moet u alle knooppuntgroepen in een AKS-cluster upgraden naar dezelfde Kubernetes-versie. De versie van de knooppuntgroep moet dezelfde primaire versie hebben als het besturingsvlak. De secundaire versie van de knooppuntgroep moet binnen twee secundaire versies van de versie van het besturingsvlak vallen. De versie van de knooppuntgroep mag niet groter zijn dan de versie van het besturingsvlak. Zie Een knooppuntgroep upgraden voor meer informatie.
properties.osDiskSizeGB

integer

Grootte van besturingssysteemschijf in GB die moet worden gebruikt om de schijfgrootte op te geven voor elke computer in de hoofd-/agentgroep. Als u 0 opgeeft, wordt de standaardgrootte osDisk toegepast op basis van de opgegeven vmSize.
properties.osDiskType

OSDiskType

Het type besturingssysteemschijf dat moet worden gebruikt voor machines in de agentgroep.
De standaardwaarde is 'kortstondig' als de VM dit ondersteunt en een cacheschijf heeft die groter is dan de aangevraagde OSDiskSizeGB. Anders wordt standaard 'Beheerd' gebruikt. Mag niet worden gewijzigd na het maken. Zie Kortstondig besturingssysteem voor meer informatie.
properties.osSKU

OSSKU

Hiermee geeft u de SKU van het besturingssysteem die wordt gebruikt door de agentgroep. De standaardwaarde is Ubuntu als OSType Linux is. De standaardwaarde is Windows2019 wanneer Kubernetes <= 1.24 of Windows2022 wanneer Kubernetes >= 1.25 als OSType Windows is.
properties.osType

OSType

Het type besturingssysteem. De standaardwaarde is Linux.
properties.podSubnetID

string

De id van het subnet waaraan pods worden gekoppeld wanneer ze worden gestart.
Als u dit weglaat, worden pod-IP's statisch toegewezen aan het knooppuntsubnet (zie vnetSubnetID voor meer informatie). Dit heeft de volgende vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState

PowerState

Of de agentgroep wordt uitgevoerd of gestopt.
Wanneer een agentpool voor het eerst wordt gemaakt, wordt deze in eerste instantie uitgevoerd. De agentpool kan worden gestopt door dit veld in te stellen op Gestopt. Een gestopte agentpool stopt alle vm's en er worden geen factureringskosten in rekening gebracht. Een agentpool kan alleen worden gestopt als deze actief is en de inrichtingsstatus Geslaagd is
properties.proximityPlacementGroupID

string

De id voor nabijheidsplaatsingsgroep.
properties.scaleDownMode

ScaleDownMode

De modus omlaag schalen die moet worden gebruikt bij het schalen van de agentgroep.
Dit is ook van invloed op het gedrag van de cluster automatisch schalen. Als dit niet is opgegeven, wordt de standaardinstelling verwijderd.
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Het verwijderingsbeleid voor virtuele-machineschaalsets dat moet worden gebruikt.
Dit kan niet worden opgegeven, tenzij scaleSetPriority 'Spot' is. Als dit niet is opgegeven, is de standaardwaarde 'Verwijderen'.
properties.scaleSetPriority

ScaleSetPriority

De prioriteit van de virtuele-machineschaalset. Als dit niet is opgegeven, is de standaardwaarde 'Normaal'.
properties.spotMaxPrice

number

De maximale prijs (in Amerikaanse dollars) die u bereid bent te betalen voor spot-exemplaren. Mogelijke waarden zijn een decimale waarde groter dan nul of -1 die aangeeft dat de standaardprijs up-to-demand is.
Mogelijke waarden zijn elke decimale waarde groter dan nul of -1 die aangeeft dat u bereid bent om een on-demand prijs te betalen. Zie Prijzen voor spot-VM's voor meer informatie over spotprijzen
properties.tags

object

De tags die moeten worden opgeslagen in de virtuele-machineschaalset van de agentpool.
properties.type

AgentPoolType

Het type agentpool.
properties.upgradeSettings

AgentPoolUpgradeSettings

Instellingen voor het upgraden van de agentpool
properties.vmSize

string

De grootte van de vm's van de agentgroep.
De beschikbaarheid van VM-grootte verschilt per regio. Als een knooppunt onvoldoende rekenresources (geheugen, CPU, enzovoort) bevat, kunnen pods mogelijk niet correct worden uitgevoerd. Zie voor meer informatie over beperkte VM-grootten: https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID

string

De id van het subnet waaraan agentpoolknooppunten en optioneel pods worden toegevoegd bij het opstarten.
Als dit niet is opgegeven, worden een VNET en subnet gegenereerd en gebruikt. Als er geen podSubnetID is opgegeven, is dit van toepassing op knooppunten en pods, anders alleen op knooppunten. Dit heeft de volgende vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile

AgentPoolWindowsProfile

Het specifieke profiel van de Windows-agentgroep.
properties.workloadRuntime

WorkloadRuntime

Bepaalt het type workload dat een knooppunt kan uitvoeren.

Antwoorden

Name Type Description
200 OK

AgentPool

De bestaande agentgroep is bijgewerkt.
201 Created

AgentPool

De nieuwe agentpool is gemaakt.
Other Status Codes

CloudError

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name Description
AgentPool

Agentgroep.
AgentPoolMode

De modus van een agentpool.
AgentPoolNetworkProfile

Netwerkinstellingen van een agentgroep.
AgentPoolType

Het type agentpool.
AgentPoolUpgradeSettings

Instellingen voor het upgraden van een agentpool
AgentPoolWindowsProfile

Het specifieke profiel van de Windows-agentgroep.
CloudError

Een foutreactie van de Container-service.
CloudErrorBody

Een foutreactie van de containerservice.
code

Hiermee wordt aangegeven of het cluster actief of gestopt is
CreationData

Gegevens die worden gebruikt bij het maken van een doelresource op basis van een bronresource.
GPUInstanceProfile

GPUInstanceProfile dat moet worden gebruikt om het GPU MIG-exemplaarprofiel op te geven voor de ondersteunde GPU VM-SKU.
IPTag

Bevat de IPTag die is gekoppeld aan het -object.
KubeletConfig

Kubelet-configuraties van agentknooppunten.
KubeletDiskType

Bepaalt de plaatsing van emptyDir-volumes, de hoofdmap van de containerruntimegegevens en de tijdelijke opslag van Kubelet.
LinuxOSConfig

Besturingssysteemconfiguraties van Linux-agentknooppunten.
OSDiskType

Het type besturingssysteemschijf dat moet worden gebruikt voor machines in de agentgroep.
OSSKU

Hiermee geeft u de SKU van het besturingssysteem die wordt gebruikt door de agentgroep. De standaardwaarde is Ubuntu als OSType Linux is. De standaardwaarde is Windows2019 wanneer Kubernetes <= 1.24 of Windows2022 wanneer Kubernetes >= 1.25 als OSType Windows is.
OSType

Het type besturingssysteem. De standaardwaarde is Linux.
PortRange

Het poortbereik.
PowerState

Beschrijft de energiestatus van het cluster
Protocol

Het netwerkprotocol van de poort.
ScaleDownMode

Hierin wordt beschreven hoe VM's worden toegevoegd aan of verwijderd uit agentgroepen. Zie factureringsstatussen.
ScaleSetEvictionPolicy

Het verwijderingsbeleid voor virtuele-machineschaalsets.
ScaleSetPriority

De prioriteit van de virtuele-machineschaalset.
SysctlConfig

Sysctl-instellingen voor Linux-agentknooppunten.
WorkloadRuntime

Bepaalt het type workload dat een knooppunt kan uitvoeren.

AgentPool

Agentgroep.

Name Type Standaardwaarde Description
id

string

Resource-id.
name

string

De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.availabilityZones

string[]

De lijst met beschikbaarheidszones die moeten worden gebruikt voor knooppunten. Dit kan alleen worden opgegeven als de eigenschap AgentPoolType 'VirtualMachineScaleSets' is.
properties.capacityReservationGroupID

string

De volledig gekwalificeerde resource-id van de capaciteitsreserveringsgroep voor het leveren van virtuele machines van een gereserveerde groep Virtual Machines.
AKS koppelt de opgegeven agentpool aan de capaciteitsreserveringsgroep.
properties.count

integer

Aantal agents (VM's) voor het hosten van Docker-containers. Toegestane waarden moeten tussen 0 en 1000 (inclusief) liggen voor gebruikersgroepen en in het bereik van 1 tot 1000 (inclusief) voor systeemgroepen. De standaardwaarde is 1.
properties.creationData

CreationData

CreationData die moet worden gebruikt om de bronmomentopname-id op te geven als de knooppuntgroep wordt gemaakt/bijgewerkt met behulp van een momentopname.
properties.currentOrchestratorVersion

string

De versie van Kubernetes die door de agentgroep wordt uitgevoerd.
Als orchestratorVersion een volledig opgegeven versie <major.minor.patch> is, is dit veld precies gelijk aan het veld. Als orchestratorVersion major.minor> is<, bevat dit veld de volledige <versie major.minor.patch> die wordt gebruikt.
properties.enableAutoScaling

boolean

Of automatisch schalen moet worden ingeschakeld
properties.enableEncryptionAtHost

boolean

Of versleuteling van op host gebaseerd besturingssysteem en gegevensstation moet worden ingeschakeld.
Dit wordt alleen ondersteund op bepaalde VM-grootten en in bepaalde Azure-regio's. Zie voor meer informatie: https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS

boolean

Of u een besturingssysteem met FIPS wilt gebruiken.
Zie Een FIPS-knooppuntgroep toevoegen voor meer informatie.
properties.enableNodePublicIP

boolean

Of aan elk knooppunt een eigen openbaar IP-adres wordt toegewezen.
In sommige scenario's moeten knooppunten in een knooppuntgroep hun eigen toegewezen openbare IP-adressen ontvangen. Een veelvoorkomend scenario is voor gamingworkloads, waarbij een console een directe verbinding moet maken met een virtuele machine in de cloud om hops te minimaliseren. Zie Een openbaar IP-adres per knooppunt toewijzen voor meer informatie. De standaardwaarde is false.
properties.enableUltraSSD

boolean

Of UltraSSD moet worden ingeschakeld
properties.gpuInstanceProfile

GPUInstanceProfile

GPUInstanceProfile dat moet worden gebruikt om het GPU MIG-exemplaarprofiel op te geven voor ondersteunde GPU VM-SKU.
properties.hostGroupID

string

De volledig gekwalificeerde resource-id van de toegewezen hostgroep om virtuele machines van in te richten, wordt alleen gebruikt bij het maken van een scenario en mag niet worden gewijzigd zodra deze is ingesteld.
Dit heeft de volgende vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Zie Toegewezen Azure-hosts voor meer informatie.
properties.kubeletConfig

KubeletConfig

Kubelet-configuraties van agentknooppunten.
De Kubelet-configuratie op de agentpoolknooppunten.
properties.kubeletDiskType

KubeletDiskType

Bepaalt de plaatsing van emptyDir-volumes, de hoofdmap van de containerruntimegegevens en de tijdelijke opslag van Kubelet.
properties.linuxOSConfig

LinuxOSConfig

Besturingssysteemconfiguraties van Linux-agentknooppunten.
De configuratie van het besturingssysteem van Linux-agentknooppunten.
properties.maxCount

integer

Het maximum aantal knooppunten voor automatisch schalen
properties.maxPods

integer

Het maximum aantal pods dat op een knooppunt kan worden uitgevoerd.
properties.minCount

integer

Het minimale aantal knooppunten voor automatisch schalen
properties.mode

AgentPoolMode

De modus van een agentgroep.
Een cluster moet altijd ten minste één 'Systeem'-agentgroep hebben. Zie voor meer informatie over beperkingen en best practices voor agentpools: https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile

AgentPoolNetworkProfile

Netwerkinstellingen van een agentgroep.
properties.nodeImageVersion

string

De versie van knooppuntinstallatiekopieën
properties.nodeLabels

object

De knooppuntlabels die moeten worden bewaard op alle knooppunten in de agentgroep.
properties.nodePublicIPPrefixID

string

De id van het openbare IP-voorvoegsel waarvan VM-knooppunten IP-adressen moeten gebruiken.
Dit is de volgende vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints

string[]

De taints die zijn toegevoegd aan nieuwe knooppunten tijdens het maken en schalen van knooppuntgroepen. Bijvoorbeeld key=value:NoSchedule.
properties.orchestratorVersion

string

De versie van Kubernetes die is opgegeven door de gebruiker.
Zowel de patchversie <major.minor.patch> (bijvoorbeeld 1.20.13) als <major.minor> (bijvoorbeeld 1.20) worden ondersteund. Wanneer <major.minor> is opgegeven, wordt automatisch de meest recente ondersteunde ga-patchversie gekozen. Als u het cluster bijwerkt met dezelfde <major.minor> nadat het is gemaakt (bijvoorbeeld 1.14.x -> 1.14), wordt er geen upgrade geactiveerd, zelfs niet als er een nieuwere patchversie beschikbaar is. Als best practice moet u alle knooppuntgroepen in een AKS-cluster upgraden naar dezelfde Kubernetes-versie. De versie van de knooppuntgroep moet dezelfde primaire versie hebben als het besturingsvlak. De secundaire versie van de knooppuntgroep moet binnen twee secundaire versies van de versie van het besturingsvlak vallen. De versie van de knooppuntgroep mag niet groter zijn dan de versie van het besturingsvlak. Zie Een knooppuntgroep upgraden voor meer informatie.
properties.osDiskSizeGB

integer

Grootte van besturingssysteemschijf in GB die moet worden gebruikt om de schijfgrootte op te geven voor elke computer in de hoofd-/agentgroep. Als u 0 opgeeft, wordt de standaardgrootte osDisk toegepast op basis van de opgegeven vmSize.
properties.osDiskType

OSDiskType

Het type besturingssysteemschijf dat moet worden gebruikt voor machines in de agentgroep.
De standaardwaarde is 'kortstondig' als de VM dit ondersteunt en een cacheschijf heeft die groter is dan de aangevraagde OSDiskSizeGB. Anders wordt standaard beheerd. Kan niet worden gewijzigd na het maken. Zie Tijdelijk besturingssysteem voor meer informatie.
properties.osSKU

OSSKU

Hiermee geeft u de SKU van het besturingssysteem op die wordt gebruikt door de agentgroep. De standaardwaarde is Ubuntu als OSType Linux is. De standaardwaarde is Windows2019 wanneer Kubernetes <= 1.24 of Windows2022 wanneer Kubernetes >= 1.25 als OSType Windows is.
properties.osType

OSType

Linux

Het type besturingssysteem. De standaardwaarde is Linux.
properties.podSubnetID

string

De id van het subnet waaraan pods worden gekoppeld wanneer ze worden gestart.
Als u dit weglaat, worden pod-IP's statisch toegewezen aan het knooppuntsubnet (zie vnetSubnetID voor meer informatie). Dit heeft de volgende vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState

PowerState

Of de agentgroep actief of gestopt is.
Wanneer een agentgroep voor het eerst wordt gemaakt, wordt deze in eerste instantie uitgevoerd. De agentgroep kan worden gestopt door dit veld in te stellen op Gestopt. Een gestopte agentgroep stopt alle vm's en er worden geen factureringskosten in rekening gebracht. Een agentgroep kan alleen worden gestopt als deze actief is en de inrichtingsstatus Geslaagd is
properties.provisioningState

string

De huidige implementatie- of inrichtingsstatus.
properties.proximityPlacementGroupID

string

De id voor nabijheidsplaatsingsgroep.
properties.scaleDownMode

ScaleDownMode

De modus omlaag schalen die moet worden gebruikt bij het schalen van de agentgroep.
Dit is ook van invloed op het gedrag van de automatische schaalaanpassing van clusters. Als dit niet is opgegeven, wordt deze standaard ingesteld op Verwijderen.
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Delete

Het verwijderingsbeleid voor virtuele-machineschaalsets dat moet worden gebruikt.
Dit kan niet worden opgegeven, tenzij scaleSetPriority 'Spot' is. Als dit niet wordt opgegeven, is de standaardwaarde Verwijderen.
properties.scaleSetPriority

ScaleSetPriority

Regular

De prioriteit van de virtuele-machineschaalset. Als dit niet is opgegeven, is de standaardwaarde 'Normaal'.
properties.spotMaxPrice

number

-1

De maximale prijs (in Amerikaanse dollars) die u bereid bent te betalen voor spot-exemplaren. Mogelijke waarden zijn elke decimale waarde groter dan nul of -1 die aangeeft dat de standaardprijs up-to-demand is.
Mogelijke waarden zijn elke decimale waarde groter dan nul of -1 die de bereidheid aangeeft om een on-demand prijs te betalen. Zie prijzen voor spot-VM's voor meer informatie over spotprijzen
properties.tags

object

De tags die moeten worden opgeslagen in de virtuele-machineschaalset van de agentpool.
properties.type

AgentPoolType

Het type agentgroep.
properties.upgradeSettings

AgentPoolUpgradeSettings

Instellingen voor het upgraden van de agentpool
properties.vmSize

string

De grootte van de VM's van de agentgroep.
De beschikbaarheid van DE VM-grootte verschilt per regio. Als een knooppunt onvoldoende rekenresources (geheugen, CPU, enzovoort) bevat, kunnen pods mogelijk niet correct worden uitgevoerd. Zie voor meer informatie over beperkte VM-grootten: https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID

string

De id van het subnet waaraan agentpoolknooppunten en optioneel pods worden gekoppeld bij het opstarten.
Als dit niet is opgegeven, worden een VNET en subnet gegenereerd en gebruikt. Als er geen podSubnetID is opgegeven, is dit van toepassing op knooppunten en pods, anders geldt dit alleen voor knooppunten. Dit heeft de volgende vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile

AgentPoolWindowsProfile

Het specifieke profiel van de Windows-agentgroep.
properties.workloadRuntime

WorkloadRuntime

Bepaalt het type workload dat een knooppunt kan uitvoeren.
type

string

Resourcetype

AgentPoolMode

De modus van een agentpool.

Name Type Description
System

string

Systeemagentgroepen zijn voornamelijk bedoeld voor het hosten van kritieke systeempods, zoals CoreDNS en metrics-server. Systeemagentpools osType moeten Linux zijn. De VM-SKU van systeemagentpools moet ten minste 2 vCPU's en 4 GB geheugen hebben.
User

string

Gebruikersagentgroepen zijn voornamelijk bedoeld voor het hosten van uw toepassingspods.

AgentPoolNetworkProfile

Netwerkinstellingen van een agentgroep.

Name Type Description
allowedHostPorts

PortRange[]

De poortbereiken waartoe toegang is toegestaan. De opgegeven bereiken mogen elkaar overlappen.
applicationSecurityGroups

string[]

De id's van de toepassingsbeveiligingsgroepen die de agentgroep koppelt wanneer deze wordt gemaakt.
nodePublicIPTags

IPTag[]

IPTags van openbare IP-adressen op exemplaarniveau.

AgentPoolType

Het type agentpool.

Name Type Description
AvailabilitySet

string

Gebruik hiervan wordt sterk afgeraden.
VirtualMachineScaleSets

string

Maak een agentpool die wordt ondersteund door een virtuele-machineschaalset.

AgentPoolUpgradeSettings

Instellingen voor het upgraden van een agentpool

Name Type Description
drainTimeoutInMinutes

integer

De time-out van de afvoer voor een knooppunt
De hoeveelheid tijd (in minuten) die moet worden gewacht op verwijdering van pods en een probleemloze beëindiging per knooppunt. Deze wachttijd voor verwijdering houdt rekening met het wachten op podonderbrekingsbudgetten. Als deze tijd wordt overschreden, mislukt de upgrade. Als dit niet is opgegeven, is de standaardwaarde 30 minuten.
maxSurge

string

Het maximum aantal of het maximumpercentage van knooppunten dat tijdens de upgrade is toegenomen.
Dit kan worden ingesteld op een geheel getal (bijvoorbeeld '5') of een percentage (bijvoorbeeld '50%'). Als er een percentage is opgegeven, is dit het percentage van de totale grootte van de agentgroep op het moment van de upgrade. Voor percentages worden breukknooppunten naar boven afgerond. Als dit niet is opgegeven, is de standaardwaarde 1. Zie voor meer informatie, inclusief aanbevolen procedures: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade
nodeSoakDurationInMinutes

integer

De duur van het weken voor een knooppunt
De hoeveelheid tijd (in minuten) die moet worden gewacht na het leegmaken van een knooppunt en voordat het opnieuw is gemaakt en doorgaat naar het volgende knooppunt. Als dit niet is opgegeven, is de standaardwaarde 0 minuten.

AgentPoolWindowsProfile

Het specifieke profiel van de Windows-agentgroep.

Name Type Description
disableOutboundNat

boolean

Of OutboundNAT in Windows-knooppunten moet worden uitgeschakeld
De standaardwaarde is false. Uitgaande NAT kan alleen worden uitgeschakeld als het outboundType van het cluster NAT-gateway is en voor de Windows-agentgroep geen openbaar IP-adres van het knooppunt is ingeschakeld.

CloudError

Een foutreactie van de Container-service.

Name Type Description
error

CloudErrorBody

Details over de fout.

CloudErrorBody

Een foutreactie van de containerservice.

Name Type Description
code

string

Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details

CloudErrorBody[]

Een lijst met aanvullende informatie over de fout.
message

string

Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target

string

Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap fout.

code

Hiermee wordt aangegeven of het cluster actief of gestopt is

Name Type Description
Running

string

Het cluster wordt uitgevoerd.
Stopped

string

Het cluster is gestopt.

CreationData

Gegevens die worden gebruikt bij het maken van een doelresource op basis van een bronresource.

Name Type Description
sourceResourceId

string

Dit is de ARM-id van het bronobject dat moet worden gebruikt om het doelobject te maken.

GPUInstanceProfile

GPUInstanceProfile dat moet worden gebruikt om het GPU MIG-exemplaarprofiel op te geven voor de ondersteunde GPU VM-SKU.

Name Type Description
MIG1g

string

MIG2g

string

MIG3g

string

MIG4g

string

MIG7g

string

IPTag

Bevat de IPTag die is gekoppeld aan het -object.

Name Type Description
ipTagType

string

Het type IP-tag. Voorbeeld: RoutingPreference.
tag

string

De waarde van de IP-tag die is gekoppeld aan het openbare IP-adres. Voorbeeld: Internet.

KubeletConfig

Kubelet-configuraties van agentknooppunten.

Name Type Description
allowedUnsafeSysctls

string[]

Toegestane lijst met onveilige sysctls of onveilige sysctl-patronen (eindigend op *).
containerLogMaxFiles

integer

Het maximum aantal containerlogboekbestanden dat aanwezig kan zijn voor een container. Het getal moet ≥ 2 zijn.
containerLogMaxSizeMB

integer

De maximale grootte (bijvoorbeeld 10Mi) van het containerlogboekbestand voordat het wordt geroteerd.
cpuCfsQuota

boolean

Als CPU CFS-quotum afdwinging is ingeschakeld voor containers die CPU-limieten opgeven.
De standaardwaarde is true.
cpuCfsQuotaPeriod

string

De waarde van de CPU CFS-quotumperiode.
De standaardwaarde is '100 ms'. Geldige waarden zijn een reeks decimale getallen met een optionele breuk en een eenheidsachtervoegsel. Bijvoorbeeld: '300ms', '2h45m'. Ondersteunde eenheden zijn 'ns', 'ons', 'ms', 's', 'm' en 'h'.
cpuManagerPolicy

string

Het CPU Manager-beleid dat moet worden gebruikt.
De standaardwaarde is 'none'. Zie Kubernetes CPU-beheerbeleid voor meer informatie. Toegestane waarden zijn 'none' en 'static'.
failSwapOn

boolean

Als deze optie is ingesteld op true, kan de Kubelet niet worden gestart als wisselen is ingeschakeld op het knooppunt.
imageGcHighThreshold

integer

Het percentage schijfgebruik waarna de garbagecollection van de installatiekopieën altijd wordt uitgevoerd.
Als u garbagecollection van installatiekopieën wilt uitschakelen, stelt u in op 100. De standaardwaarde is 85%
imageGcLowThreshold

integer

Het percentage schijfgebruik waarvoor garbagecollection van installatiekopieën nooit wordt uitgevoerd.
Dit kan niet hoger worden ingesteld dan imageGcHighThreshold. De standaardwaarde is 80%
podMaxPids

integer

Het maximum aantal processen per pod.
topologyManagerPolicy

string

Het topologiebeheerbeleid dat moet worden gebruikt.
Zie Kubernetes Topology Manager voor meer informatie. De standaardwaarde is 'none'. Toegestane waarden zijn 'none', 'best-effort', 'restricted' en 'single-numa-node'.

KubeletDiskType

Bepaalt de plaatsing van emptyDir-volumes, de hoofdmap van de containerruntimegegevens en de tijdelijke opslag van Kubelet.

Name Type Description
OS

string

Kubelet gebruikt de besturingssysteemschijf voor de gegevens.
Temporary

string

Kubelet gebruikt de tijdelijke schijf voor de bijbehorende gegevens.

LinuxOSConfig

Besturingssysteemconfiguraties van Linux-agentknooppunten.

Name Type Description
swapFileSizeMB

integer

De grootte in MB van een wisselbestand dat op elk knooppunt wordt gemaakt.
sysctls

SysctlConfig

Sysctl-instellingen voor Linux-agentknooppunten.
transparentHugePageDefrag

string

Of de kernel agressief gebruik moet maken van geheugencompressie om meer enorme pagina's beschikbaar te maken.
Geldige waarden zijn 'always', 'defer', 'defer+madvise', 'madvise' en 'never'. De standaardwaarde is 'madvise'. Zie Transparent Hugepages voor meer informatie.
transparentHugePageEnabled

string

Of transparante hugepages zijn ingeschakeld.
Geldige waarden zijn 'altijd', 'madvise' en 'nooit'. De standaardwaarde is 'altijd'. Zie Transparent Hugepages voor meer informatie.

OSDiskType

Het type besturingssysteemschijf dat moet worden gebruikt voor machines in de agentgroep.

Name Type Description
Ephemeral

string

Tijdelijke besturingssysteemschijven worden alleen opgeslagen op de hostcomputer, net als een tijdelijke schijf. Dit biedt een lagere latentie voor lezen/schrijven, samen met snellere schaalaanpassing van knooppunten en clusterupgrades.
Managed

string

Azure repliceert de besturingssysteemschijf van een virtuele machine naar Azure Storage om gegevensverlies te voorkomen als de VM naar een andere host moet worden verplaatst. Omdat containers niet zijn ontworpen om de lokale status te behouden, biedt dit gedrag beperkte waarde en biedt het enkele nadelen, waaronder tragere inrichting van knooppunten en een hogere lees-/schrijflatentie.

OSSKU

Hiermee geeft u de SKU van het besturingssysteem die wordt gebruikt door de agentgroep. De standaardwaarde is Ubuntu als OSType Linux is. De standaardwaarde is Windows2019 wanneer Kubernetes <= 1.24 of Windows2022 wanneer Kubernetes >= 1.25 als OSType Windows is.

Name Type Description
AzureLinux

string

Gebruik AzureLinux als het besturingssysteem voor knooppuntinstallatiekopieën. Azure Linux is een voor containers geoptimaliseerde Linux-distributie die is gebouwd door Microsoft. Ga naar https://aka.ms/azurelinux voor meer informatie.
CBLMariner

string

OssKU is afgeschaft. Microsoft raadt aan dat nieuwe implementaties in plaats daarvan 'AzureLinux' kiezen.
Ubuntu

string

Gebruik Ubuntu als het besturingssysteem voor knooppuntinstallatiekopieën.
Windows2019

string

Gebruik Windows2019 als het besturingssysteem voor knooppuntinstallatiekopieën. Niet ondersteund voor systeemknooppuntgroepen. Windows2019 ondersteunt alleen Windows2019-containers; Windows2022-containers kunnen niet worden uitgevoerd en vice versa.
Windows2022

string

Gebruik Windows2022 als het besturingssysteem voor knooppuntinstallatiekopieën. Niet ondersteund voor systeemknooppuntgroepen. Windows2022 ondersteunt alleen Windows2022-containers; Windows2019-containers kunnen niet worden uitgevoerd en vice versa.

OSType

Het type besturingssysteem. De standaardwaarde is Linux.

Name Type Description
Linux

string

Gebruik Linux.
Windows

string

Gebruik Windows.

PortRange

Het poortbereik.

Name Type Description
portEnd

integer

De maximale poort die is opgenomen in het bereik. De waarde moet variëren van 1 tot 65535 en groter zijn dan of gelijk aan portStart.
portStart

integer

De minimale poort die is opgenomen in het bereik. Het moet variëren van 1 tot 65535 en kleiner zijn dan of gelijk aan portEnd.
protocol

Protocol

Het netwerkprotocol van de poort.

PowerState

Beschrijft de energiestatus van het cluster

Name Type Description
code

code

Hiermee wordt aangegeven of het cluster actief of gestopt is

Protocol

Het netwerkprotocol van de poort.

Name Type Description
TCP

string

TCP-protocol.
UDP

string

UDP-protocol.

ScaleDownMode

Hierin wordt beschreven hoe VM's worden toegevoegd aan of verwijderd uit agentgroepen. Zie factureringsstatussen.

Name Type Description
Deallocate

string

Probeer de toewijzing van exemplaren ongedaan te maken (indien aanwezig) tijdens het omhoog schalen en de toewijzing van exemplaren ongedaan te maken tijdens het omlaag schalen.
Delete

string

Maak nieuwe exemplaren tijdens omhoog schalen en verwijder exemplaren tijdens omlaag schalen.

ScaleSetEvictionPolicy

Het verwijderingsbeleid voor virtuele-machineschaalsets.

Name Type Description
Deallocate

string

Knooppunten in de onderliggende schaalset van de knooppuntgroep worden na verwijdering ingesteld op de status gestopt-toewijzing ongedaan gemaakt. Knooppunten met de status gestopt/toewijzing opgeheven tellen ten opzichte van uw rekenquotum en kunnen problemen veroorzaken met het schalen of upgraden van clusters.
Delete

string

Knooppunten in de onderliggende schaalset van de knooppuntgroep worden verwijderd wanneer ze worden verwijderd.

ScaleSetPriority

De prioriteit van de virtuele-machineschaalset.

Name Type Description
Regular

string

Er worden normale VM's gebruikt.
Spot

string

Er worden spotprioriteits-VM's gebruikt. Er is geen SLA voor spot-knooppunten. Zie spot on AKS voor meer informatie.

SysctlConfig

Sysctl-instellingen voor Linux-agentknooppunten.

Name Type Description
fsAioMaxNr

integer

Sysctl-instelling fs.aio-max-nr.
fsFileMax

integer

Sysctl-instelling fs.file-max.
fsInotifyMaxUserWatches

integer

Sysctl-instelling fs.inotify.max_user_watches.
fsNrOpen

integer

Sysctl-instelling fs.nr_open.
kernelThreadsMax

integer

Sysctl-instelling kernel.threads-max.
netCoreNetdevMaxBacklog

integer

Sysctl-instelling net.core.netdev_max_backlog.
netCoreOptmemMax

integer

Sysctl-instelling net.core.optmem_max.
netCoreRmemDefault

integer

Sysctl-instelling net.core.rmem_default.
netCoreRmemMax

integer

Sysctl-instelling net.core.rmem_max.
netCoreSomaxconn

integer

Sysctl-instelling net.core.somaxconn.
netCoreWmemDefault

integer

Sysctl-instelling net.core.wmem_default.
netCoreWmemMax

integer

Sysctl-instelling net.core.wmem_max.
netIpv4IpLocalPortRange

string

Sysctl-instelling net.ipv4.ip_local_port_range.
netIpv4NeighDefaultGcThresh1

integer

Sysctl-instelling net.ipv4.neigh.default.gc_thresh1.
netIpv4NeighDefaultGcThresh2

integer

Sysctl-instelling net.ipv4.neigh.default.gc_thresh2.
netIpv4NeighDefaultGcThresh3

integer

Sysctl-instelling net.ipv4.neigh.default.gc_thresh3.
netIpv4TcpFinTimeout

integer

Sysctl-instelling net.ipv4.tcp_fin_timeout.
netIpv4TcpKeepaliveProbes

integer

Sysctl-instelling net.ipv4.tcp_keepalive_probes.
netIpv4TcpKeepaliveTime

integer

Sysctl-instelling net.ipv4.tcp_keepalive_time.
netIpv4TcpMaxSynBacklog

integer

Sysctl-instelling net.ipv4.tcp_max_syn_backlog.
netIpv4TcpMaxTwBuckets

integer

Sysctl-instelling net.ipv4.tcp_max_tw_buckets.
netIpv4TcpTwReuse

boolean

Sysctl-instelling net.ipv4.tcp_tw_reuse.
netIpv4TcpkeepaliveIntvl

integer

Sysctl-instelling net.ipv4.tcp_keepalive_intvl.
netNetfilterNfConntrackBuckets

integer

Sysctl-instelling net.netfilter.nf_conntrack_buckets.
netNetfilterNfConntrackMax

integer

Sysctl-instelling net.netfilter.nf_conntrack_max.
vmMaxMapCount

integer

Sysctl-instelling vm.max_map_count.
vmSwappiness

integer

Sysctl-instelling vm.swappiness.
vmVfsCachePressure

integer

Sysctl-instelling vm.vfs_cache_pressure.

WorkloadRuntime

Bepaalt het type workload dat een knooppunt kan uitvoeren.

Name Type Description
OCIContainer

string

Knooppunten gebruiken Kubelet om standaard OCI-containerworkloads uit te voeren.
WasmWasi

string

Knooppunten gebruiken Krustlet om WASM-workloads uit te voeren met behulp van de WASI-provider (preview).