Microsoft.ContainerService (stable:2024-10-01)

2025/02/21 • 4 updated methods

AgentPools_List (updated)
Description Gets a list of agent pools in the specified managed cluster.
Reference Link ¶

⚶ Changes

{
  "#id": "AgentPools_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "upgradeSettings": [
                  {
                    "#name": "maxSurge",
                    "Description": {
                      "new": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade",
                      "old": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade"
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
resourceName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
eTag: string ,
count: integer ,
vmSize: string ,
osDiskSizeGB: integer ,
osDiskType: enum ,
kubeletDiskType: enum ,
workloadRuntime: enum ,
messageOfTheDay: string ,
vnetSubnetID: string ,
podSubnetID: string ,
maxPods: integer ,
osType: enum ,
osSKU: enum ,
maxCount: integer ,
minCount: integer ,
enableAutoScaling: boolean ,
scaleDownMode: enum ,
type: enum ,
mode: enum ,
orchestratorVersion: string ,
currentOrchestratorVersion: string ,
nodeImageVersion: string ,
upgradeSettings:
{
maxSurge: string ,
drainTimeoutInMinutes: integer ,
nodeSoakDurationInMinutes: integer ,
}
,
provisioningState: string ,
powerState:
{
code: enum ,
}
,
availabilityZones:
[
string ,
]
,
enableNodePublicIP: boolean ,
nodePublicIPPrefixID: string ,
scaleSetPriority: enum ,
scaleSetEvictionPolicy: enum ,
spotMaxPrice: number ,
tags: object ,
nodeLabels: object ,
nodeTaints:
[
string ,
]
,
proximityPlacementGroupID: string ,
kubeletConfig:
{
cpuManagerPolicy: string ,
cpuCfsQuota: boolean ,
cpuCfsQuotaPeriod: string ,
imageGcHighThreshold: integer ,
imageGcLowThreshold: integer ,
topologyManagerPolicy: string ,
allowedUnsafeSysctls:
[
string ,
]
,
failSwapOn: boolean ,
containerLogMaxSizeMB: integer ,
containerLogMaxFiles: integer ,
podMaxPids: integer ,
}
,
linuxOSConfig:
{
sysctls:
{
netCoreSomaxconn: integer ,
netCoreNetdevMaxBacklog: integer ,
netCoreRmemDefault: integer ,
netCoreRmemMax: integer ,
netCoreWmemDefault: integer ,
netCoreWmemMax: integer ,
netCoreOptmemMax: integer ,
netIpv4TcpMaxSynBacklog: integer ,
netIpv4TcpMaxTwBuckets: integer ,
netIpv4TcpFinTimeout: integer ,
netIpv4TcpKeepaliveTime: integer ,
netIpv4TcpKeepaliveProbes: integer ,
netIpv4TcpkeepaliveIntvl: integer ,
netIpv4TcpTwReuse: boolean ,
netIpv4IpLocalPortRange: string ,
netIpv4NeighDefaultGcThresh1: integer ,
netIpv4NeighDefaultGcThresh2: integer ,
netIpv4NeighDefaultGcThresh3: integer ,
netNetfilterNfConntrackMax: integer ,
netNetfilterNfConntrackBuckets: integer ,
fsInotifyMaxUserWatches: integer ,
fsFileMax: integer ,
fsAioMaxNr: integer ,
fsNrOpen: integer ,
kernelThreadsMax: integer ,
vmMaxMapCount: integer ,
vmSwappiness: integer ,
vmVfsCachePressure: integer ,
}
,
transparentHugePageEnabled: string ,
transparentHugePageDefrag: string ,
swapFileSizeMB: integer ,
}
,
enableEncryptionAtHost: boolean ,
enableUltraSSD: boolean ,
enableFIPS: boolean ,
gpuInstanceProfile: enum ,
creationData:
{
sourceResourceId: string ,
}
,
capacityReservationGroupID: string ,
hostGroupID: string ,
networkProfile:
{
nodePublicIPTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
allowedHostPorts:
[
{
portStart: integer ,
portEnd: integer ,
protocol: enum ,
}
,
]
,
applicationSecurityGroups:
[
string ,
]
,
}
,
windowsProfile:
{
disableOutboundNat: boolean ,
}
,
securityProfile:
{
enableVTPM: boolean ,
enableSecureBoot: boolean ,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
AgentPools_Get (updated)
Description Gets the specified managed cluster agent pool.
Reference Link ¶

⚶ Changes

{
  "#id": "AgentPools_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "upgradeSettings": [
              {
                "#name": "maxSurge",
                "Description": {
                  "new": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade",
                  "old": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
resourceName: string ,
agentPoolName: string ,
}

⚐ Response (200)

{
properties:
{
eTag: string ,
count: integer ,
vmSize: string ,
osDiskSizeGB: integer ,
osDiskType: enum ,
kubeletDiskType: enum ,
workloadRuntime: enum ,
messageOfTheDay: string ,
vnetSubnetID: string ,
podSubnetID: string ,
maxPods: integer ,
osType: enum ,
osSKU: enum ,
maxCount: integer ,
minCount: integer ,
enableAutoScaling: boolean ,
scaleDownMode: enum ,
type: enum ,
mode: enum ,
orchestratorVersion: string ,
currentOrchestratorVersion: string ,
nodeImageVersion: string ,
upgradeSettings:
{
maxSurge: string ,
drainTimeoutInMinutes: integer ,
nodeSoakDurationInMinutes: integer ,
}
,
provisioningState: string ,
powerState:
{
code: enum ,
}
,
availabilityZones:
[
string ,
]
,
enableNodePublicIP: boolean ,
nodePublicIPPrefixID: string ,
scaleSetPriority: enum ,
scaleSetEvictionPolicy: enum ,
spotMaxPrice: number ,
tags: object ,
nodeLabels: object ,
nodeTaints:
[
string ,
]
,
proximityPlacementGroupID: string ,
kubeletConfig:
{
cpuManagerPolicy: string ,
cpuCfsQuota: boolean ,
cpuCfsQuotaPeriod: string ,
imageGcHighThreshold: integer ,
imageGcLowThreshold: integer ,
topologyManagerPolicy: string ,
allowedUnsafeSysctls:
[
string ,
]
,
failSwapOn: boolean ,
containerLogMaxSizeMB: integer ,
containerLogMaxFiles: integer ,
podMaxPids: integer ,
}
,
linuxOSConfig:
{
sysctls:
{
netCoreSomaxconn: integer ,
netCoreNetdevMaxBacklog: integer ,
netCoreRmemDefault: integer ,
netCoreRmemMax: integer ,
netCoreWmemDefault: integer ,
netCoreWmemMax: integer ,
netCoreOptmemMax: integer ,
netIpv4TcpMaxSynBacklog: integer ,
netIpv4TcpMaxTwBuckets: integer ,
netIpv4TcpFinTimeout: integer ,
netIpv4TcpKeepaliveTime: integer ,
netIpv4TcpKeepaliveProbes: integer ,
netIpv4TcpkeepaliveIntvl: integer ,
netIpv4TcpTwReuse: boolean ,
netIpv4IpLocalPortRange: string ,
netIpv4NeighDefaultGcThresh1: integer ,
netIpv4NeighDefaultGcThresh2: integer ,
netIpv4NeighDefaultGcThresh3: integer ,
netNetfilterNfConntrackMax: integer ,
netNetfilterNfConntrackBuckets: integer ,
fsInotifyMaxUserWatches: integer ,
fsFileMax: integer ,
fsAioMaxNr: integer ,
fsNrOpen: integer ,
kernelThreadsMax: integer ,
vmMaxMapCount: integer ,
vmSwappiness: integer ,
vmVfsCachePressure: integer ,
}
,
transparentHugePageEnabled: string ,
transparentHugePageDefrag: string ,
swapFileSizeMB: integer ,
}
,
enableEncryptionAtHost: boolean ,
enableUltraSSD: boolean ,
enableFIPS: boolean ,
gpuInstanceProfile: enum ,
creationData:
{
sourceResourceId: string ,
}
,
capacityReservationGroupID: string ,
hostGroupID: string ,
networkProfile:
{
nodePublicIPTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
allowedHostPorts:
[
{
portStart: integer ,
portEnd: integer ,
protocol: enum ,
}
,
]
,
applicationSecurityGroups:
[
string ,
]
,
}
,
windowsProfile:
{
disableOutboundNat: boolean ,
}
,
securityProfile:
{
enableVTPM: boolean ,
enableSecureBoot: boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
AgentPools_CreateOrUpdate (updated)
Description Creates or updates an agent pool in the specified managed cluster.
Reference Link ¶

⚶ Changes

{
  "#id": "AgentPools_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "upgradeSettings": [
              {
                "#name": "maxSurge",
                "Description": {
                  "new": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade",
                  "old": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade"
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "upgradeSettings": [
              {
                "#name": "maxSurge",
                "Description": {
                  "new": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade",
                  "old": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade"
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "upgradeSettings": [
              {
                "#name": "maxSurge",
                "Description": {
                  "new": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade",
                  "old": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
resourceName: string ,
agentPoolName: string ,
parameters:
{
properties:
{
eTag: string ,
count: integer ,
vmSize: string ,
osDiskSizeGB: integer ,
osDiskType: enum ,
kubeletDiskType: enum ,
workloadRuntime: enum ,
messageOfTheDay: string ,
vnetSubnetID: string ,
podSubnetID: string ,
maxPods: integer ,
osType: enum ,
osSKU: enum ,
maxCount: integer ,
minCount: integer ,
enableAutoScaling: boolean ,
scaleDownMode: enum ,
type: enum ,
mode: enum ,
orchestratorVersion: string ,
currentOrchestratorVersion: string ,
nodeImageVersion: string ,
upgradeSettings:
{
maxSurge: string ,
drainTimeoutInMinutes: integer ,
nodeSoakDurationInMinutes: integer ,
}
,
provisioningState: string ,
powerState:
{
code: enum ,
}
,
availabilityZones:
[
string ,
]
,
enableNodePublicIP: boolean ,
nodePublicIPPrefixID: string ,
scaleSetPriority: enum ,
scaleSetEvictionPolicy: enum ,
spotMaxPrice: number ,
tags: object ,
nodeLabels: object ,
nodeTaints:
[
string ,
]
,
proximityPlacementGroupID: string ,
kubeletConfig:
{
cpuManagerPolicy: string ,
cpuCfsQuota: boolean ,
cpuCfsQuotaPeriod: string ,
imageGcHighThreshold: integer ,
imageGcLowThreshold: integer ,
topologyManagerPolicy: string ,
allowedUnsafeSysctls:
[
string ,
]
,
failSwapOn: boolean ,
containerLogMaxSizeMB: integer ,
containerLogMaxFiles: integer ,
podMaxPids: integer ,
}
,
linuxOSConfig:
{
sysctls:
{
netCoreSomaxconn: integer ,
netCoreNetdevMaxBacklog: integer ,
netCoreRmemDefault: integer ,
netCoreRmemMax: integer ,
netCoreWmemDefault: integer ,
netCoreWmemMax: integer ,
netCoreOptmemMax: integer ,
netIpv4TcpMaxSynBacklog: integer ,
netIpv4TcpMaxTwBuckets: integer ,
netIpv4TcpFinTimeout: integer ,
netIpv4TcpKeepaliveTime: integer ,
netIpv4TcpKeepaliveProbes: integer ,
netIpv4TcpkeepaliveIntvl: integer ,
netIpv4TcpTwReuse: boolean ,
netIpv4IpLocalPortRange: string ,
netIpv4NeighDefaultGcThresh1: integer ,
netIpv4NeighDefaultGcThresh2: integer ,
netIpv4NeighDefaultGcThresh3: integer ,
netNetfilterNfConntrackMax: integer ,
netNetfilterNfConntrackBuckets: integer ,
fsInotifyMaxUserWatches: integer ,
fsFileMax: integer ,
fsAioMaxNr: integer ,
fsNrOpen: integer ,
kernelThreadsMax: integer ,
vmMaxMapCount: integer ,
vmSwappiness: integer ,
vmVfsCachePressure: integer ,
}
,
transparentHugePageEnabled: string ,
transparentHugePageDefrag: string ,
swapFileSizeMB: integer ,
}
,
enableEncryptionAtHost: boolean ,
enableUltraSSD: boolean ,
enableFIPS: boolean ,
gpuInstanceProfile: enum ,
creationData:
{
sourceResourceId: string ,
}
,
capacityReservationGroupID: string ,
hostGroupID: string ,
networkProfile:
{
nodePublicIPTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
allowedHostPorts:
[
{
portStart: integer ,
portEnd: integer ,
protocol: enum ,
}
,
]
,
applicationSecurityGroups:
[
string ,
]
,
}
,
windowsProfile:
{
disableOutboundNat: boolean ,
}
,
securityProfile:
{
enableVTPM: boolean ,
enableSecureBoot: boolean ,
}
,
}
,
}
,
If-Match: string ,
If-None-Match: string ,
}

⚐ Response (200)

{
properties:
{
eTag: string ,
count: integer ,
vmSize: string ,
osDiskSizeGB: integer ,
osDiskType: enum ,
kubeletDiskType: enum ,
workloadRuntime: enum ,
messageOfTheDay: string ,
vnetSubnetID: string ,
podSubnetID: string ,
maxPods: integer ,
osType: enum ,
osSKU: enum ,
maxCount: integer ,
minCount: integer ,
enableAutoScaling: boolean ,
scaleDownMode: enum ,
type: enum ,
mode: enum ,
orchestratorVersion: string ,
currentOrchestratorVersion: string ,
nodeImageVersion: string ,
upgradeSettings:
{
maxSurge: string ,
drainTimeoutInMinutes: integer ,
nodeSoakDurationInMinutes: integer ,
}
,
provisioningState: string ,
powerState:
{
code: enum ,
}
,
availabilityZones:
[
string ,
]
,
enableNodePublicIP: boolean ,
nodePublicIPPrefixID: string ,
scaleSetPriority: enum ,
scaleSetEvictionPolicy: enum ,
spotMaxPrice: number ,
tags: object ,
nodeLabels: object ,
nodeTaints:
[
string ,
]
,
proximityPlacementGroupID: string ,
kubeletConfig:
{
cpuManagerPolicy: string ,
cpuCfsQuota: boolean ,
cpuCfsQuotaPeriod: string ,
imageGcHighThreshold: integer ,
imageGcLowThreshold: integer ,
topologyManagerPolicy: string ,
allowedUnsafeSysctls:
[
string ,
]
,
failSwapOn: boolean ,
containerLogMaxSizeMB: integer ,
containerLogMaxFiles: integer ,
podMaxPids: integer ,
}
,
linuxOSConfig:
{
sysctls:
{
netCoreSomaxconn: integer ,
netCoreNetdevMaxBacklog: integer ,
netCoreRmemDefault: integer ,
netCoreRmemMax: integer ,
netCoreWmemDefault: integer ,
netCoreWmemMax: integer ,
netCoreOptmemMax: integer ,
netIpv4TcpMaxSynBacklog: integer ,
netIpv4TcpMaxTwBuckets: integer ,
netIpv4TcpFinTimeout: integer ,
netIpv4TcpKeepaliveTime: integer ,
netIpv4TcpKeepaliveProbes: integer ,
netIpv4TcpkeepaliveIntvl: integer ,
netIpv4TcpTwReuse: boolean ,
netIpv4IpLocalPortRange: string ,
netIpv4NeighDefaultGcThresh1: integer ,
netIpv4NeighDefaultGcThresh2: integer ,
netIpv4NeighDefaultGcThresh3: integer ,
netNetfilterNfConntrackMax: integer ,
netNetfilterNfConntrackBuckets: integer ,
fsInotifyMaxUserWatches: integer ,
fsFileMax: integer ,
fsAioMaxNr: integer ,
fsNrOpen: integer ,
kernelThreadsMax: integer ,
vmMaxMapCount: integer ,
vmSwappiness: integer ,
vmVfsCachePressure: integer ,
}
,
transparentHugePageEnabled: string ,
transparentHugePageDefrag: string ,
swapFileSizeMB: integer ,
}
,
enableEncryptionAtHost: boolean ,
enableUltraSSD: boolean ,
enableFIPS: boolean ,
gpuInstanceProfile: enum ,
creationData:
{
sourceResourceId: string ,
}
,
capacityReservationGroupID: string ,
hostGroupID: string ,
networkProfile:
{
nodePublicIPTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
allowedHostPorts:
[
{
portStart: integer ,
portEnd: integer ,
protocol: enum ,
}
,
]
,
applicationSecurityGroups:
[
string ,
]
,
}
,
windowsProfile:
{
disableOutboundNat: boolean ,
}
,
securityProfile:
{
enableVTPM: boolean ,
enableSecureBoot: boolean ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
eTag: string ,
count: integer ,
vmSize: string ,
osDiskSizeGB: integer ,
osDiskType: enum ,
kubeletDiskType: enum ,
workloadRuntime: enum ,
messageOfTheDay: string ,
vnetSubnetID: string ,
podSubnetID: string ,
maxPods: integer ,
osType: enum ,
osSKU: enum ,
maxCount: integer ,
minCount: integer ,
enableAutoScaling: boolean ,
scaleDownMode: enum ,
type: enum ,
mode: enum ,
orchestratorVersion: string ,
currentOrchestratorVersion: string ,
nodeImageVersion: string ,
upgradeSettings:
{
maxSurge: string ,
drainTimeoutInMinutes: integer ,
nodeSoakDurationInMinutes: integer ,
}
,
provisioningState: string ,
powerState:
{
code: enum ,
}
,
availabilityZones:
[
string ,
]
,
enableNodePublicIP: boolean ,
nodePublicIPPrefixID: string ,
scaleSetPriority: enum ,
scaleSetEvictionPolicy: enum ,
spotMaxPrice: number ,
tags: object ,
nodeLabels: object ,
nodeTaints:
[
string ,
]
,
proximityPlacementGroupID: string ,
kubeletConfig:
{
cpuManagerPolicy: string ,
cpuCfsQuota: boolean ,
cpuCfsQuotaPeriod: string ,
imageGcHighThreshold: integer ,
imageGcLowThreshold: integer ,
topologyManagerPolicy: string ,
allowedUnsafeSysctls:
[
string ,
]
,
failSwapOn: boolean ,
containerLogMaxSizeMB: integer ,
containerLogMaxFiles: integer ,
podMaxPids: integer ,
}
,
linuxOSConfig:
{
sysctls:
{
netCoreSomaxconn: integer ,
netCoreNetdevMaxBacklog: integer ,
netCoreRmemDefault: integer ,
netCoreRmemMax: integer ,
netCoreWmemDefault: integer ,
netCoreWmemMax: integer ,
netCoreOptmemMax: integer ,
netIpv4TcpMaxSynBacklog: integer ,
netIpv4TcpMaxTwBuckets: integer ,
netIpv4TcpFinTimeout: integer ,
netIpv4TcpKeepaliveTime: integer ,
netIpv4TcpKeepaliveProbes: integer ,
netIpv4TcpkeepaliveIntvl: integer ,
netIpv4TcpTwReuse: boolean ,
netIpv4IpLocalPortRange: string ,
netIpv4NeighDefaultGcThresh1: integer ,
netIpv4NeighDefaultGcThresh2: integer ,
netIpv4NeighDefaultGcThresh3: integer ,
netNetfilterNfConntrackMax: integer ,
netNetfilterNfConntrackBuckets: integer ,
fsInotifyMaxUserWatches: integer ,
fsFileMax: integer ,
fsAioMaxNr: integer ,
fsNrOpen: integer ,
kernelThreadsMax: integer ,
vmMaxMapCount: integer ,
vmSwappiness: integer ,
vmVfsCachePressure: integer ,
}
,
transparentHugePageEnabled: string ,
transparentHugePageDefrag: string ,
swapFileSizeMB: integer ,
}
,
enableEncryptionAtHost: boolean ,
enableUltraSSD: boolean ,
enableFIPS: boolean ,
gpuInstanceProfile: enum ,
creationData:
{
sourceResourceId: string ,
}
,
capacityReservationGroupID: string ,
hostGroupID: string ,
networkProfile:
{
nodePublicIPTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
allowedHostPorts:
[
{
portStart: integer ,
portEnd: integer ,
protocol: enum ,
}
,
]
,
applicationSecurityGroups:
[
string ,
]
,
}
,
windowsProfile:
{
disableOutboundNat: boolean ,
}
,
securityProfile:
{
enableVTPM: boolean ,
enableSecureBoot: boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
AgentPools_UpgradeNodeImageVersion (updated)
Description Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade
Reference Link ¶

⚶ Changes

{
  "#id": "AgentPools_UpgradeNodeImageVersion",
  "$responses": {
    "202": {
      "$properties": {
        "properties": [
          {
            "upgradeSettings": [
              {
                "#name": "maxSurge",
                "Description": {
                  "new": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade",
                  "old": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
resourceName: string ,
agentPoolName: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
properties:
{
eTag: string ,
count: integer ,
vmSize: string ,
osDiskSizeGB: integer ,
osDiskType: enum ,
kubeletDiskType: enum ,
workloadRuntime: enum ,
messageOfTheDay: string ,
vnetSubnetID: string ,
podSubnetID: string ,
maxPods: integer ,
osType: enum ,
osSKU: enum ,
maxCount: integer ,
minCount: integer ,
enableAutoScaling: boolean ,
scaleDownMode: enum ,
type: enum ,
mode: enum ,
orchestratorVersion: string ,
currentOrchestratorVersion: string ,
nodeImageVersion: string ,
upgradeSettings:
{
maxSurge: string ,
drainTimeoutInMinutes: integer ,
nodeSoakDurationInMinutes: integer ,
}
,
provisioningState: string ,
powerState:
{
code: enum ,
}
,
availabilityZones:
[
string ,
]
,
enableNodePublicIP: boolean ,
nodePublicIPPrefixID: string ,
scaleSetPriority: enum ,
scaleSetEvictionPolicy: enum ,
spotMaxPrice: number ,
tags: object ,
nodeLabels: object ,
nodeTaints:
[
string ,
]
,
proximityPlacementGroupID: string ,
kubeletConfig:
{
cpuManagerPolicy: string ,
cpuCfsQuota: boolean ,
cpuCfsQuotaPeriod: string ,
imageGcHighThreshold: integer ,
imageGcLowThreshold: integer ,
topologyManagerPolicy: string ,
allowedUnsafeSysctls:
[
string ,
]
,
failSwapOn: boolean ,
containerLogMaxSizeMB: integer ,
containerLogMaxFiles: integer ,
podMaxPids: integer ,
}
,
linuxOSConfig:
{
sysctls:
{
netCoreSomaxconn: integer ,
netCoreNetdevMaxBacklog: integer ,
netCoreRmemDefault: integer ,
netCoreRmemMax: integer ,
netCoreWmemDefault: integer ,
netCoreWmemMax: integer ,
netCoreOptmemMax: integer ,
netIpv4TcpMaxSynBacklog: integer ,
netIpv4TcpMaxTwBuckets: integer ,
netIpv4TcpFinTimeout: integer ,
netIpv4TcpKeepaliveTime: integer ,
netIpv4TcpKeepaliveProbes: integer ,
netIpv4TcpkeepaliveIntvl: integer ,
netIpv4TcpTwReuse: boolean ,
netIpv4IpLocalPortRange: string ,
netIpv4NeighDefaultGcThresh1: integer ,
netIpv4NeighDefaultGcThresh2: integer ,
netIpv4NeighDefaultGcThresh3: integer ,
netNetfilterNfConntrackMax: integer ,
netNetfilterNfConntrackBuckets: integer ,
fsInotifyMaxUserWatches: integer ,
fsFileMax: integer ,
fsAioMaxNr: integer ,
fsNrOpen: integer ,
kernelThreadsMax: integer ,
vmMaxMapCount: integer ,
vmSwappiness: integer ,
vmVfsCachePressure: integer ,
}
,
transparentHugePageEnabled: string ,
transparentHugePageDefrag: string ,
swapFileSizeMB: integer ,
}
,
enableEncryptionAtHost: boolean ,
enableUltraSSD: boolean ,
enableFIPS: boolean ,
gpuInstanceProfile: enum ,
creationData:
{
sourceResourceId: string ,
}
,
capacityReservationGroupID: string ,
hostGroupID: string ,
networkProfile:
{
nodePublicIPTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
allowedHostPorts:
[
{
portStart: integer ,
portEnd: integer ,
protocol: enum ,
}
,
]
,
applicationSecurityGroups:
[
string ,
]
,
}
,
windowsProfile:
{
disableOutboundNat: boolean ,
}
,
securityProfile:
{
enableVTPM: boolean ,
enableSecureBoot: boolean ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}