Share via

Agent Pools - Create Or Update

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

Erstellt oder aktualisiert einen Agentpool im angegebenen verwalteten Cluster.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
agentPoolName
 path True

string

Der Name des Agentpools.

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

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName
 path True

string

Der Name der verwalteten Clusterressource.

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

Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version
 query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Typ Beschreibung
properties.availabilityZones

string[]

Die Liste der Verfügbarkeitszonen, die für Knoten verwendet werden sollen. Dies kann nur angegeben werden, wenn die AgentPoolType-Eigenschaft "VirtualMachineScaleSets" lautet.
properties.capacityReservationGroupID

string

Die vollqualifizierte Ressourcen-ID der Kapazitätsreservierungsgruppe, um virtuelle Computer aus einer reservierten Gruppe von Virtual Machines bereitzustellen.
AKS ordnet den angegebenen Agentpool der Kapazitätsreservierungsgruppe zu.
properties.count

integer

Anzahl der Agents (VMs) zum Hosten von Docker-Containern. Zulässige Werte müssen im Bereich von 0 bis 1000 (einschließlich) für Benutzerpools und im Bereich von 1 bis 1000 (einschließlich) für Systempools liegen. Der Standardwert ist 1.
properties.creationData

CreationData

CreationData, das verwendet werden soll, um die Quellmomentaufnahme-ID anzugeben, wenn der Knotenpool mithilfe einer Momentaufnahme erstellt/aktualisiert wird.
properties.enableAutoScaling

boolean

Ob die automatische Skalierung aktiviert werden soll
properties.enableEncryptionAtHost

boolean

Gibt an, ob die hostbasierte Betriebssystem- und Datenlaufwerkverschlüsselung aktiviert werden soll.
Dies wird nur für bestimmte VM-Größen und in bestimmten Azure-Regionen unterstützt. Weitere Informationen finden Sie unter: https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS

boolean

Gibt an, ob ein FIPS-fähiges Betriebssystem verwendet werden soll.
Weitere Informationen finden Sie unter Hinzufügen eines FIPS-fähigen Knotenpools .
properties.enableNodePublicIP

boolean

Gibt an, ob jedem Knoten eine eigene öffentliche IP-Adresse zugeordnet ist.
Einige Szenarien erfordern möglicherweise, dass Knoten in einem Knotenpool ihre eigenen dedizierten öffentlichen IP-Adressen empfangen. Ein häufiges Szenario hierfür sind Gamingworkloads, bei denen eine Konsole eine direkte Verbindung mit einem virtuellen Cloudcomputer herstellen muss, um Hops zu minimieren. Weitere Informationen finden Sie unter Zuweisen einer öffentlichen IP-Adresse pro Knoten. Die Standardeinstellung ist „false“.
properties.enableUltraSSD

boolean

Ob UltraSSD aktiviert werden soll
properties.gpuInstanceProfile

GPUInstanceProfile

GPUInstanceProfile, das zum Angeben des GPU-MIG-instance-Profils für die unterstützte GPU-VM-SKU verwendet werden soll.
properties.hostGroupID

string

Die vollqualifizierte Ressourcen-ID der dedizierten Hostgruppe zum Bereitstellen von virtuellen Computern, die nur im Erstellungsszenario verwendet wird und nicht geändert werden darf, sobald festgelegt wurde.
Dies hat folgendes Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Weitere Informationen finden Sie unter Dedizierte Azure-Hosts.
properties.kubeletConfig

KubeletConfig

Kubelet-Konfigurationen von Agentknoten.
Die Kubelet-Konfiguration auf den Agentpoolknoten.
properties.kubeletDiskType

KubeletDiskType

Bestimmt die Platzierung von emptyDir-Volumes, Container Runtime-Datenstamm und kurzlebigem Kubelet-Speicher.
properties.linuxOSConfig

LinuxOSConfig

Betriebssystemkonfigurationen von Linux-Agent-Knoten.
Die Betriebssystemkonfiguration von Linux-Agent-Knoten.
properties.maxCount

integer

Die maximale Anzahl von Knoten für die automatische Skalierung
properties.maxPods

integer

Die maximale Anzahl von Pods, die auf einem Knoten ausgeführt werden können.
properties.minCount

integer

Die mindeste Anzahl von Knoten für die automatische Skalierung
properties.mode

AgentPoolMode

Der Modus eines Agentpools.
Ein Cluster muss jederzeit über mindestens einen System-Agentpool verfügen. Weitere Informationen zu Einschränkungen und bewährten Methoden für Agentpools finden Sie unter: https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile

AgentPoolNetworkProfile

Netzwerkbezogene Einstellungen eines Agentpools.
properties.nodeLabels

object

Die Knotenbezeichnungen, die auf allen Knoten im Agentpool beibehalten werden sollen.
properties.nodePublicIPPrefixID

string

Die präfix-ID der öffentlichen IP, von der VM-Knoten IP-Adressen verwenden sollen.
Dies hat folgendes Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints

string[]

Die beim Erstellen und Skalieren des Knotenpools neuen Knoten hinzugefügten Taints. Beispiel: key=value:NoSchedule.
properties.orchestratorVersion

string

