Microsoft Azure Agent Pools API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure Kubernetes Service (AKS) Agent Pools…
  description: Azure Kubernetes Service (AKS) simplifies deploying a managed Kubernetes cluster in Azure by offloading the operational overhead to Azure. As a hosted Kubernetes service, Azure handles critical tasks like health monitoring and maintenance. The REST API provides operations for managing AKS clusters, agent pools (node pools), maintenance configurations, and managed cluster snapshots, enabling developers to automate Kubernetes infrastructure management.
  version: '2024-02-01'
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
    email: azuresupport@microsoft.com
  license:
    name: Microsoft API License
    url: https://learn.microsoft.com/en-us/legal/
  x-logo:
    url: https://azure.microsoft.com/svghandler/azure-logo.png
servers:
- url: https://management.azure.com
  description: Azure Resource Manager endpoint
security:
- oauth2:
  - https://management.azure.com/.default
tags:
- name: Agent Pools
  description: Operations for managing node pools within a cluster
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools
  : get:
      operationId: AgentPools_List
      summary: Microsoft Azure List Agent Pools
      description: Gets a list of agent pools in the specified managed cluster.
      tags:
      - Agent Pools
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ResourceNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the list of agent pools.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentPoolListResult'
              examples:
                AgentpoolsList200Example:
                  summary: Default AgentPools_List 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - id: abc123
                      name: Example Title
                      type: example_value
                    nextLink: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                AgentpoolsListdefaultExample:
                  summary: Default AgentPools_List default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - code: example_value
                        message: example_value
                        target: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
  : get:
      operationId: AgentPools_Get
      summary: Microsoft Azure Get an Agent Pool
      description: Gets the specified managed cluster agent pool.
      tags:
      - Agent Pools
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ResourceNameParameter'
      - name: agentPoolName
        in: path
        required: true
        description: The name of the agent pool.
        schema:
          type: string
        example: example_value
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the agent pool.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentPool'
              examples:
                AgentpoolsGet200Example:
                  summary: Default AgentPools_Get 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: example_value
                    properties:
                      name: Example Title
                      count: 10
                      vmSize: example_value
                      osDiskSizeGB: 10
                      osDiskType: Managed
                      osType: Linux
                      osSKU: Ubuntu
                      maxPods: 10
                      mode: System
                      type: VirtualMachineScaleSets
                      availabilityZones:
                      - {}
                      enableAutoScaling: true
                      minCount: 10
                      maxCount: 10
                      nodeLabels: example_value
                      nodeTaints:
                      - {}
                      upgradeSettings:
                        maxSurge: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                AgentpoolsGetdefaultExample:
                  summary: Default AgentPools_Get default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - code: example_value
                        message: example_value
                        target: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: AgentPools_CreateOrUpdate
      summary: Microsoft Azure Create or Update an Agent Pool
      description: Creates or updates an agent pool in the specified managed cluster.
      tags:
      - Agent Pools
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ResourceNameParameter'
      - name: agentPoolName
        in: path
        required: true
        description: The name of the agent pool.
        schema:
          type: string
        example: example_value
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentPool'
            examples:
              AgentpoolsCreateorupdateRequestExample:
                summary: Default AgentPools_CreateOrUpdate request
                x-microcks-default: true
                value:
                  id: abc123
                  name: Example Title
                  type: example_value
                  properties:
                    name: Example Title
                    count: 10
                    vmSize: example_value
                    osDiskSizeGB: 10
                    osDiskType: Managed
                    osType: Linux
                    osSKU: Ubuntu
                    maxPods: 10
                    mode: System
                    type: VirtualMachineScaleSets
                    availabilityZones:
                    - {}
                    enableAutoScaling: true
                    minCount: 10
                    maxCount: 10
                    nodeLabels: example_value
                    nodeTaints:
                    - {}
                    upgradeSettings:
                      maxSurge: example_value
      responses:
        '200':
          description: Successfully updated the agent pool.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentPool'
              examples:
                AgentpoolsCreateorupdate200Example:
                  summary: Default AgentPools_CreateOrUpdate 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: example_value
                    properties:
                      name: Example Title
                      count: 10
                      vmSize: example_value
                      osDiskSizeGB: 10
                      osDiskType: Managed
                      osType: Linux
                      osSKU: Ubuntu
                      maxPods: 10
                      mode: System
                      type: VirtualMachineScaleSets
                      availabilityZones:
                      - {}
                      enableAutoScaling: true
                      minCount: 10
                      maxCount: 10
                      nodeLabels: example_value
                      nodeTaints:
                      - {}
                      upgradeSettings:
                        maxSurge: example_value
        '201':
          description: The agent pool is being created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentPool'
              examples:
                AgentpoolsCreateorupdate201Example:
                  summary: Default AgentPools_CreateOrUpdate 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: example_value
                    properties:
                      name: Example Title
                      count: 10
                      vmSize: example_value
                      osDiskSizeGB: 10
                      osDiskType: Managed
                      osType: Linux
                      osSKU: Ubuntu
                      maxPods: 10
                      mode: System
                      type: VirtualMachineScaleSets
                      availabilityZones:
                      - {}
                      enableAutoScaling: true
                      minCount: 10
                      maxCount: 10
                      nodeLabels: example_value
                      nodeTaints:
                      - {}
                      upgradeSettings:
                        maxSurge: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                AgentpoolsCreateorupdatedefaultExample:
                  summary: Default AgentPools_CreateOrUpdate default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - code: example_value
                        message: example_value
                        target: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: AgentPools_Delete
      summary: Microsoft Azure Delete an Agent Pool
      description: Deletes an agent pool in the specified managed cluster.
      tags:
      - Agent Pools
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ResourceNameParameter'
      - name: agentPoolName
        in: path
        required: true
        description: The name of the agent pool.
        schema:
          type: string
        example: example_value
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '202':
          description: Accepted. The agent pool is being deleted.
        '204':
          description: The agent pool does not exist.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                AgentpoolsDeletedefaultExample:
                  summary: Default AgentPools_Delete default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - code: example_value
                        message: example_value
                        target: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CloudError:
      type: object
      description: An error response from the Container service.
      properties:
        error:
          type: object
          description: Details about the error.
          properties:
            code:
              type: string
              description: An identifier for the error.
            message:
              type: string
              description: A message describing the error.
            target:
              type: string
              description: The target of the particular error.
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  target:
                    type: string
              description: A list of additional details about the error.
          example: example_value
    AgentPoolListResult:
      type: object
      description: The response from the List Agent Pools operation.
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/AgentPool'
          description: The list of agent pools.
          example: []
        nextLink:
          type: string
          readOnly: true
          description: The URL to get the next set of agent pool results.
          example: example_value
    ManagedClusterAgentPoolProfile:
      type: object
      description: Profile for the container service agent pool.
      properties:
        name:
          type: string
          description: Unique name of the agent pool profile in the context of the subscription and resource group.
          pattern: ^[a-z][a-z0-9]{0,11}$
          example: Example Title
        count:
          type: integer
          description: Number of agents (VMs) to host docker containers.
          example: 10
        vmSize:
          type: string
          description: The size of the agent VMs.
          example: example_value
        osDiskSizeGB:
          type: integer
          minimum: 0
          maximum: 2048
          description: OS disk size in GB for the agent pool VMs.
          example: 10
        osDiskType:
          type: string
          enum:
          - Managed
          - Ephemeral
          description: The OS disk type to be used for machines in the agent pool.
          example: Managed
        osType:
          type: string
          enum:
          - Linux
          - Windows
          default: Linux
          description: The operating system type.
          example: Linux
        osSKU:
          type: string
          enum:
          - Ubuntu
          - AzureLinux
          - CBLMariner
          - Windows2019
          - Windows2022
          description: Specifies the OS SKU.
          example: Ubuntu
        maxPods:
          type: integer
          description: The maximum number of pods that can run on a node.
          example: 10
        mode:
          type: string
          enum:
          - System
          - User
          description: The mode of an agent pool.
          example: System
        type:
          type: string
          enum:
          - VirtualMachineScaleSets
          - AvailabilitySet
          default: VirtualMachineScaleSets
          description: The type of agent pool.
          example: VirtualMachineScaleSets
        availabilityZones:
          type: array
          items:
            type: string
          description: The list of availability zones to use for nodes (e.g., ["1", "2", "3"]).
          example: []
        enableAutoScaling:
          type: boolean
          description: Whether to enable auto-scaler.
          example: true
        minCount:
          type: integer
          description: The minimum number of nodes for auto-scaling.
          example: 10
        maxCount:
          type: integer
          description: The maximum number of nodes for auto-scaling.
          example: 10
        nodeLabels:
          type: object
          additionalProperties:
            type: string
          description: The node labels to be persisted across all nodes in the agent pool.
          example: example_value
        nodeTaints:
          type: array
          items:
            type: string
          description: The taints added to new nodes during node pool create and scale.
          example: []
        upgradeSettings:
          type: object
          description: Settings for upgrading the agentpool.
          properties:
            maxSurge:
              type: string
              description: The maximum number or percentage of nodes that are surged during upgrade (e.g., "1" or "33%").
          example: example_value
      required:
      - name
    AgentPool:
      type: object
      description: Agent pool resource.
      properties:
        id:
          type: string
          readOnly: true
          description: Resource ID.
          example: abc123
        name:
          type: string
          readOnly: true
          description: Resource name.
          example: Example Title
        type:
          type: string
          readOnly: true
          description: Resource type.
          example: example_value
        properties:
          $ref: '#/components/schemas/ManagedClusterAgentPoolProfile'
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group.
      schema:
        type: string
        minLength: 1
        maxLength: 90
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client API version.
      schema:
        type: string
        default: '2024-02-01'
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: The ID of the target subscription.
      schema:
        type: string
        format: uuid
    ResourceNameParameter:
      name: resourceName
      in: path
      required: true
      description: The name of the managed cluster resource.
      schema:
        type: string
        minLength: 1
        maxLength: 63
        pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            https://management.azure.com/.default: Access Azure Resource Manager