API Evangelist conversational phrasing for Microsoft Azure Deployments API

# 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 Deployments API
  version: 1.0.0
extends: openapi/microsoft-azure-deployments-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: 77
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List model deployments on an AI services account
      effect: read
      questions:
      - Which models are deployed on my Cognitive Services account?
      - How do I see every model deployment under one Azure AI services resource?
      instructions:
      - text: List the model deployments on Cognitive Services account {accountName} in resource group {rg}.
        slots:
          accountName: path.accountName
          rg: path.resourceGroupName
      - text: Show all model deployments for account {accountName} in subscription {sub}.
        slots:
          accountName: path.accountName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a model deployment on an AI services account
      effect: read
      questions:
      - What model version and SKU is a specific Cognitive Services deployment using?
      - Can I check the provisioning state of one model deployment on my AI account?
      instructions:
      - text: Show model deployment {deploymentName} on Cognitive Services account {accountName}.
        slots:
          deploymentName: path.deploymentName
          accountName: path.accountName
      - text: Get model deployment {deploymentName} of account {accountName} in group {rg}, subscription {sub}.
        slots:
          deploymentName: path.deploymentName
          accountName: path.accountName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Deploy a model to an AI services account
      effect: write
      questions:
      - How do I deploy a model to my Cognitive Services account through Resource Manager?
      - Can I change the SKU capacity of an existing model deployment on my AI account?
      instructions:
      - text: Create model deployment {deploymentName} on Cognitive Services account {accountName} with SKU {sku}.
        slots:
          deploymentName: path.deploymentName
          accountName: path.accountName
          sku: requestBody.sku
      - text: Update model deployment {deploymentName} on account {accountName} in {rg}, subscription {sub} with properties {properties}.
        slots:
          deploymentName: path.deploymentName
          accountName: path.accountName
          rg: path.resourceGroupName
          sub: path.subscriptionId
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a model deployment from an AI services account
      effect: destructive
      questions:
      - How do I remove a model deployment from my Cognitive Services account?
      - What happens to apps calling a model deployment after I delete it from the account?
      instructions:
      - text: Delete model deployment {deploymentName} from Cognitive Services account {accountName}.
        slots:
          deploymentName: path.deploymentName
          accountName: path.accountName
      - text: Remove deployment {deploymentName} of AI account {accountName} in group {rg}, subscription {sub}.
        slots:
          deploymentName: path.deploymentName
          accountName: path.accountName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deploymentId}/audio/speech'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn text into speech audio
      effect: write
      questions:
      - How do I convert text to spoken audio with an Azure OpenAI TTS deployment?
      - Can I pick the voice and playback speed for generated speech?
      instructions:
      - text: Generate speech of {input} with voice {voice} on deployment {deploymentId}.
        slots:
          input: requestBody.input
          voice: requestBody.voice
          deploymentId: path.deploymentId
      - text: Read {input} aloud at speed {speed} using voice {voice} on text-to-speech deployment {deploymentId}.
        slots:
          input: requestBody.input
          speed: requestBody.speed
          voice: requestBody.voice
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deploymentId}/audio/transcriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Transcribe audio in its spoken language
      effect: write
      questions:
      - How do I get a text transcript of a recording in the language it was spoken?
      - Can I give a language hint and a prompt to improve a Whisper transcription?
      instructions:
      - text: Transcribe audio file {file} on Whisper deployment {deploymentId}.
        slots:
          file: formData.file
          deploymentId: path.deploymentId
      - text: Transcribe {file} as {language} speech using deployment {deploymentId} with prompt {prompt}.
        slots:
          file: formData.file
          language: formData.language
          deploymentId: path.deploymentId
          prompt: formData.prompt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deploymentId}/audio/translations'].post
  update:
    x-apievangelist-phrasing:
      intent: Translate spoken audio into English text
      effect: write
      questions:
      - How do I turn a foreign-language recording into English text?
      - Can I choose the output format when translating audio to English?
      instructions:
      - text: Translate audio file {file} into English text on deployment {deploymentId}.
        slots:
          file: formData.file
          deploymentId: path.deploymentId
      - text: Translate {file} to English as {response_format} on Whisper deployment {deploymentId}.
        slots:
          file: formData.file
          response_format: formData.response_format
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deploymentId}/chat/completions'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a chat completion from a deployment
      effect: write
      questions:
      - How do I send a conversation to my Azure OpenAI chat model and get a reply?
      - Can a chat completion call tools or ground its answers on my own data sources?
      - What does the seed setting do for chat completions?
      instructions:
      - text: Send messages {messages} to chat deployment {deploymentId}.
        slots:
          messages: requestBody.messages
          deploymentId: path.deploymentId
      - text: Get a chat reply to {messages} from {deploymentId} using tools {tools}.
        slots:
          messages: requestBody.messages
          deploymentId: path.deploymentId
          tools: requestBody.tools
      - text: Chat with deployment {deploymentId} about {messages} grounded on data sources {data_sources}.
        slots:
          deploymentId: path.deploymentId
          messages: requestBody.messages
          data_sources: requestBody.data_sources
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deploymentId}/completions'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a text prompt on a deployment
      effect: write
      questions:
      - How do I get a text completion for a plain prompt from my Azure OpenAI deployment?
      - Can I ask for several completions and keep only the best one?
      instructions:
      - text: Complete prompt {prompt} on deployment {deploymentId}.
        slots:
          prompt: requestBody.prompt
          deploymentId: path.deploymentId
      - text: Generate {n} completions for {prompt} on {deploymentId} with max tokens {max_tokens}.
        slots:
          n: requestBody.n
          prompt: requestBody.prompt
          deploymentId: path.deploymentId
          max_tokens: requestBody.max_tokens
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deploymentId}/embeddings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create embeddings for text
      effect: read
      questions:
      - How do I turn text into vectors for semantic search with Azure OpenAI?
      - Can I shrink the number of dimensions in the embeddings I get back?
      instructions:
      - text: Embed {input} with embeddings deployment {deploymentId}.
        slots:
          input: requestBody.input
          deploymentId: path.deploymentId
      - text: Get {dimensions}-dimension embeddings of {input} from {deploymentId}.
        slots:
          dimensions: requestBody.dimensions
          input: requestBody.input
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deploymentId}/images/generations'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an image from a prompt
      effect: write
      questions:
      - How do I create an image from a text description with my Azure OpenAI deployment?
      - Which image sizes, quality and styles can I request?
      instructions:
      - text: Generate an image of {prompt} on deployment {deploymentId}.
        slots:
          prompt: requestBody.prompt
          deploymentId: path.deploymentId
      - text: Create {n} images of {prompt} at size {size} and quality {quality} using {deploymentId}.
        slots:
          n: requestBody.n
          prompt: requestBody.prompt
          size: requestBody.size
          quality: requestBody.quality
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployments on an Azure OpenAI resource
      effect: read
      questions:
      - Which model deployments does my Azure OpenAI resource own?
      - Can I list OpenAI deployments from the resource's own data-plane endpoint?
      instructions:
      - text: List the deployments on my Azure OpenAI resource.
      - text: List Azure OpenAI resource deployments using API version {apiVersion}.
        slots:
          apiVersion: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a deployment on an Azure OpenAI resource
      effect: write
      questions:
      - How do I create a new model deployment directly on my Azure OpenAI endpoint?
      - What scale settings do I need when deploying a model via the OpenAI data plane?
      instructions:
      - text: Create an Azure OpenAI deployment of model {model} with scale settings {scale_settings}.
        slots:
          model: requestBody.model
          scale_settings: requestBody.scale_settings
      - text: Deploy model {model} on my OpenAI resource with standard scale settings {scale_settings}.
        slots:
          model: requestBody.model
          scale_settings: requestBody.scale_settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Azure OpenAI deployment (deployment_id path)
      effect: read
      questions:
      - How do I fetch one Azure OpenAI deployment using the underscore deployment_id route?
      - What model and status does an OpenAI data-plane deployment report?
      instructions:
      - text: Get Azure OpenAI deployment {deployment_id} via the deployment_id route.
        slots:
          deployment_id: path.deployment_id
      - text: Show model and scale settings for OpenAI deployment_id {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Azure OpenAI deployment (deployment_id path)
      effect: destructive
      questions:
      - How do I delete an OpenAI data-plane deployment through the deployment_id route?
      - Is removing a deployment by deployment_id immediate?
      instructions:
      - text: Delete Azure OpenAI deployment {deployment_id} via the deployment_id route.
        slots:
          deployment_id: path.deployment_id
      - text: Remove OpenAI deployment_id {deployment_id} from my resource.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an Azure OpenAI deployment (deployment_id path)
      effect: write
      questions:
      - Can I change the model or scale of an OpenAI deployment via the deployment_id route?
      - Which fields of an OpenAI data-plane deployment are mutable through the underscore route?
      instructions:
      - text: Change scale settings of OpenAI deployment_id {deployment_id} to {scale_settings}.
        slots:
          deployment_id: path.deployment_id
          scale_settings: requestBody.scale_settings
      - text: Switch OpenAI deployment_id {deployment_id} to model {model}.
        slots:
          deployment_id: path.deployment_id
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Azure OpenAI deployment (deployment-id path)
      effect: read
      questions:
      - How do I fetch one Azure OpenAI deployment using the hyphenated deployment-id route?
      - Can I check a data-plane deployment's scale settings via the deployment-id path?
      instructions:
      - text: Get Azure OpenAI deployment {deploymentId} via the hyphenated deployment-id route.
        slots:
          deploymentId: path.deployment-id
      - text: Show details of OpenAI deployment-id {deploymentId}.
        slots:
          deploymentId: path.deployment-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Azure OpenAI deployment (deployment-id path)
      effect: destructive
      questions:
      - How do I delete an OpenAI data-plane deployment through the hyphenated deployment-id route?
      - Can I remove a deployment using the deployment-id path instead of deployment_id?
      instructions:
      - text: Delete Azure OpenAI deployment {deploymentId} via the hyphenated deployment-id route.
        slots:
          deploymentId: path.deployment-id
      - text: Remove OpenAI deployment-id {deploymentId} from my resource.
        slots:
          deploymentId: path.deployment-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an Azure OpenAI deployment (deployment-id path)
      effect: write
      questions:
      - Can I change the model or scale of an OpenAI deployment via the hyphenated deployment-id route?
      - Which fields can I patch on a deployment through the deployment-id path?
      instructions:
      - text: Change scale settings of OpenAI deployment-id {deploymentId} to {scale_settings}.
        slots:
          deploymentId: path.deployment-id
          scale_settings: requestBody.scale_settings
      - text: Switch OpenAI deployment-id {deploymentId} to model {model}.
        slots:
          deploymentId: path.deployment-id
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment-id}/completions'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a prompt (older deployment-id route)
      effect: write
      questions:
      - How do I get a completion through the older deployment-id completions route?
      - Can I pass a completion_config when using the legacy completions endpoint?
      instructions:
      - text: Complete {prompt} on legacy route deployment-id {deploymentId}.
        slots:
          prompt: requestBody.prompt
          deploymentId: path.deployment-id
      - text: Run the older completions endpoint on {deploymentId} with prompt {prompt} and best_of {best_of}.
        slots:
          deploymentId: path.deployment-id
          prompt: requestBody.prompt
          best_of: requestBody.best_of
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment-id}/embeddings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create embeddings (older deployment-id route)
      effect: read
      questions:
      - How do I get a vector representation of text through the older deployment-id embeddings route?
      - Does the legacy embeddings endpoint let me set the encoding format?
      instructions:
      - text: Embed {input} on legacy route deployment-id {deploymentId}.
        slots:
          input: requestBody.input
          deploymentId: path.deployment-id
      - text: Get {encoding_format} embeddings of {input} from older deployment-id {deploymentId}.
        slots:
          encoding_format: requestBody.encoding_format
          input: requestBody.input
          deploymentId: path.deployment-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment-id}/chat/completions'].post
  update:
    x-apievangelist-phrasing:
      intent: Chat completion (older deployment-id route)
      effect: write
      questions:
      - How do I call chat completions through the older deployment-id route?
      - Can the legacy chat endpoint still use function calling?
      instructions:
      - text: Send chat messages {messages} to legacy route deployment-id {deploymentId}.
        slots:
          messages: requestBody.messages
          deploymentId: path.deployment-id
      - text: Get a chat reply from older deployment-id {deploymentId} with functions {functions}.
        slots:
          deploymentId: path.deployment-id
          functions: requestBody.functions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment-id}/audio/transcriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Transcribe audio (older deployment-id route)
      effect: write
      questions:
      - How do I transcribe audio through the older deployment-id transcription route?
      - Can the legacy transcription endpoint take a language hint?
      instructions:
      - text: Transcribe {file} on legacy route deployment-id {deploymentId}.
        slots:
          file: requestBody.file
          deploymentId: path.deployment-id
      - text: Transcribe {file} as {language} via older deployment-id {deploymentId}.
        slots:
          file: requestBody.file
          language: requestBody.language
          deploymentId: path.deployment-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment-id}/audio/translations'].post
  update:
    x-apievangelist-phrasing:
      intent: Translate audio to English (older deployment-id route)
      effect: write
      questions:
      - How do I translate audio into English through the older deployment-id route?
      - Can I set temperature on the legacy audio translation endpoint?
      instructions:
      - text: Translate {file} to English on legacy route deployment-id {deploymentId}.
        slots:
          file: requestBody.file
          deploymentId: path.deployment-id
      - text: Translate audio {file} into English text via older deployment-id {deploymentId} with prompt {prompt}.
        slots:
          file: requestBody.file
          deploymentId: path.deployment-id
          prompt: requestBody.prompt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment-id}/audio/speech'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate speech (older deployment-id route)
      effect: write
      questions:
      - How do I generate speech audio through the older deployment-id route?
      - Which voices can the legacy speech endpoint use?
      instructions:
      - text: Speak {input} with voice {voice} on legacy route deployment-id {deploymentId}.
        slots:
          input: requestBody.input
          voice: requestBody.voice
          deploymentId: path.deployment-id
      - text: Create {response_format} audio of {input} in voice {voice} via older deployment-id {deploymentId}.
        slots:
          response_format: requestBody.response_format
          input: requestBody.input
          voice: requestBody.voice
          deploymentId: path.deployment-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment-id}/images/generations'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate images with DALL-E (older deployment-id route)
      effect: write
      questions:
      - How do I generate a batch of images from a caption on a DALL-E deployment via the older route?
      - Can the legacy image endpoint return several images at once?
      instructions:
      - text: Generate images of {prompt} on legacy DALL-E route deployment-id {deploymentId}.
        slots:
          prompt: requestBody.prompt
          deploymentId: path.deployment-id
      - text: Create {n} DALL-E images of {prompt} in style {style} via older deployment-id {deploymentId}.
        slots:
          n: requestBody.n
          prompt: requestBody.prompt
          style: requestBody.style
          deploymentId: path.deployment-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource group deployment (short path)
      effect: read
      questions:
      - How do I look up a template deployment in a resource group using the short deployments path?
      - Can I check a resource group deployment without the Microsoft.Resources provider segment?
      instructions:
      - text: Get deployment {deploymentName} in resource group {rg} via the short path without the provider segment.
        slots:
          deploymentName: path.deploymentName
          rg: path.resourceGroupName
      - text: Show resource group deployment {deploymentName} in {rg}, subscription {sub}, using the shorter route.
        slots:
          deploymentName: path.deploymentName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Deploy to a resource group (short path)
      effect: write
      questions:
      - How do I deploy a template to a resource group through the short deployments path?
      - Can I link to template and parameter files on the shorter resource group deployment route?
      instructions:
      - text: Deploy {properties} to resource group {rg} as {deploymentName} via the short path without the provider segment.
        slots:
          properties: requestBody.properties
          rg: path.resourceGroupName
          deploymentName: path.deploymentName
      - text: Run template deployment {deploymentName} in {rg}, subscription {sub}, on the shorter route.
        slots:
          deploymentName: path.deploymentName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List Azure Sphere deployments for a device group
      effect: read
      questions:
      - Which image deployments have gone to an Azure Sphere device group?
      - Can I page through Sphere device group deployments with a filter?
      instructions:
      - text: List deployments for device group {deviceGroupName} of product {productName} in catalog {catalogName}.
        slots:
          deviceGroupName: path.deviceGroupName
          productName: path.productName
          catalogName: path.catalogName
      - text: List the top {top} Sphere deployments in device group {deviceGroupName} matching {filter}.
        slots:
          top: query.$top
          deviceGroupName: path.deviceGroupName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Azure Sphere deployment
      effect: read
      questions:
      - How do I view a specific deployment sent to an Azure Sphere device group?
      - What images are included in one Sphere device group deployment?
      instructions:
      - text: Show Sphere deployment {deploymentName} in device group {deviceGroupName}.
        slots:
          deploymentName: path.deploymentName
          deviceGroupName: path.deviceGroupName
      - text: Get Sphere deployment {deploymentName} for product {productName} in catalog {catalogName}.
        slots:
          deploymentName: path.deploymentName
          productName: path.productName
          catalogName: path.catalogName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an Azure Sphere deployment
      effect: write
      questions:
      - How do I push a new deployment to an Azure Sphere device group?
      - Why can't I use '.default' or '.unassigned' as a device group name for a deployment?
      instructions:
      - text: Create Sphere deployment {deploymentName} in device group {deviceGroupName} with {properties}.
        slots:
          deploymentName: path.deploymentName
          deviceGroupName: path.deviceGroupName
          properties: requestBody.properties
      - text: Deploy to Sphere product {productName} device group {deviceGroupName} in catalog {catalogName} as {deploymentName}.
        slots:
          productName: path.productName
          deviceGroupName: path.deviceGroupName
          catalogName: path.catalogName
          deploymentName: path.deploymentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Azure Sphere deployment
      effect: destructive
      questions:
      - How do I remove a deployment from an Azure Sphere device group?
      - Can I delete a Sphere deployment I pushed by mistake?
      instructions:
      - text: Delete Sphere deployment {deploymentName} from device group {deviceGroupName}.
        slots:
          deploymentName: path.deploymentName
          deviceGroupName: path.deviceGroupName
      - text: Remove Sphere deployment {deploymentName} under product {productName}, catalog {catalogName}.
        slots:
          deploymentName: path.deploymentName
          productName: path.productName
          catalogName: path.catalogName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a template deployment at any scope
      effect: read
      questions:
      - How do I look up a template deployment when I only have its full scope string?
      - Can I read a deployment's provisioning state at an arbitrary ARM scope?
      instructions:
      - text: Get deployment {name} at scope {scope}.
        slots:
          name: path.deploymentName
          scope: path.scope
      - text: Show the status of deployment {name} under scope path {scope}.
        slots:
          name: path.deploymentName
          scope: path.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Deploy a template at any scope
      effect: write
      questions:
      - How do I deploy an ARM template to a scope given as a full resource path?
      - Can I deploy to an arbitrary scope with a linked template file?
      instructions:
      - text: Deploy {properties} at scope {scope} as deployment {name}.
        slots:
          properties: requestBody.properties
          scope: path.scope
          name: path.deploymentName
      - text: Start template deployment {name} at scope path {scope} in location {location}.
        slots:
          name: path.deploymentName
          scope: path.scope
          location: requestBody.location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deployment from history at any scope
      effect: destructive
      questions:
      - How do I remove an old deployment record at a generic scope?
      - Can I delete a deployment at a scope while it's still running?
      instructions:
      - text: Delete deployment {name} from the history at scope {scope}.
        slots:
          name: path.deploymentName
          scope: path.scope
      - text: Remove the deployment record {name} under scope path {scope}.
        slots:
          name: path.deploymentName
          scope: path.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check a deployment exists at any scope
      effect: read
      questions:
      - Is there already a deployment with a given name at a particular scope?
      - How do I quickly test for a deployment's existence at an arbitrary scope?
      instructions:
      - text: Check whether deployment {name} exists at scope {scope}.
        slots:
          name: path.deploymentName
          scope: path.scope
      - text: Tell me if scope {scope} already has a deployment called {name}.
        slots:
          scope: path.scope
          name: path.deploymentName
      method: generated
      generated: '2026-09-26'


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