Die vom Benutzer angegebene Kubernetes-Version.
Sowohl die Patchversion <major.minor.patch> (z.B. 1.20.13) als <auch die Hauptversion> (z. B. 1.20) werden unterstützt. Wenn <major.minor> angegeben wird, wird automatisch die neueste unterstützte GA-Patchversion ausgewählt. Das Aktualisieren des Clusters mit demselben <major.minor> , nachdem er erstellt wurde (z. B. 1.14.x bis> 1.14), löst kein Upgrade aus, selbst wenn eine neuere Patchversion verfügbar ist. Als bewährte Methode sollten Sie alle Knotenpools in einem AKS-Cluster auf dieselbe Kubernetes-Version aktualisieren. Die Knotenpoolversion muss die gleiche Hauptversion haben wie die Steuerungsebene. Die Nebenversion des Knotenpools muss innerhalb von zwei Nebenversionen der Version der Steuerungsebene liegen. Die Version des Knotenpools darf nicht größer als die Version der Steuerungsebene sein. Weitere Informationen finden Sie unter Upgraden eines Knotenpools.
properties.osDiskSizeGB

integer

Betriebssystemdatenträgergröße in GB, die zum Angeben der Datenträgergröße für jeden Computer im master-/Agent-Pool verwendet werden soll. Wenn Sie 0 angeben, wird die standardmäßige osDisk-Größe gemäß dem angegebenen vmSize-Wert angewendet.
properties.osDiskType

OSDiskType

Der Betriebssystemdatenträgertyp, der für Computer im Agentpool verwendet werden soll.
Der Standardwert ist "Ephemeral", wenn die VM dies unterstützt und über einen Cachedatenträger verfügt, der größer als der angeforderte OSDiskSizeGB ist. Andernfalls wird standardmäßig "Verwaltet" festgelegt. Kann nach der Erstellung nicht geändert werden. Weitere Informationen finden Sie unter Kurzlebiges Betriebssystem.
properties.osSKU

OSSKU

Gibt die betriebssystem-SKU an, die vom Agentpool verwendet wird. Der Standardwert ist Ubuntu, wenn OSType Linux ist. Der Standardwert ist Windows2019, wenn Kubernetes <= 1,24 oder Windows2022, wenn Kubernetes >= 1,25 ist, wenn OSType Windows ist.
properties.osType

OSType

Der Betriebssystemtyp. Der Standardwert ist Linux.
properties.podSubnetID

string

Die ID des Subnetzes, dem pods beim Start beitreten.
Wenn nicht angegeben, werden Pod-IPs statisch im Knotensubnetz zugewiesen (weitere Informationen finden Sie unter vnetSubnetID). Dies hat folgendes Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState

PowerState

Gibt an, ob der Agentpool ausgeführt oder beendet wird.
Wenn ein Agentpool zum ersten Mal erstellt wird, wird er zunächst ausgeführt. Der Agentpool kann beendet werden, indem dieses Feld auf Beendet festgelegt wird. Ein beendeter Agentpool beendet alle seine VMs, und es fallen keine Abrechnungsgebühren an. Ein Agentpool kann nur beendet werden, wenn er wird ausgeführt und der Bereitstellungsstatus Erfolgreich ist.
properties.proximityPlacementGroupID

string

Die ID für Näherungsplatzierungsgruppe.
properties.scaleDownMode

ScaleDownMode

Der Herunterskalierungsmodus, der beim Skalieren des Agentpools verwendet werden soll.
Dies wirkt sich auch auf das Verhalten der automatischen Clusterskalierung aus. Wenn nicht angegeben, wird standardmäßig Delete verwendet.
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Die zu verwendende Richtlinie zum Entfernen der VM-Skalierungsgruppe.
Dies kann nur angegeben werden, wenn scaleSetPriority "Spot" lautet. Wenn nicht angegeben, ist der Standardwert "Delete".
properties.scaleSetPriority

ScaleSetPriority

Die Priorität der VM-Skalierungsgruppe. Wenn nicht angegeben, ist der Standardwert "Regular".
properties.spotMaxPrice

number

Der maximale Preis (in US-Dollar), den Sie für Spot-Instanzen bezahlen möchten. Mögliche Werte sind ein beliebiger Dezimalwert größer als 0 oder -1, der angibt, dass der Standardpreis bedarfsgesteuert ist.
Mögliche Werte sind ein beliebiger Dezimalwert größer als 0 oder -1, der die Bereitschaft angibt, einen bedarfsgesteuerten Preis zu zahlen. Weitere Informationen zu Spotpreisen finden Sie unter Spot-VMs – Preise.
properties.tags

object

Die Tags, die in der VM-Skalierungsgruppe des Agentpools beibehalten werden sollen.
properties.type

AgentPoolType

Der Typ des Agentpools.
properties.upgradeSettings

AgentPoolUpgradeSettings

Einstellungen für das Upgrade des Agentpools
properties.vmSize

string

Die Größe der VMs des Agentpools.
Die Verfügbarkeit der VM-Größe variiert je nach Region. Wenn ein Knoten unzureichende Computeressourcen (Arbeitsspeicher, CPU usw.) enthält, können Pods möglicherweise nicht ordnungsgemäß ausgeführt werden. Weitere Informationen zu eingeschränkten VM-Größen finden Sie unter: https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID

string

