# 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' - target: $.paths['/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel'].post update: x-apievangelist-phrasing: intent: Cancel a running deployment at any scope effect: destructive questions: - How do I stop a template deployment that's still running at a generic scope? - Can I cancel a deployment at a scope once it has already succeeded? instructions: - text: Cancel running deployment {name} at scope {scope}. slots: name: path.deploymentName scope: path.scope - text: Stop deployment {name} under scope path {scope} while it is in progress. slots: name: path.deploymentName scope: path.scope method: generated generated: '2026-09-26' - target: $.paths['/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate'].post update: x-apievangelist-phrasing: intent: Validate a template at any scope effect: read questions: - Will Resource Manager accept my template at a specific scope before I deploy it? - How do I check a template for errors at an arbitrary scope? instructions: - text: Validate template {properties} for deployment {name} at scope {scope}. slots: properties: requestBody.properties name: path.deploymentName scope: path.scope - text: Check that deployment {name} would be accepted at scope path {scope}. slots: name: path.deploymentName scope: path.scope method: generated generated: '2026-09-26' - target: $.paths['/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate'].post update: x-apievangelist-phrasing: intent: Export a deployment's template at any scope effect: read questions: - How do I get back the template a past deployment used at a generic scope? - Can I download the template from a deployment at an arbitrary scope? instructions: - text: Export the template of deployment {name} at scope {scope}. slots: name: path.deploymentName scope: path.scope - text: Give me the template used by 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/'].get update: x-apievangelist-phrasing: intent: List deployments at any scope effect: read questions: - Which deployments have run at a given scope? - Can I filter the deployment list at a scope by provisioning state? instructions: - text: List deployments at scope {scope}. slots: scope: path.scope - text: List the top {top} deployments at scope path {scope} matching {filter}. slots: top: query.$top scope: path.scope filter: query.$filter method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Resources/deployments/{deploymentName}'].get update: x-apievangelist-phrasing: intent: Get a tenant-level deployment effect: read questions: - How do I look up a deployment made at the tenant root? - Can I check the provisioning state of a tenant-scope template deployment? instructions: - text: Get tenant-level deployment {name}. slots: name: path.deploymentName - text: Show the status of tenant deployment {name}. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Resources/deployments/{deploymentName}'].put update: x-apievangelist-phrasing: intent: Deploy a template at tenant scope effect: write questions: - How do I deploy an ARM template at the tenant level? - Do I have to give a location when deploying at tenant scope? instructions: - text: Deploy {properties} at tenant scope as {name} in location {location}. slots: properties: requestBody.properties name: path.deploymentName location: requestBody.location - text: Start tenant-level deployment {name} with template properties {properties}. slots: name: path.deploymentName properties: requestBody.properties method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Resources/deployments/{deploymentName}'].delete update: x-apievangelist-phrasing: intent: Delete a tenant-level deployment from history effect: destructive questions: - How do I clean up an old tenant-scope deployment record? - Does deleting a tenant deployment also remove its deployment operations? instructions: - text: Delete tenant-level deployment {name} from history. slots: name: path.deploymentName - text: Remove the tenant deployment record {name}. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Resources/deployments/{deploymentName}'].head update: x-apievangelist-phrasing: intent: Check a tenant-level deployment exists effect: read questions: - Is there already a tenant-scope deployment with this name? - How do I test whether a tenant deployment exists without fetching it? instructions: - text: Check whether tenant deployment {name} exists. slots: name: path.deploymentName - text: Tell me if the tenant root has a deployment called {name}. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Resources/deployments/{deploymentName}/cancel'].post update: x-apievangelist-phrasing: intent: Cancel a running tenant-level deployment effect: destructive questions: - How do I stop a tenant-scope deployment that's still running? - Can a tenant deployment be canceled once it's past the Running state? instructions: - text: Cancel running tenant deployment {name}. slots: name: path.deploymentName - text: Stop tenant-level deployment {name} while it is in progress. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Resources/deployments/{deploymentName}/validate'].post update: x-apievangelist-phrasing: intent: Validate a template at tenant scope effect: read questions: - Will my tenant-level template be accepted before I deploy it? - How do I check a tenant-scope template for syntax errors? instructions: - text: Validate template {properties} for tenant deployment {name} in {location}. slots: properties: requestBody.properties name: path.deploymentName location: requestBody.location - text: Check that tenant-level deployment {name} would be accepted. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf'].post update: x-apievangelist-phrasing: intent: Preview changes of a tenant-level deployment effect: read questions: - What would change if I ran this template at the tenant level? - Can I preview a tenant-scope deployment without applying it? instructions: - text: Show what-if changes for tenant deployment {name} with {properties} in {location}. slots: name: path.deploymentName properties: requestBody.properties location: requestBody.location - text: Preview tenant-level deployment {name} before running it. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate'].post update: x-apievangelist-phrasing: intent: Export a tenant-level deployment's template effect: read questions: - How do I retrieve the template a tenant-scope deployment used? - Can I export the template from a past tenant deployment? instructions: - text: Export the template of tenant deployment {name}. slots: name: path.deploymentName - text: Give me the template used by tenant-level deployment {name}. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Resources/deployments/'].get update: x-apievangelist-phrasing: intent: List tenant-level deployments effect: read questions: - Which deployments have been run at the tenant root? - Can I limit how many tenant deployments come back? instructions: - text: List all tenant-level deployments. - text: List the top {top} tenant deployments matching {filter}. slots: top: query.$top filter: query.$filter method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}'].get update: x-apievangelist-phrasing: intent: Get a management group deployment effect: read questions: - How do I look up a deployment made at a management group? - Can I check the state of a template deployment in one management group? instructions: - text: Get deployment {name} in management group {group}. slots: name: path.deploymentName group: path.groupId - text: Show the status of management group {group} deployment {name}. slots: group: path.groupId name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}'].put update: x-apievangelist-phrasing: intent: Deploy a template to a management group effect: write questions: - How do I deploy policies or resources with a template at management group level? - Is a location required for management group deployments? instructions: - text: Deploy {properties} to management group {group} as {name} in {location}. slots: properties: requestBody.properties group: path.groupId name: path.deploymentName location: requestBody.location - text: Start management group deployment {name} in {group}. slots: name: path.deploymentName group: path.groupId method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}'].delete update: x-apievangelist-phrasing: intent: Delete a management group deployment from history effect: destructive questions: - How do I remove an old deployment record from a management group? - Can I delete a management group deployment that's still running? instructions: - text: Delete deployment {name} from management group {group} history. slots: name: path.deploymentName group: path.groupId - text: Remove the management group {group} deployment record {name}. slots: group: path.groupId name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}'].head update: x-apievangelist-phrasing: intent: Check a management group deployment exists effect: read questions: - Does a management group already have a deployment with this name? - How do I test for a deployment's existence in a management group? instructions: - text: Check whether deployment {name} exists in management group {group}. slots: name: path.deploymentName group: path.groupId - text: Tell me if management group {group} has a deployment called {name}. slots: group: path.groupId name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel'].post update: x-apievangelist-phrasing: intent: Cancel a running management group deployment effect: destructive questions: - How do I stop a management group deployment that's still running? - Can I cancel a management group deployment after it has been accepted? instructions: - text: Cancel running deployment {name} in management group {group}. slots: name: path.deploymentName group: path.groupId - text: Stop management group {group} deployment {name} while it is in progress. slots: group: path.groupId name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate'].post update: x-apievangelist-phrasing: intent: Validate a template for a management group effect: read questions: - Will my management group template be accepted before I deploy it? - How do I check a management group deployment template for errors? instructions: - text: Validate template {properties} for deployment {name} in management group {group} at {location}. slots: properties: requestBody.properties name: path.deploymentName group: path.groupId location: requestBody.location - text: Check that management group {group} would accept deployment {name}. slots: group: path.groupId name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf'].post update: x-apievangelist-phrasing: intent: Preview changes of a management group deployment effect: read questions: - What would change if I deployed this template to a management group? - Can I do a what-if run for a management group deployment? instructions: - text: Show what-if changes for deployment {name} in management group {group} with {properties} at {location}. slots: name: path.deploymentName group: path.groupId properties: requestBody.properties location: requestBody.location - text: Preview management group {group} deployment {name} before running it. slots: group: path.groupId name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate'].post update: x-apievangelist-phrasing: intent: Export a management group deployment's template effect: read questions: - How do I get the template a management group deployment used? - Can I export the template from a past management group deployment? instructions: - text: Export the template of deployment {name} in management group {group}. slots: name: path.deploymentName group: path.groupId - text: Give me the template used by management group {group} deployment {name}. slots: group: path.groupId name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/'].get update: x-apievangelist-phrasing: intent: List deployments in a management group effect: read questions: - Which deployments have run at a given management group? - Can I filter management group deployments by state? instructions: - text: List deployments in management group {group}. slots: group: path.groupId - text: List the top {top} deployments in management group {group} matching {filter}. slots: top: query.$top group: path.groupId filter: query.$filter method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}'].get update: x-apievangelist-phrasing: intent: Get a subscription-level deployment effect: read questions: - How do I look up a deployment made at subscription scope? - Can I check the state of a subscription-level template deployment? instructions: - text: Get subscription-level deployment {name} in subscription {sub}. slots: name: path.deploymentName sub: path.subscriptionId - text: Show the status of subscription deployment {name}. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}'].put update: x-apievangelist-phrasing: intent: Deploy a template at subscription scope effect: write questions: - How do I deploy a template that creates resource groups at subscription level? - Can I run a subscription-scope deployment with a linked parameters file? instructions: - text: Deploy {properties} to subscription {sub} as subscription-level deployment {name}. slots: properties: requestBody.properties sub: path.subscriptionId name: path.deploymentName - text: Start subscription deployment {name} in location {location}. slots: name: path.deploymentName location: requestBody.location method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}'].delete update: x-apievangelist-phrasing: intent: Delete a subscription-level deployment from history effect: destructive questions: - How do I remove an old subscription-scope deployment record? - Are the resources removed when I delete a subscription deployment from history? instructions: - text: Delete subscription-level deployment {name} from subscription {sub} history. slots: name: path.deploymentName sub: path.subscriptionId - text: Remove the subscription deployment record {name}. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}'].head update: x-apievangelist-phrasing: intent: Check a subscription-level deployment exists effect: read questions: - Does my subscription already have a subscription-scope deployment with this name? - How do I test for a subscription deployment's existence? instructions: - text: Check whether subscription-level deployment {name} exists in {sub}. slots: name: path.deploymentName sub: path.subscriptionId - text: Tell me if my subscription has a subscription-scope deployment called {name}. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel'].post update: x-apievangelist-phrasing: intent: Cancel a running subscription-level deployment effect: destructive questions: - How do I stop a subscription-scope deployment that's still running? - What state does a subscription deployment go to after I cancel it? instructions: - text: Cancel running subscription-level deployment {name} in {sub}. slots: name: path.deploymentName sub: path.subscriptionId - text: Stop subscription deployment {name} while it is in progress. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate'].post update: x-apievangelist-phrasing: intent: Validate a template at subscription scope effect: read questions: - Will my subscription-level template be accepted before I deploy it? - How do I check a subscription-scope template for errors? instructions: - text: Validate template {properties} for subscription-level deployment {name} in {sub}. slots: properties: requestBody.properties name: path.deploymentName sub: path.subscriptionId - text: Check that subscription deployment {name} would be accepted. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf'].post update: x-apievangelist-phrasing: intent: Preview changes of a subscription-level deployment effect: read questions: - What would change in my subscription if I ran this template? - Can I do a what-if on a subscription-scope deployment first? instructions: - text: Show what-if changes for subscription-level deployment {name} in {sub} with {properties}. slots: name: path.deploymentName sub: path.subscriptionId properties: requestBody.properties - text: Preview subscription deployment {name} before running it. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate'].post update: x-apievangelist-phrasing: intent: Export a subscription-level deployment's template effect: read questions: - How do I get the template a subscription-scope deployment used? - Can I export the template of a past subscription deployment? instructions: - text: Export the template of subscription-level deployment {name} in {sub}. slots: name: path.deploymentName sub: path.subscriptionId - text: Give me the template used by subscription deployment {name}. slots: name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/'].get update: x-apievangelist-phrasing: intent: List subscription-level deployments effect: read questions: - Which subscription-scope deployments have run in my subscription? - Can I filter subscription deployments by provisioning state? instructions: - text: List subscription-level deployments in {sub}. slots: sub: path.subscriptionId - text: List the top {top} subscription deployments matching {filter}. slots: top: query.$top filter: query.$filter method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}'].get update: x-apievangelist-phrasing: intent: Get a resource group deployment effect: read questions: - How do I check on a template deployment in a resource group? - Did my resource group deployment succeed or fail? instructions: - text: Get deployment {name} in resource group {rg}. slots: name: path.deploymentName rg: path.resourceGroupName - text: Show the status of resource group deployment {name} in {rg}, subscription {sub}. slots: name: path.deploymentName rg: path.resourceGroupName sub: path.subscriptionId method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}'].put update: x-apievangelist-phrasing: intent: Deploy a template to a resource group effect: write questions: - How do I deploy an ARM or Bicep-compiled template into a resource group? - Can I pass template parameters inline when deploying to a resource group? instructions: - text: Deploy {properties} to resource group {rg} as deployment {name}. slots: properties: requestBody.properties rg: path.resourceGroupName name: path.deploymentName - text: Start resource group deployment {name} in {rg}, subscription {sub}. slots: name: path.deploymentName rg: path.resourceGroupName sub: path.subscriptionId method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}'].delete update: x-apievangelist-phrasing: intent: Delete a resource group deployment from history effect: destructive questions: - How do I remove an old deployment record from a resource group's history? - Does deleting a resource group deployment remove the resources it created? instructions: - text: Delete deployment {name} from resource group {rg} history. slots: name: path.deploymentName rg: path.resourceGroupName - text: Remove resource group deployment record {name} in {rg}, subscription {sub}. slots: name: path.deploymentName rg: path.resourceGroupName sub: path.subscriptionId method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}'].head update: x-apievangelist-phrasing: intent: Check a resource group deployment exists effect: read questions: - Is there already a deployment with this name in my resource group? - How do I test for a resource group deployment without fetching it? instructions: - text: Check whether deployment {name} exists in resource group {rg}. slots: name: path.deploymentName rg: path.resourceGroupName - text: Tell me if resource group {rg} in subscription {sub} has a deployment called {name}. slots: rg: path.resourceGroupName sub: path.subscriptionId name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel'].post update: x-apievangelist-phrasing: intent: Cancel a running resource group deployment effect: destructive questions: - How do I stop a resource group deployment that's still running? - Does canceling a resource group deployment roll back resources already created? instructions: - text: Cancel running deployment {name} in resource group {rg}. slots: name: path.deploymentName rg: path.resourceGroupName - text: Stop resource group deployment {name} in {rg}, subscription {sub}, while in progress. slots: name: path.deploymentName rg: path.resourceGroupName sub: path.subscriptionId method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate'].post update: x-apievangelist-phrasing: intent: Validate a template for a resource group effect: read questions: - Will my template be accepted by a resource group before I deploy it? - How do I catch template syntax errors for a resource group deployment? instructions: - text: Validate template {properties} for deployment {name} in resource group {rg}. slots: properties: requestBody.properties name: path.deploymentName rg: path.resourceGroupName - text: Check that resource group {rg} in subscription {sub} would accept deployment {name}. slots: rg: path.resourceGroupName sub: path.subscriptionId name: path.deploymentName method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf'].post update: x-apievangelist-phrasing: intent: Preview changes of a resource group deployment effect: read questions: - What would change in my resource group if I deployed this template? - Can I run what-if on a resource group deployment before applying it? instructions: - text: Show what-if changes for deployment {name} in resource group {rg} with {properties}. slots: name: path.deploymentName rg: path.resourceGroupName properties: requestBody.properties - text: Preview resource group {rg} deployment {name} in subscription {sub}. slots: rg: path.resourceGroupName name: path.deploymentName sub: path.subscriptionId method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate'].post update: x-apievangelist-phrasing: intent: Export a resource group deployment's template effect: read questions: - How do I get the template a resource group deployment used? - Can I export the template of a finished resource group deployment? instructions: - text: Export the template of deployment {name} in resource group {rg}. slots: name: path.deploymentName rg: path.resourceGroupName - text: Give me the template used by resource group deployment {name} in {rg}, subscription {sub}. slots: name: path.deploymentName rg: path.resourceGroupName sub: path.subscriptionId method: generated generated: '2026-09-26' - target: $.paths['/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/'].get update: x-apievangelist-phrasing: intent: List deployments in a resource group effect: read questions: - Which template deployments have run in a resource group? - Can I see only failed deployments in a resource group? instructions: - text: List deployments in resource group {rg} of subscription {sub}. slots: rg: path.resourceGroupName sub: path.subscriptionId - text: List the top {top} deployments in {rg} matching {filter}. slots: top: query.$top rg: path.resourceGroupName filter: query.$filter method: generated generated: '2026-09-26' - target: $.paths['/providers/Microsoft.Resources/calculateTemplateHash'].post update: x-apievangelist-phrasing: intent: Calculate a template's hash effect: read questions: - How do I compute the hash of an ARM template to detect changes? - Can Resource Manager tell me a template's hash without deploying it? instructions: - text: Calculate the hash of my ARM template. - text: Compute a template hash using API version {apiVersion}. slots: apiVersion: query.api-version method: generated generated: '2026-09-26'