Azure Kubernetes Service · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure Kubernetes Service REST Agent Pools API

10 actions 10 updates phrasing extends openapi/microsoft-azure-kubernetes-service-agent-pools-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Azure Kubernetes Service's API. It is a proposal applied on top of the contract, not a document Azure Kubernetes Service publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}'].put

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}'].delete

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/abort'].post

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/deleteMachines'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Azure Kubernetes Service REST Agent Pools API
  version: 1.0.0
extends: openapi/microsoft-azure-kubernetes-service-agent-pools-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools'].get
  update:
    x-apievangelist-phrasing:
      intent: List node pools in an AKS cluster
      effect: read
      questions:
      - What node pools does my AKS cluster have?
      - Can I see all agent pools attached to one managed cluster at once?
      instructions:
      - text: List the agent pools in AKS cluster {resourceName} in resource group {resourceGroupName}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
      - text: Show every node pool of cluster {resourceName} in subscription {subscriptionId}.
        slots:
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one node pool
      effect: read
      questions:
      - How is a specific AKS node pool configured?
      - Where can I check the VM size and node count of one agent pool?
      instructions:
      - text: Get agent pool {agentPoolName} of AKS cluster {resourceName}.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
      - text: Show settings of node pool {agentPoolName} in cluster {resourceName}, subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or reconfigure a node pool
      effect: write
      questions:
      - How do I add a new node pool to an existing AKS cluster?
      - Can I scale or change the settings of a node pool that already exists?
      instructions:
      - text: Create agent pool {agentPoolName} in AKS cluster {resourceName} with properties {properties}.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
          properties: requestBody.properties
      - text: Update node pool {agentPoolName} of cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a node pool from an AKS cluster
      effect: destructive
      questions:
      - How do I remove an entire node pool from my cluster?
      - What is the way to get rid of an agent pool I no longer use?
      instructions:
      - text: Delete agent pool {agentPoolName} from AKS cluster {resourceName}.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
      - text: Remove the whole node pool {agentPoolName} in cluster {resourceName}, subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Check available upgrades for a node pool
      effect: read
      questions:
      - Is there an upgrade available for one of my AKS node pools?
      - What does the upgrade profile of a single agent pool show?
      instructions:
      - text: Get the upgrade profile for agent pool {agentPoolName} in cluster {resourceName}.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
      - text: Show upgrade options for node pool {agentPoolName} of cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/availableAgentPoolVersions'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported Kubernetes versions for a node pool
      effect: read
      questions:
      - Which Kubernetes versions are supported for a given agent pool?
      - Can I see the full list of versions a node pool is allowed to run?
      instructions:
      - text: List the supported Kubernetes versions for agent pool {agentPoolName} in cluster {resourceName}.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
      - text: Show available versions for pool {agentPoolName} of cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion'].post
  update:
    x-apievangelist-phrasing:
      intent: Upgrade a node pool to the latest node image
      effect: write
      questions:
      - How do I patch my AKS nodes to the newest OS node image?
      - Can I refresh one node pool's image without changing its Kubernetes version?
      instructions:
      - text: Upgrade the node image of agent pool {agentPoolName} in cluster {resourceName} to the latest.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
      - text: Roll node pool {agentPoolName} of cluster {resourceName} (subscription {subscriptionId}, group {resourceGroupName}) onto the newest image.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/abort'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel the running operation on a node pool
      effect: destructive
      questions:
      - Can I stop a node pool upgrade or scale operation that is still running?
      - What is the way to abort an in-flight change on just one agent pool?
      instructions:
      - text: Abort the operation currently running on agent pool {agentPoolName} in cluster {resourceName}.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
      - text: Cancel the in-progress change on pool {agentPoolName} of cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/deleteMachines'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete specific machines from a node pool
      effect: destructive
      questions:
      - Can I remove individual bad nodes from a pool instead of the whole pool?
      - Which machines get deleted when I target specific names in an agent pool?
      instructions:
      - text: Delete machines {machineNames} from agent pool {agentPoolName} in cluster {resourceName}.
        slots:
          machineNames: requestBody.machineNames
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
      - text: Remove only nodes {machineNames} from pool {agentPoolName} of cluster {resourceName}, subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          machineNames: requestBody.machineNames
          agentPoolName: path.agentPoolName
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'