Die ID des Subnetzes, dem agentpoolknoten und optional Pods beim Start beitreten.
Wenn dies nicht angegeben ist, werden ein VNET und ein Subnetz generiert und verwendet. Wenn keine podSubnetID angegeben ist, gilt dies für Knoten und Pods, andernfalls gilt dies nur für Knoten. Dies hat die Form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile

AgentPoolWindowsProfile

Das spezifische Profil des Windows-Agent-Pools.
properties.workloadRuntime

WorkloadRuntime

Bestimmt den Typ der Workload, die ein Knoten ausführen kann.

Antworten

Name Typ Beschreibung
200 OK

AgentPool

Der vorhandene Agentpool wurde erfolgreich aktualisiert.
201 Created

AgentPool

Der neue Agentpool wurde erfolgreich erstellt.
Other Status Codes

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name Beschreibung
AgentPool

Agent-Pool.
AgentPoolMode

Der Modus eines Agentpools.
AgentPoolNetworkProfile

Netzwerkeinstellungen eines Agentpools.
AgentPoolType

Der Typ des Agentpools.
AgentPoolUpgradeSettings

Einstellungen für das Upgrade eines Agentpools
AgentPoolWindowsProfile

Das spezifische Profil des Windows-Agent-Pools.
CloudError

Eine Fehlerantwort des Containerdiensts.
CloudErrorBody

Eine Fehlerantwort des Containerdiensts.
code

Gibt an, ob der Cluster ausgeführt oder beendet ist.
CreationData

Daten, die beim Erstellen einer Zielressource aus einer Quellressource verwendet werden.
GPUInstanceProfile

GPUInstanceProfile, das zum Angeben des GPU-MIG-instance-Profils für unterstützte GPU-VM-SKU verwendet werden soll.
IPTag

Enthält das dem -Objekt zugeordnete IPTag.
KubeletConfig

Kubeletkonfigurationen von Agentknoten.
KubeletDiskType

Bestimmt die Platzierung von emptyDir-Volumes, Container Runtime-Datenstamm und kurzlebigem Kubelet-Speicher.
LinuxOSConfig

Betriebssystemkonfigurationen von Linux-Agent-Knoten.
OSDiskType

Der Betriebssystemdatenträgertyp, der für Computer im Agentpool verwendet werden soll.
OSSKU

Gibt die Betriebssystem-SKU an, die vom Agentpool verwendet wird. Der Standardwert ist Ubuntu, wenn OSType Linux ist. Der Standardwert ist Windows2019, wenn Kubernetes <= 1.24 oder Windows2022, wenn Kubernetes >= 1,25 ist, wenn OSType Windows ist.
OSType

Der Betriebssystemtyp. Der Standardwert ist Linux.
PortRange

Der Portbereich.
PowerState

Beschreibt den Energiestatus des Clusters.
Protocol

Das Netzwerkprotokoll des Ports.
ScaleDownMode

Beschreibt, wie VMs zu Agentpools hinzugefügt oder daraus entfernt werden. Siehe Abrechnungsstatus.
ScaleSetEvictionPolicy

Die Richtlinie zum Entfernen von VM-Skalierungsgruppen.
ScaleSetPriority

Die Vm-Skalierungssatzpriorität.
SysctlConfig

Sysctl-Einstellungen für Linux-Agent-Knoten.
WorkloadRuntime

Bestimmt den Typ der Workload, die ein Knoten ausführen kann.

AgentPool

Agent-Pool.

Name Typ Standardwert Beschreibung
id

string

Ressourcen-ID
name

string

Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.availabilityZones

string[]

Die Liste der Verfügbarkeitszonen, die für Knoten verwendet werden sollen. Dies kann nur angegeben werden, wenn die AgentPoolType-Eigenschaft "VirtualMachineScaleSets" lautet.
properties.capacityReservationGroupID

string

Die vollqualifizierte Ressourcen-ID der Kapazitätsreservierungsgruppe, um virtuelle Computer aus einer reservierten Gruppe von Virtual Machines bereitzustellen.
AKS ordnet den angegebenen Agentpool der Kapazitätsreservierungsgruppe zu.
properties.count

integer

Anzahl der Agents (VMs) zum Hosten von Docker-Containern. Zulässige Werte müssen im Bereich von 0 bis 1000 (einschließlich) für Benutzerpools und im Bereich von 1 bis 1000 (einschließlich) für Systempools liegen. Der Standardwert ist 1.
properties.creationData

CreationData

CreationData, das verwendet werden soll, um die Quellmomentaufnahme-ID anzugeben, wenn der Knotenpool mithilfe einer Momentaufnahme erstellt/aktualisiert wird.
properties.currentOrchestratorVersion

string

Die Version von Kubernetes, die der Agentpool ausführt.
Wenn orchestratorVersion eine vollständig angegebene Version <major.minor.patch> ist, ist dieses Feld genau gleich diesem Feld. Wenn orchestratorVersion den Wert major.minor> aufweist<, enthält dieses Feld die vollständige <verwendete "major.minor.patch>"-Version.
properties.enableAutoScaling

boolean

Ob die automatische Skalierung aktiviert werden soll
properties.enableEncryptionAtHost

boolean

Gibt an, ob die hostbasierte Betriebssystem- und Datenlaufwerkverschlüsselung aktiviert werden soll.
Dies wird nur für bestimmte VM-Größen und in bestimmten Azure-Regionen unterstützt. Weitere Informationen finden Sie unter: https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS

