Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Pools API

51 actions 51 updates phrasing extends openapi/microsoft-azure-pools-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 51 · first 16 shown; the file carries all of them

$.info
$.paths['/pools'].get
$.paths['/pools'].post
$.paths['/pools/{poolId}'].get
$.paths['/pools/{poolId}'].delete
$.paths['/pools/{poolId}'].patch
$.paths['/pools/{poolId}'].head
$.paths['/pools/{poolId}/disableautoscale'].post
$.paths['/pools/{poolId}/enableautoscale'].post
$.paths['/pools/{poolId}/evaluateautoscale'].post
$.paths['/pools/{poolId}/nodes'].get
$.paths['/pools/{poolId}/nodes/{nodeId}'].get
$.paths['/pools/{poolId}/nodes/{nodeId}/disablescheduling'].post
$.paths['/pools/{poolId}/nodes/{nodeId}/enablescheduling'].post
$.paths['/pools/{poolId}/nodes/{nodeId}/extensions'].get
$.paths['/pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}'].get

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 Microsoft Azure Pools API
  version: 1.0.0
extends: openapi/microsoft-azure-pools-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 50
- target: $.paths['/pools'].get
  update:
    x-apievangelist-phrasing:
      intent: List Batch pools in an account
      effect: read
      questions:
      - Which Batch pools exist in my Azure Batch account?
      - Can I filter my Batch pool list with an OData $filter and cap it with maxresults?
      instructions:
      - text: List all Batch pools in my account.
      - text: List Batch pools matching the filter {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Batch compute pool
      effect: write
      questions:
      - How do I create a new Azure Batch pool with a given VM size?
      - Can I turn on autoscaling when I first create a Batch pool?
      instructions:
      - text: Create a Batch pool named {id} using VM size {vmSize}.
        slots:
          id: requestBody.id
          vmSize: requestBody.vmSize
      - text: Create Batch pool {id} on {vmSize} VMs with {targetDedicatedNodes} dedicated nodes.
        slots:
          id: requestBody.id
          vmSize: requestBody.vmSize
          targetDedicatedNodes: requestBody.targetDedicatedNodes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a Batch pool
      effect: read
      questions:
      - What are the full settings and current state of one Batch pool?
      - Can I fetch only selected properties of a Batch pool with $select?
      instructions:
      - text: Show me the details of Batch pool {poolId}.
        slots:
          poolId: path.poolId
      - text: Get Batch pool {poolId} returning only {select}.
        slots:
          poolId: path.poolId
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Batch pool
      effect: destructive
      questions:
      - What happens to running tasks when I delete a Batch pool?
      - How do I tear down a Batch pool I no longer need?
      instructions:
      - text: Delete Batch pool {poolId}.
        slots:
          poolId: path.poolId
      - text: Tear down pool {poolId} and terminate the tasks on its nodes.
        slots:
          poolId: path.poolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch selected Batch pool properties
      effect: write
      questions:
      - How do I change just the start task on a Batch pool without touching its other settings?
      - Can I update a Batch pool's metadata while keeping everything else as is?
      instructions:
      - text: Patch Batch pool {poolId} with new metadata {metadata}, leaving other properties unchanged.
        slots:
          poolId: path.poolId
          metadata: requestBody.metadata
      - text: Update only the start task of Batch pool {poolId}.
        slots:
          poolId: path.poolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check whether a Batch pool exists
      effect: read
      questions:
      - Is there a quick way to check if a Batch pool exists without downloading its full definition?
      - Does a Batch pool with this ID still exist?
      instructions:
      - text: Check whether Batch pool {poolId} exists.
        slots:
          poolId: path.poolId
      - text: Confirm pool {poolId} is still present using a lightweight existence check.
        slots:
          poolId: path.poolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/disableautoscale'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn off autoscaling on a Batch pool
      effect: write
      questions:
      - How do I stop a Batch pool from scaling itself automatically?
      - Can I switch a Batch pool back to a fixed node count?
      instructions:
      - text: Disable autoscaling on Batch pool {poolId}.
        slots:
          poolId: path.poolId
      - text: Switch off the autoscale formula on pool {poolId} so its size stays fixed.
        slots:
          poolId: path.poolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/enableautoscale'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn on autoscaling for a Batch pool
      effect: write
      questions:
      - How do I enable automatic scaling on an existing Batch pool?
      - Can I enable autoscale while the pool is still resizing?
      instructions:
      - text: Enable autoscaling on Batch pool {poolId} with formula {autoScaleFormula}.
        slots:
          poolId: path.poolId
          autoScaleFormula: requestBody.autoScaleFormula
      - text: Turn on autoscale for Batch pool {poolId} evaluating every {autoScaleEvaluationInterval}.
        slots:
          poolId: path.poolId
          autoScaleEvaluationInterval: requestBody.autoScaleEvaluationInterval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/evaluateautoscale'].post
  update:
    x-apievangelist-phrasing:
      intent: Test an autoscale formula on a Batch pool
      effect: read
      questions:
      - Can I dry-run an autoscale formula against a Batch pool before applying it?
      - What node count would my autoscale formula produce right now?
      instructions:
      - text: Evaluate autoscale formula {autoScaleFormula} against Batch pool {poolId} without applying it.
        slots:
          poolId: path.poolId
          autoScaleFormula: requestBody.autoScaleFormula
      - text: Preview what formula {autoScaleFormula} would compute for pool {poolId}.
        slots:
          poolId: path.poolId
          autoScaleFormula: requestBody.autoScaleFormula
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List compute nodes in a Batch pool
      effect: read
      questions:
      - Which compute nodes are currently in my Batch pool?
      - Can I filter a pool's compute nodes by state?
      instructions:
      - text: List the compute nodes in Batch pool {poolId}.
        slots:
          poolId: path.poolId
      - text: List nodes in pool {poolId} matching {filter}.
        slots:
          poolId: path.poolId
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Batch compute node
      effect: read
      questions:
      - What is the state and IP of a specific Batch compute node?
      - How do I look up one node in a Batch pool?
      instructions:
      - text: Show compute node {nodeId} in Batch pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      - text: Get the state of Batch node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/disablescheduling'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop scheduling tasks on a compute node
      effect: write
      questions:
      - How do I stop new tasks from landing on one Batch compute node?
      - Can I requeue the running tasks when I disable scheduling on a node?
      instructions:
      - text: Disable task scheduling on node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      - text: Disable scheduling on node {nodeId} of pool {poolId} with option {nodeDisableSchedulingOption}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          nodeDisableSchedulingOption: requestBody.nodeDisableSchedulingOption
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/enablescheduling'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume scheduling tasks on a compute node
      effect: write
      questions:
      - How do I let a Batch node accept tasks again after I disabled it?
      - Can I re-enable scheduling on a node whose scheduling is off?
      instructions:
      - text: Re-enable task scheduling on node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      - text: Let node {nodeId} in pool {poolId} start taking tasks again.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/extensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List VM extensions on a compute node
      effect: read
      questions:
      - Which VM extensions are installed on a Batch compute node?
      - Can I see the extension status for every extension on one node?
      instructions:
      - text: List the extensions on node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      - text: Show every VM extension installed on Batch node {nodeId} of pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one VM extension on a compute node
      effect: read
      questions:
      - What is the provisioning state of a specific extension on a Batch node?
      - How do I inspect a single named extension on a compute node?
      instructions:
      - text: Show extension {extensionName} on node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          extensionName: path.extensionName
      - text: Check the status of the {extensionName} extension on Batch node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          extensionName: path.extensionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List files on a Batch compute node
      effect: read
      questions:
      - What files are in the task directories on a Batch node?
      - Can I list a node's files recursively?
      instructions:
      - text: List the files on node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      - text: Recursively list files on node {nodeId} of pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/files/{filePath}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a file from a compute node
      effect: read
      questions:
      - How do I download a log file straight from a Batch compute node?
      - Can I read only a byte range of a node file?
      instructions:
      - text: Download file {filePath} from node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          filePath: path.filePath
      - text: Read bytes {range} of file {filePath} on node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          filePath: path.filePath
          range: header.ocp-range
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/files/{filePath}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file from a compute node
      effect: destructive
      questions:
      - How do I remove a file or folder from a Batch compute node?
      - Can I delete a directory on a node recursively?
      instructions:
      - text: Delete file {filePath} from node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          filePath: path.filePath
      - text: Remove directory {filePath} and its contents from Batch node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          filePath: path.filePath
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/files/{filePath}'].head
  update:
    x-apievangelist-phrasing:
      intent: Get properties of a compute node file
      effect: read
      questions:
      - How big is a file on a Batch node and when was it last modified?
      - Can I check a node file's metadata without downloading it?
      instructions:
      - text: Get the size and properties of file {filePath} on node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          filePath: path.filePath
      - text: Check when node file {filePath} on {nodeId} in pool {poolId} was last modified.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          filePath: path.filePath
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/rdp'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an RDP file for a compute node
      effect: read
      questions:
      - How do I get a Remote Desktop file to connect to a Batch node?
      - Which pools support downloading an RDP file for a node?
      instructions:
      - text: Download the RDP file for node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      - text: Get a Remote Desktop connection file for Batch node {nodeId} of pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/reboot'].post
  update:
    x-apievangelist-phrasing:
      intent: Restart a Batch compute node
      effect: write
      questions:
      - How do I reboot a stuck Batch compute node?
      - Can I choose what happens to running tasks when a node restarts?
      instructions:
      - text: Reboot node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      - text: Restart node {nodeId} of pool {poolId} using option {nodeRebootOption}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          nodeRebootOption: requestBody.nodeRebootOption
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/reimage'].post
  update:
    x-apievangelist-phrasing:
      intent: Reinstall the OS on a compute node
      effect: destructive
      questions:
      - How do I reimage a Batch node to reinstall its operating system?
      - Does reimaging a node work on virtual machine configuration pools?
      instructions:
      - text: Reimage node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      - text: Reinstall the operating system on Batch node {nodeId} of pool {poolId} using {nodeReimageOption}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          nodeReimageOption: requestBody.nodeReimageOption
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/remoteloginsettings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get SSH/remote login settings for a node
      effect: read
      questions:
      - What IP address and port do I use to SSH into a Batch compute node?
      - Where do I find the remote login endpoint for a node in a VM configuration pool?
      instructions:
      - text: Get the remote login settings for node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      - text: Give me the SSH IP and port for Batch node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload Batch service logs from a node
      effect: write
      questions:
      - How do I collect Batch service logs from a node to send to Azure support?
      - Can I upload a node's logs for a specific time window to my storage container?
      instructions:
      - text: Upload Batch service logs from node {nodeId} in pool {poolId} to {containerUrl} starting {startTime}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          containerUrl: requestBody.containerUrl
          startTime: requestBody.startTime
      - text: Send node {nodeId} of pool {poolId} service logs between {startTime} and {endTime} to {containerUrl}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          containerUrl: requestBody.containerUrl
          startTime: requestBody.startTime
          endTime: requestBody.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user account to a compute node
      effect: write
      questions:
      - How do I create a login user on a Batch compute node?
      - Can I add an admin user with an SSH public key to a node?
      instructions:
      - text: Create user {name} on node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          name: requestBody.name
      - text: Add admin user {name} with SSH key {sshPublicKey} to node {nodeId} of pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          name: requestBody.name
          sshPublicKey: requestBody.sshPublicKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/users/{userName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user account on a compute node
      effect: write
      questions:
      - How do I change the password of an existing user on a Batch node?
      - Can I extend the expiry time of a node user account?
      instructions:
      - text: Set a new password for user {userName} on node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          userName: path.userName
      - text: Extend user {userName} on node {nodeId} of pool {poolId} to expire at {expiryTime}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          userName: path.userName
          expiryTime: requestBody.expiryTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/nodes/{nodeId}/users/{userName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user account from a compute node
      effect: destructive
      questions:
      - How do I delete a login user from a Batch compute node?
      - Can I remove a node user while the node is busy?
      instructions:
      - text: Delete user {userName} from node {nodeId} in pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          userName: path.userName
      - text: Remove login account {userName} on Batch node {nodeId} of pool {poolId}.
        slots:
          poolId: path.poolId
          nodeId: path.nodeId
          userName: path.userName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/removenodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove specific nodes from a Batch pool
      effect: destructive
      questions:
      - How do I remove particular compute nodes from a Batch pool?
      - How many nodes can I remove from a pool in one request?
      instructions:
      - text: Remove nodes {nodeList} from Batch pool {poolId}.
        slots:
          poolId: path.poolId
          nodeList: requestBody.nodeList
      - text: Take nodes {nodeList} out of pool {poolId} using deallocation option {nodeDeallocationOption}.
        slots:
          poolId: path.poolId
          nodeList: requestBody.nodeList
          nodeDeallocationOption: requestBody.nodeDeallocationOption
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/resize'].post
  update:
    x-apievangelist-phrasing:
      intent: Resize a Batch pool
      effect: write
      questions:
      - How do I scale a Batch pool to a set number of dedicated nodes?
      - Can I add Spot or low-priority nodes when resizing a pool?
      instructions:
      - text: Resize Batch pool {poolId} to {targetDedicatedNodes} dedicated nodes.
        slots:
          poolId: path.poolId
          targetDedicatedNodes: requestBody.targetDedicatedNodes
      - text: Resize pool {poolId} to {targetLowPriorityNodes} low-priority nodes.
        slots:
          poolId: path.poolId
          targetLowPriorityNodes: requestBody.targetLowPriorityNodes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/stopresize'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop an in-progress pool resize
      effect: write
      questions:
      - How do I cancel a Batch pool resize that is still running?
      - Does stopping a resize roll the pool back to its old size?
      instructions:
      - text: Stop the ongoing resize of Batch pool {poolId}.
        slots:
          poolId: path.poolId
      - text: Halt resizing on pool {poolId} and keep its current node count.
        slots:
          poolId: path.poolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pools/{poolId}/updateproperties'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace all updatable Batch pool properties
      effect: write
      questions:
      - How do I overwrite every updatable property of a Batch pool at once?
      - What happens to the start task if I leave it out when fully replacing pool properties?
      instructions:
      - text: Replace pool {poolId} properties with metadata {metadata}, package references {applicationPackageReferences} and certificates {certificateReferences}.
        slots:
          poolId: path.poolId
          metadata: requestBody.metadata
          applicationPackageReferences: requestBody.applicationPackageReferences
          certificateReferences: requestBody.certificateReferences
      - text: Fully overwrite the updatable properties of pool {poolId}, clearing its start task.
        slots:
          poolId: path.poolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.ContainerStorage/pools'].get
  update:
    x-apievangelist-phrasing:
      intent: List Container Storage pools in a subscription
      effect: read
      questions:
      - Which Azure Container Storage pools exist across my subscription?
      - Can I see all my container storage pools regardless of resource group?
      instructions:
      - text: List all Azure Container Storage pools in my subscription.
      - text: Show every container storage pool I have across resource groups.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools'].get
  update:
    x-apievangelist-phrasing:
      intent: List Container Storage pools in a resource group
      effect: read
      questions:
      - Which Container Storage pools live in one resource group?
      - How do I list the storage pools for my AKS container storage in a resource group?
      instructions:
      - text: List the Azure Container Storage pools in my resource group.
      - text: Show the container storage pools in this one resource group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Container Storage pool
      effect: read
      questions:
      - What is the configuration of one Azure Container Storage pool?
      - How do I check a container storage pool's provisioning state?
      instructions:
      - text: Show Azure Container Storage pool {poolName}.
        slots:
          poolName: path.poolName
      - text: Get the provisioning state of container storage pool {poolName}.
        slots:
          poolName: path.poolName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a Container Storage pool
      effect: write
      questions:
      - How do I create a new Azure Container Storage pool?
      - Can I define a container storage pool's properties when creating it?
      instructions:
      - text: Create Azure Container Storage pool {poolName}.
        slots:
          poolName: path.poolName
      - text: Create container storage pool {poolName} with properties {properties}.
        slots:
          poolName: path.poolName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Container Storage pool
      effect: destructive
      questions:
      - How do I remove an Azure Container Storage pool?
      - Can I delete a container storage pool I no longer use?
      instructions:
      - text: Delete Azure Container Storage pool {poolName}.
        slots:
          poolName: path.poolName
      - text: Remove the container storage pool {poolName}.
        slots:
          poolName: path.poolName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Container Storage pool
      effect: write
      questions:
      - How do I change the tags on an Azure Container Storage pool?
      - Can I patch a container storage pool's properties in place?
      instructions:
      - text: Update tags on Azure Container Storage pool {poolName} to {tags}.
        slots:
          poolName: path.poolName
          tags: requestBody.tags
      - text: Patch properties of container storage pool {poolName} with {properties}.
        slots:
          poolName: path.poolName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/poolusagemetrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Batch pool usage metrics by interval
      effect: read
      questions:
      - How much compute did my Batch pools use in each aggregation interval?
      - Can I limit Batch pool usage metrics to a time window?
      instructions:
      - text: Show Batch pool usage metrics from {starttime} to {endtime}.
        slots:
          starttime: query.starttime
          endtime: query.endtime
      - text: Get usage metrics for Batch pools matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lifetimepoolstats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lifetime statistics for all Batch pools
      effect: read
      questions:
      - What are the aggregate lifetime usage statistics for every pool in my Batch account?
      - How delayed are Batch account-wide pool lifetime statistics?
      instructions:
      - text: Get lifetime statistics aggregated across all Batch pools in my account.
      - text: Show total pool usage for my Batch account since it was created, using Batch API version {api_version}.
        slots:
          api_version: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools'].get
  update:
    x-apievangelist-phrasing:
      intent: List Dev Box pools in a DevCenter project
      effect: read
      questions:
      - Which Dev Box machine pools are defined in my DevCenter project?
      - How do I see the dev box pools available to a project?
      instructions:
      - text: List the Dev Box machine pools in DevCenter project {projectName}.
        slots:
          projectName: path.projectName
      - text: Show which dev box pools this DevCenter project offers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Dev Box machine pool
      effect: read
      questions:
      - What settings does a specific Dev Box pool in my project use?
      - How do I check the health of a DevCenter machine pool?
      instructions:
      - text: Show Dev Box machine pool {poolName} in DevCenter project {projectName}.
        slots:
          poolName: path.poolName
          projectName: path.projectName
      - text: Check the health status of dev box pool {poolName}.
        slots:
          poolName: path.poolName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Dev Box machine pool
      effect: write
      questions:
      - How do I create a Dev Box pool for developers in a DevCenter project?
      - Can I replace the definition of an existing dev box pool?
      instructions:
      - text: Create or update Dev Box machine pool {poolName} in project {projectName} with properties {properties}.
        slots:
          poolName: path.poolName
          projectName: path.projectName
          properties: requestBody.properties
      - text: Set up a new Dev Box pool called {poolName} in my DevCenter project.
        slots:
          poolName: path.poolName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Dev Box machine pool
      effect: destructive
      questions:
      - How do I remove a Dev Box machine pool from a DevCenter project?
      - Can I delete a dev box pool nobody uses anymore?
      instructions:
      - text: Delete Dev Box machine pool {poolName} from DevCenter project {projectName}.
        slots:
          poolName: path.poolName
          projectName: path.projectName
      - text: Remove dev box pool {poolName} so developers can no longer use it.
        slots:
          poolName: path.poolName
      method: generated
      generated: '2026-10-01'


# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/overlays/microsoft-azure-pools-api-phrasing-overlay.yaml

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-pools-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.