Azure Kubernetes Service · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure Kubernetes Service REST Managed Clusters API

16 actions 16 updates phrasing extends openapi/microsoft-azure-kubernetes-service-managed-clusters-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 16

$.info
$.paths['/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/abort'].post

OpenAPI Overlay

Raw ↑ 
# 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 Managed Clusters API
  version: 1.0.0
extends: openapi/microsoft-azure-kubernetes-service-managed-clusters-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: 15
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List all AKS clusters in a subscription
      effect: read
      questions:
      - How do I see every AKS cluster across my whole Azure subscription?
      - Which managed Kubernetes clusters exist in this subscription, regardless of resource group?
      instructions:
      - text: List every AKS managed cluster in subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      - text: Show me all Kubernetes clusters I have anywhere in my Azure subscription.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List AKS clusters in a resource group
      effect: read
      questions:
      - What AKS clusters are in a specific resource group?
      - Can I narrow my cluster list down to just one resource group?
      instructions:
      - text: List the AKS clusters in resource group {resourceGroupName} of subscription {subscriptionId}.
        slots:
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show only the managed clusters that live in resource group {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one AKS cluster
      effect: read
      questions:
      - What is the current configuration of a single AKS cluster I name?
      - Where can I look up the provisioning state and settings of one managed cluster?
      instructions:
      - text: Get the details of AKS cluster {resourceName} in resource group {resourceGroupName}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
      - text: Show the full configuration of cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          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}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or reconfigure an AKS cluster
      effect: write
      questions:
      - How do I create a new managed Kubernetes cluster in Azure?
      - Can I change the SKU or identity settings of an existing AKS cluster?
      - Is a region required when provisioning an AKS cluster?
      instructions:
      - text: Create AKS cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName}, region {location}.
        slots:
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          location: requestBody.location
      - text: Update the configuration of cluster {resourceName} with properties {properties}.
        slots:
          resourceName: path.resourceName
          properties: requestBody.properties
      - text: Provision cluster {resourceName} in {location} using SKU {sku}.
        slots:
          resourceName: path.resourceName
          location: requestBody.location
          sku: requestBody.sku
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an AKS cluster
      effect: destructive
      questions:
      - How do I tear down an AKS cluster I no longer need?
      - What happens when I delete a managed Kubernetes cluster?
      instructions:
      - text: Delete AKS cluster {resourceName} in resource group {resourceGroupName}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
      - text: Permanently remove managed cluster {resourceName} from 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}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update tags on an AKS cluster
      effect: write
      questions:
      - Can I change just the tags on an AKS cluster without touching its configuration?
      - Is there a quick way to label a managed cluster with cost-center tags?
      instructions:
      - text: Set tags {tags} on AKS cluster {resourceName}.
        slots:
          tags: requestBody.tags
          resourceName: path.resourceName
      - text: Replace the tags on cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName} with {tags}.
        slots:
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Check available upgrades for an AKS cluster
      effect: read
      questions:
      - Which Kubernetes versions can my AKS cluster's control plane upgrade to?
      - How can I tell if a cluster upgrade is available?
      instructions:
      - text: Get the upgrade profile for cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      - text: Show which upgrades are available for AKS cluster {resourceName}.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Get admin kubeconfig for an AKS cluster
      effect: read
      questions:
      - How do I get the cluster-admin kubeconfig for my AKS cluster?
      - Where do I fetch admin-level credentials to run kubectl with full rights?
      instructions:
      - text: Fetch admin credentials for AKS cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      - text: Give me the cluster-admin kubeconfig for {resourceName}.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Get user kubeconfig for an AKS cluster
      effect: read
      questions:
      - Can I get a regular user kubeconfig for an AKS cluster instead of admin access?
      - Where do non-admin users get their credentials to connect to a managed cluster?
      instructions:
      - text: Fetch user credentials for AKS cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      - text: Get a non-admin kubeconfig for cluster {resourceName}.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Get monitoring user credentials for a cluster
      effect: read
      questions:
      - What credentials should a monitoring tool use to read from my AKS cluster?
      - Is there a separate monitoring-user kubeconfig for a managed cluster?
      instructions:
      - text: Fetch the monitoring user credentials for AKS cluster {resourceName}.
        slots:
          resourceName: path.resourceName
      - text: Get the monitoring kubeconfig for {resourceName} in subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          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}/rotateClusterCertificates'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an AKS cluster's certificates
      effect: write
      questions:
      - How do I rotate the certificates on an AKS cluster?
      - Can I renew a managed cluster's certificates if I think they were exposed?
      instructions:
      - text: Rotate certificates on AKS cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      - text: Renew all certificates for managed cluster {resourceName}.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running AKS cluster
      effect: write
      questions:
      - Can I pause an AKS cluster to save money without losing its state?
      - Does stopping a managed cluster work on clusters that are not backed by scale sets?
      instructions:
      - text: Stop AKS cluster {resourceName} in subscription {subscriptionId}, resource group {resourceGroupName}.
        slots:
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      - text: Shut down the control plane and nodes of cluster {resourceName} but keep its state.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a stopped AKS cluster
      effect: write
      questions:
      - How do I bring a stopped AKS cluster back online?
      - Can I resume a managed cluster I stopped over the weekend?
      instructions:
      - text: Start the stopped AKS cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      - text: Power cluster {resourceName} back on.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a kubectl command on an AKS cluster
      effect: write
      questions:
      - Can I run kubectl against a private AKS cluster without direct network access?
      - Is it possible to send supporting files along with a command I run on the cluster?
      instructions:
      - text: Run the command {command} on AKS cluster {resourceName}.
        slots:
          command: requestBody.command
          resourceName: path.resourceName
      - text: Execute {command} on private cluster {resourceName} in subscription {subscriptionId}, group {resourceGroupName}, with zipped files {context}.
        slots:
          command: requestBody.command
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          context: requestBody.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/abort'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel the running operation on an AKS cluster
      effect: destructive
      questions:
      - How do I cancel a cluster-level operation that is stuck in progress?
      - What state does the managed cluster go into after I abort its current operation?
      instructions:
      - text: Abort the operation currently running on AKS cluster {resourceName}.
        slots:
          resourceName: path.resourceName
      - text: Cancel the in-progress cluster operation on {resourceName} in subscription {subscriptionId}, group {resourceGroupName}.
        slots:
          resourceName: path.resourceName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'