boolean

Gibt an, ob ein FIPS-fähiges Betriebssystem verwendet werden soll.
Weitere Informationen finden Sie unter Hinzufügen eines FIPS-fähigen Knotenpools .
properties.enableNodePublicIP

boolean

Gibt an, ob jedem Knoten eine eigene öffentliche IP-Adresse zugeordnet ist.
Einige Szenarien erfordern möglicherweise, dass Knoten in einem Knotenpool ihre eigenen dedizierten öffentlichen IP-Adressen empfangen. Ein häufiges Szenario hierfür sind Gamingworkloads, bei denen eine Konsole eine direkte Verbindung mit einem virtuellen Cloudcomputer herstellen muss, um Hops zu minimieren. Weitere Informationen finden Sie unter Zuweisen einer öffentlichen IP-Adresse pro Knoten. Die Standardeinstellung ist „false“.
properties.enableUltraSSD

boolean

Ob UltraSSD aktiviert werden soll
properties.gpuInstanceProfile

GPUInstanceProfile

GPUInstanceProfile, das zum Angeben des GPU-MIG-instance-Profils für die unterstützte GPU-VM-SKU verwendet werden soll.
properties.hostGroupID

string

Die vollqualifizierte Ressourcen-ID der dedizierten Hostgruppe zum Bereitstellen von virtuellen Computern, die nur im Erstellungsszenario verwendet wird und nicht geändert werden darf, sobald festgelegt wurde.
Dies hat folgendes Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Weitere Informationen finden Sie unter Dedizierte Azure-Hosts.
properties.kubeletConfig

KubeletConfig

Kubelet-Konfigurationen von Agentknoten.
Die Kubelet-Konfiguration auf den Agentpoolknoten.
properties.kubeletDiskType

KubeletDiskType

Bestimmt die Platzierung von emptyDir-Volumes, Container Runtime-Datenstamm und kurzlebigem Kubelet-Speicher.
properties.linuxOSConfig

LinuxOSConfig

Betriebssystemkonfigurationen von Linux-Agent-Knoten.
Die Betriebssystemkonfiguration von Linux-Agent-Knoten.
properties.maxCount

integer

Die maximale Anzahl von Knoten für die automatische Skalierung
properties.maxPods

integer

Die maximale Anzahl von Pods, die auf einem Knoten ausgeführt werden können.
properties.minCount

integer

Die Mindestanzahl von Knoten für die automatische Skalierung
properties.mode

AgentPoolMode

Der Modus eines Agentpools.
Ein Cluster muss jederzeit über mindestens einen System-Agentpool verfügen. Weitere Informationen zu Einschränkungen und bewährten Methoden für Agentpools finden Sie unter: https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile

AgentPoolNetworkProfile

Netzwerkbezogene Einstellungen eines Agentpools.
properties.nodeImageVersion

string

Die Version des Knotenimages
properties.nodeLabels

object

Die Knotenbezeichnungen, die auf allen Knoten im Agentpool beibehalten werden sollen.
properties.nodePublicIPPrefixID

string

Die präfix-ID der öffentlichen IP, von der VM-Knoten IP-Adressen verwenden sollen.
Dies hat folgendes Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints

string[]

Die beim Erstellen und Skalieren des Knotenpools neuen Knoten hinzugefügten Taints. Beispiel: key=value:NoSchedule.
properties.orchestratorVersion

string

Die vom Benutzer angegebene Kubernetes-Version.
Sowohl die Patchversion <major.minor.patch> (z.B. 1.20.13) als <auch die Hauptversion> (z. B. 1.20) werden unterstützt. Wenn <major.minor> angegeben wird, wird automatisch die neueste unterstützte GA-Patchversion ausgewählt. Das Aktualisieren des Clusters mit demselben <major.minor> , nachdem er erstellt wurde (z. B. 1.14.x bis> 1.14), löst kein Upgrade aus, selbst wenn eine neuere Patchversion verfügbar ist. Als bewährte Methode sollten Sie alle Knotenpools in einem AKS-Cluster auf dieselbe Kubernetes-Version aktualisieren. Die Knotenpoolversion muss die gleiche Hauptversion haben wie die Steuerungsebene. Die Nebenversion des Knotenpools muss innerhalb von zwei Nebenversionen der Version der Steuerungsebene liegen. Die Version des Knotenpools darf nicht größer als die Version der Steuerungsebene sein. Weitere Informationen finden Sie unter Upgraden eines Knotenpools.
properties.osDiskSizeGB

integer

Betriebssystemdatenträgergröße in GB, die zum Angeben der Datenträgergröße für jeden Computer im master-/Agent-Pool verwendet werden soll. Wenn Sie 0 angeben, wird die standardmäßige osDisk-Größe gemäß dem angegebenen vmSize-Wert angewendet.
properties.osDiskType

OSDiskType

Der Betriebssystemdatenträgertyp, der für Computer im Agentpool verwendet werden soll.
Der Standardwert ist "Ephemeral", wenn die VM dies unterstützt und über einen Cachedatenträger verfügt, der größer als der angeforderte OSDiskSizeGB ist. Andernfalls wird standardmäßig "Verwaltet" festgelegt. Kann nach der Erstellung nicht geändert werden. Weitere Informationen finden Sie unter Kurzlebiges Betriebssystem.
properties.osSKU

OSSKU

Gibt die Betriebssystem-SKU an, die vom Agentpool verwendet wird. Der Standardwert ist Ubuntu, wenn OSType Linux ist. Der Standardwert ist Windows2019, wenn Kubernetes <= 1.24 oder Windows2022, wenn Kubernetes >= 1,25 ist, wenn OSType Windows ist.
properties.osType

OSType

Linux

Der Betriebssystemtyp. Der Standardwert ist Linux.
properties.podSubnetID

string

Die ID des Subnetzes, dem pods beim Start beitreten werden.
Wenn nicht angegeben, werden Pod-IPs statisch im Knotensubnetz zugewiesen (weitere Details finden Sie unter vnetSubnetID). Dies hat die Form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState

PowerState

Gibt an, ob der Agentpool ausgeführt oder beendet wird.
Wenn ein Agentpool zum ersten Mal erstellt wird, wird er zunächst ausgeführt. Der Agentpool kann beendet werden, indem dieses Feld auf Beendet festgelegt wird. Ein beendeter Agentpool beendet alle seine VMs, und es fallen keine Abrechnungsgebühren an. Ein Agentpool kann nur beendet werden, wenn er wird ausgeführt und der Bereitstellungsstatus Erfolgreich ist.
properties.provisioningState

string

Der aktuelle Bereitstellungs- oder Bereitstellungsstatus.
properties.proximityPlacementGroupID

string

Die ID für Näherungsplatzierungsgruppe.
properties.scaleDownMode

ScaleDownMode

Der Herunterskalierungsmodus, der beim Skalieren des Agentpools verwendet werden soll.
Dies wirkt sich auch auf das Verhalten der automatischen Clusterskalierung aus. Wenn nicht angegeben, wird standardmäßig Delete verwendet.
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Delete

Die zu verwendende Richtlinie zum Entfernen der VM-Skalierungsgruppe.
Dies kann nur angegeben werden, wenn scaleSetPriority "Spot" lautet. Wenn nicht angegeben, ist der Standardwert "Delete".
properties.scaleSetPriority

ScaleSetPriority

Regular

Die Priorität der VM-Skalierungsgruppe. Wenn nicht angegeben, ist der Standardwert "Regular".
properties.spotMaxPrice

number

-1

Der maximale Preis (in US-Dollar), den Sie für Spot-Instanzen bezahlen möchten. Mögliche Werte sind ein beliebiger Dezimalwert größer als 0 oder -1, der angibt, dass der Standardpreis bedarfsgesteuert ist.
Mögliche Werte sind ein beliebiger Dezimalwert größer als 0 oder -1, der die Bereitschaft angibt, einen bedarfsgesteuerten Preis zu zahlen. Weitere Informationen zu Spotpreisen finden Sie unter Spot-VMs – Preise.
properties.tags

object

Die Tags, die in der VM-Skalierungsgruppe des Agentpools beibehalten werden sollen.
properties.type

AgentPoolType

Der Typ des Agentpools.
properties.upgradeSettings

AgentPoolUpgradeSettings

Einstellungen für das Upgrade des Agentpools
properties.vmSize

string

Die Größe der VMs des Agentpools.
Die Verfügbarkeit der VM-Größe variiert je nach Region. Wenn ein Knoten unzureichende Computeressourcen (Arbeitsspeicher, CPU usw.) enthält, können Pods möglicherweise nicht ordnungsgemäß ausgeführt werden. Weitere Informationen zu eingeschränkten VM-Größen finden Sie unter: https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID

string

Die ID des Subnetzes, dem agentpoolknoten und optional Pods beim Start beitreten.
Wenn dies nicht angegeben ist, werden ein VNET und ein Subnetz generiert und verwendet. Wenn keine podSubnetID angegeben ist, gilt dies für Knoten und Pods, andernfalls gilt dies nur für Knoten. Dies hat die Form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile

AgentPoolWindowsProfile

Das spezifische Profil des Windows-Agent-Pools.
properties.workloadRuntime

WorkloadRuntime

Bestimmt den Typ der Workload, die ein Knoten ausführen kann.
type

string

Ressourcentyp

AgentPoolMode

Der Modus eines Agentpools.

Name Typ Beschreibung
System

string

System-Agent-Pools dienen in erster Linie zum Hosten kritischer Systempods wie CoreDNS und metrics-server. OsType für System-Agent-Pools muss Linux sein. Die VM-SKU für System-Agent-Pools muss über mindestens 2 vCPUs und 4 GB Arbeitsspeicher verfügen.
User

string

Benutzer-Agent-Pools dienen in erster Linie zum Hosten Ihrer Anwendungspods.

AgentPoolNetworkProfile

Netzwerkeinstellungen eines Agentpools.

Name Typ Beschreibung
allowedHostPorts

PortRange[]

Die Portbereiche, auf die zugegriffen werden darf. Die angegebenen Bereiche dürfen sich überlappen.
applicationSecurityGroups

string[]

Die IDs der Anwendungssicherheitsgruppen, denen der Agentpool bei der Erstellung zugeordnet wird.
nodePublicIPTags

IPTag[]

IPTags von öffentlichen IP-Adressen auf instance-Ebene.

AgentPoolType

Der Typ des Agentpools.

Name Typ Beschreibung
AvailabilitySet

string

Davon wird dringend abgeraten.
VirtualMachineScaleSets

string

Erstellen Sie einen Agentpool, der von einer VM-Skalierungsgruppe unterstützt wird.

AgentPoolUpgradeSettings

Einstellungen für das Upgrade eines Agentpools

Name Typ Beschreibung
drainTimeoutInMinutes

integer

Das Entwässerungstimeout für einen Knoten
Die Zeitspanne (in Minuten), die auf die Entfernung von Pods und die ordnungsgemäße Beendigung pro Knoten gewartet werden muss. Diese Wartezeit für die Entfernung honoriert das Warten auf Podunterbrechungsbudgets. Wenn diese Zeit überschritten wird, schlägt das Upgrade fehl. Wenn nicht angegeben, ist der Standardwert 30 Minuten.
maxSurge

string

Die maximale Anzahl oder prozentuale Anzahl von Knoten, die während des Upgrades hochsupiert werden.
Dies kann entweder auf eine ganze Zahl (z. B. "5") oder auf einen Prozentsatz (z. B. "50%") festgelegt werden. Wenn ein Prozentsatz angegeben wird, ist dies der Prozentsatz der gesamten Agentpoolgröße zum Zeitpunkt des Upgrades. Für Prozentwerte werden Bruchknoten aufgerundet. Wenn nichts angegeben ist, wird der Standardwert 1 verwendet. Weitere Informationen, einschließlich bewährter Methoden, finden Sie unter: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade
nodeSoakDurationInMinutes

integer

Die Dauer des Einweichens für einen Knoten
Die Zeit (in Minuten), die nach dem Entladen eines Knotens und vor dem Erneuten Ändern des Knotens und dem Wechsel zum nächsten Knoten gewartet werden muss. Wenn nicht angegeben, ist der Standardwert 0 Minuten.

AgentPoolWindowsProfile

Das spezifische Profil des Windows-Agent-Pools.

Name Typ Beschreibung
disableOutboundNat

boolean

Ob OutboundNAT in Windows-Knoten deaktiviert werden soll
Der Standardwert ist „FALSE“. Outbound NAT kann nur deaktiviert werden, wenn der Cluster outboundType NAT-Gateway ist und der Windows-Agent-Pool keine öffentliche Knoten-IP aktiviert hat.

CloudError

Eine Fehlerantwort des Containerdiensts.

Name Typ Beschreibung
error

CloudErrorBody

Details zum Fehler.

CloudErrorBody

Eine Fehlerantwort des Containerdiensts.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
details

CloudErrorBody[]

Eine Liste mit zusätzlichen Details zum Fehler.
message

string

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
target

string

Das Ziel des jeweiligen Fehlers. Beispiel: Der Name der -Eigenschaft im Fehler.

code

Gibt an, ob der Cluster ausgeführt oder beendet ist.

Name Typ Beschreibung
Running

string

Der Cluster wird ausgeführt.
Stopped

string

Der Cluster wird beendet.

CreationData

Daten, die beim Erstellen einer Zielressource aus einer Quellressource verwendet werden.

Name Typ Beschreibung
sourceResourceId

string

Dies ist die ARM-ID des Quellobjekts, das zum Erstellen des Zielobjekts verwendet werden soll.

GPUInstanceProfile

GPUInstanceProfile, das zum Angeben des GPU-MIG-instance-Profils für unterstützte GPU-VM-SKU verwendet werden soll.

Name Typ Beschreibung
MIG1g

string

MIG2g

string

MIG3g

string

MIG4g

string

MIG7g

string

IPTag

Enthält das dem -Objekt zugeordnete IPTag.

Name Typ Beschreibung
ipTagType

string

Der IP-Tagtyp. Beispiel: RoutingPreference.
tag

string

Der Wert des IP-Tags, das der öffentlichen IP-Adresse zugeordnet ist. Beispiel: Internet.

KubeletConfig

Kubeletkonfigurationen von Agentknoten.

Name Typ Beschreibung
allowedUnsafeSysctls

string[]

Liste mit unsicheren sysctls oder unsicheren Sysctl-Mustern zulässig (endet auf *).
containerLogMaxFiles

integer

Die maximale Anzahl von Containerprotokolldateien, die für einen Container vorhanden sein können Die Zahl muss ≥ 2 sein.
containerLogMaxSizeMB

integer

Die maximale Größe (z. B. 10Mi) der Containerprotokolldatei, bevor sie gedreht wird.
cpuCfsQuota

boolean

Wenn die Erzwingung von CPU-CFS-Kontingenten für Container aktiviert ist, die CPU-Grenzwerte angeben.
Der Standardwert ist „true“.
cpuCfsQuotaPeriod

string

Der Wert des CPU-CFS-Kontingentzeitraums.
Der Standardwert ist "100ms". Gültige Werte sind eine Sequenz von Dezimalzahlen mit einem optionalen Bruch und einem Einheitensuffix. Beispiel: "300ms", "2h45m". Unterstützte Einheiten sind "ns", "us", "ms", "s", "m" und "h".
cpuManagerPolicy

string

Die zu verwendende CPU-Manager-Richtlinie.
Der Standardwert ist "none". Weitere Informationen finden Sie unter Kubernetes CPU-Verwaltungsrichtlinien . Zulässige Werte sind "none" und "static".
failSwapOn

boolean

Wenn der Wert auf true festgelegt ist, kann kubelet nicht gestartet werden, wenn der Austausch auf dem Knoten aktiviert ist.
imageGcHighThreshold

integer

Der Prozentsatz der Datenträgerauslastung, nach der die Image-Garbage Collection immer ausgeführt wird.
Legen Sie den Wert zum Deaktivieren von Image-Garbage Collection auf 100 fest. Der Standardwert ist 85 %.
imageGcLowThreshold

integer

Der Prozentsatz der Datenträgerauslastung, vor der die Image-Garbage Collection nie ausgeführt wird.
Dies kann nicht höher als imageGcHighThreshold festgelegt werden. Der Standardwert ist 80 %.
podMaxPids

integer

Die maximale Anzahl von Prozessen pro Pod.
topologyManagerPolicy

string

Die zu verwendende Topologie-Manager-Richtlinie.
Weitere Informationen finden Sie unter Kubernetes-Topologie-Manager. Der Standardwert ist "none". Zulässige Werte sind "none", "best-effort", "restricted" und "single-numa-node".

KubeletDiskType

Bestimmt die Platzierung von emptyDir-Volumes, Container Runtime-Datenstamm und kurzlebigem Kubelet-Speicher.

Name Typ Beschreibung
OS

string

Kubelet verwendet den Betriebssystemdatenträger.
Temporary

string

Kubelet verwendet den temporären Datenträger für seine Daten.

LinuxOSConfig

Betriebssystemkonfigurationen von Linux-Agent-Knoten.

Name Typ Beschreibung
swapFileSizeMB

integer

Die Größe einer Auslagerungsdatei in MB, die auf jedem Knoten erstellt wird.
sysctls

SysctlConfig

Sysctl-Einstellungen für Linux-Agent-Knoten.
transparentHugePageDefrag

string

Gibt an, ob der Kernel die Speicherkomprimierung aggressiv nutzen sollte, um mehr riesige Seiten verfügbar zu machen.
Gültige Werte sind "always", "defer", "defer+madvise", "madvise" und "never". Der Standardwert ist "madvise". Weitere Informationen finden Sie unter Transparent Hugepages.
transparentHugePageEnabled

string

Gibt an, ob transparente hugepages aktiviert sind.
Gültige Werte sind "always", "madvise" und "never". Der Standardwert ist "always". Weitere Informationen finden Sie unter Transparent Hugepages.

OSDiskType

Der Betriebssystemdatenträgertyp, der für Computer im Agentpool verwendet werden soll.

Name Typ Beschreibung
Ephemeral

string

Kurzlebige Betriebssystemdatenträger werden wie ein temporärer Datenträger nur auf dem Hostcomputer gespeichert. Dies führt zu einer geringeren Wartezeit bei Lese-/Schreibvorgängen und ermöglicht eine schnellere Knotenskalierung sowie schnellere Clusterupgrades.
Managed

string

Azure repliziert den Betriebssystemdatenträger für einen virtuellen Computer in Azure Storage, um Datenverluste zu vermeiden, falls die VM auf einen anderen Host verschoben werden muss. Da Container nicht so konzipiert sind, dass der lokale Zustand beibehalten wird, bietet dieses Verhalten einen begrenzten Wert und bietet einige Nachteile, einschließlich einer langsameren Knotenbereitstellung und einer höheren Lese-/Schreiblatenz.

OSSKU

Gibt die Betriebssystem-SKU an, die vom Agentpool verwendet wird. Der Standardwert ist Ubuntu, wenn OSType Linux ist. Der Standardwert ist Windows2019, wenn Kubernetes <= 1.24 oder Windows2022, wenn Kubernetes >= 1,25 ist, wenn OSType Windows ist.

Name Typ Beschreibung
AzureLinux

string

Verwenden Sie AzureLinux als Betriebssystem für Knotenimages. Azure Linux ist eine containeroptimierte Linux-Distribution, die von Microsoft erstellt wurde. Weitere Informationen finden Sie unter https://aka.ms/azurelinux .
CBLMariner

string

OSSKU ist veraltet. Microsoft empfiehlt, dass neue Bereitstellungen stattdessen "AzureLinux" auswählen.
Ubuntu

string

Verwenden Sie Ubuntu als Betriebssystem für Knotenimages.
Windows2019

string

Verwenden Sie Windows2019 als Betriebssystem für Knotenimages. Wird für Systemknotenpools nicht unterstützt. Windows2019 unterstützt nur Windows2019-Container. Windows2022-Container können nicht ausgeführt werden und umgekehrt.
Windows2022

string

Verwenden Sie Windows2022 als Betriebssystem für Knotenimages. Wird für Systemknotenpools nicht unterstützt. Windows2022 unterstützt nur Windows2022-Container. Windows2019-Container können nicht ausgeführt werden und umgekehrt.

OSType

Der Betriebssystemtyp. Der Standardwert ist Linux.

Name Typ Beschreibung
Linux

string

Verwenden Sie Linux.
Windows

string

Verwenden Sie Windows.

PortRange

Der Portbereich.

Name Typ Beschreibung
portEnd

integer

Der maximale Port, der im Bereich enthalten ist. Sie sollte zwischen 1 und 65535 liegen und größer oder gleich portStart sein.
portStart

integer

Der Mindestport, der im Bereich enthalten ist. Sie sollte zwischen 1 und 65535 liegen und kleiner oder gleich portEnd sein.
protocol

Protocol

Das Netzwerkprotokoll des Ports.

PowerState

Beschreibt den Energiestatus des Clusters.

Name Typ Beschreibung
code

code

Gibt an, ob der Cluster ausgeführt oder beendet ist.

Protocol

Das Netzwerkprotokoll des Ports.

Name Typ Beschreibung
TCP

string

TCP-Protokoll.
UDP

string

UDP-Protokoll.

ScaleDownMode

Beschreibt, wie VMs zu Agentpools hinzugefügt oder daraus entfernt werden. Siehe Abrechnungsstatus.

Name Typ Beschreibung
Deallocate

string

Versuchen Sie, die zugeordneten Instanzen (sofern vorhanden) während des Hochskalierens und Der Zuordnung von Instanzen während des Herunterskalierens zu starten.
Delete

string

Erstellen Sie während des Hochskalierens neue Instanzen, und entfernen Sie Instanzen während des Herunterskalierens.

ScaleSetEvictionPolicy

Die Richtlinie zum Entfernen von VM-Skalierungsgruppen.

Name Typ Beschreibung
Deallocate

string

Knoten im zugrunde liegenden Skalierungssatz des Knotenpools werden beim Entfernen auf den Status beendet-zugeordnet festgelegt. Knoten im Zustand „Beendet/Zuordnung aufgehoben“ werden auf Ihr Computekontingent angerechnet und können Probleme bei der Skalierung oder dem Upgrade von Clustern verursachen.
Delete

string

Knoten im zugrunde liegenden Skalierungssatz des Knotenpools werden gelöscht, wenn sie entfernt werden.

ScaleSetPriority

Die Vm-Skalierungssatzpriorität.

Name Typ Beschreibung
Regular

string

Es werden reguläre VMs verwendet.
Spot

string

VMs mit Spotpriorität werden verwendet. Es gibt keine SLA für Spotknoten. Weitere Informationen finden Sie unter spot on AKS .

SysctlConfig

Sysctl-Einstellungen für Linux-Agent-Knoten.

Name Typ Beschreibung
fsAioMaxNr

integer

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

integer

Sysctl-Einstellung fs.file-max.
fsInotifyMaxUserWatches

integer

Sysctl-Einstellung fs.inotify.max_user_watches.
fsNrOpen

integer

Sysctl-Einstellung fs.nr_open.
kernelThreadsMax

integer

Sysctl-Einstellung kernel.threads-max.
netCoreNetdevMaxBacklog

integer

Sysctl-Einstellung net.core.netdev_max_backlog.
netCoreOptmemMax

integer

Sysctl-Einstellung net.core.optmem_max.
netCoreRmemDefault

integer

Sysctl-Einstellung net.core.rmem_default.
netCoreRmemMax

integer

Sysctl-Einstellung net.core.rmem_max.
netCoreSomaxconn

integer

Sysctl-Einstellung net.core.somaxconn.
netCoreWmemDefault

integer

Sysctl-Einstellung net.core.wmem_default.
netCoreWmemMax

integer

Sysctl-Einstellung net.core.wmem_max.
netIpv4IpLocalPortRange

string

Sysctl-Einstellung net.ipv4.ip_local_port_range.
netIpv4NeighDefaultGcThresh1

integer

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

integer

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

integer

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

integer

Sysctl-Einstellung net.ipv4.tcp_fin_timeout.
netIpv4TcpKeepaliveProbes

integer

Sysctl-Einstellung net.ipv4.tcp_keepalive_probes.
netIpv4TcpKeepaliveTime

integer

Sysctl-Einstellung net.ipv4.tcp_keepalive_time.
netIpv4TcpMaxSynBacklog

integer

Sysctl-Einstellung net.ipv4.tcp_max_syn_backlog.
netIpv4TcpMaxTwBuckets

integer

Sysctl-Einstellung net.ipv4.tcp_max_tw_buckets.
netIpv4TcpTwReuse

boolean

Sysctl-Einstellung net.ipv4.tcp_tw_reuse.
netIpv4TcpkeepaliveIntvl

integer

Sysctl-Einstellung net.ipv4.tcp_keepalive_intvl.
netNetfilterNfConntrackBuckets

integer

Sysctl-Einstellung net.netfilter.nf_conntrack_buckets.
netNetfilterNfConntrackMax

integer

Sysctl-Einstellung net.netfilter.nf_conntrack_max.
vmMaxMapCount

integer

Sysctl-Einstellung vm.max_map_count.
vmSwappiness

integer

Sysctl-Einstellung vm.swappiness.
vmVfsCachePressure

integer

Sysctl-Einstellung vm.vfs_cache_pressure.

WorkloadRuntime

Bestimmt den Typ der Workload, die ein Knoten ausführen kann.

Name Typ Beschreibung
OCIContainer

string

Knoten verwenden Kubelet zum Ausführen von OCI-Standardcontainerworkloads.
WasmWasi

string

Knoten verwenden Krustlet zum Ausführen von WASM-Workloads mithilfe des WASI-Anbieters (Vorschau).