az cognitiveservices account deployment

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage deployments for Azure Cognitive Services accounts.

Commands

Name Description Type Status
az cognitiveservices account deployment create

Create a deployment for Azure Cognitive Services account.

 Core GA
az cognitiveservices account deployment create (foundry-cost-control extension)

Create a Cognitive Services account deployment.

 Extension Preview
az cognitiveservices account deployment delete

Delete a deployment from Azure Cognitive Services account.

 Core GA
az cognitiveservices account deployment list

Show all deployments for Azure Cognitive Services account.

 Core GA
az cognitiveservices account deployment show

Show a deployment for Azure Cognitive Services account.

 Core GA
az cognitiveservices account deployment update

Update a Cognitive Services account deployment.

 Extension Preview

az cognitiveservices account deployment create

Edit

Create a deployment for Azure Cognitive Services account.

This article lists the Azure CLI commands for Azure Cognitive Services account and subscription management only. Refer to the documentation at https://learn.microsoft.com/azure/cognitive-services/ for individual services to learn how to use the APIs and supported SDKs.

az cognitiveservices account deployment create --model-format
                                               --model-name
                                               --model-version
                                               --name
                                               --resource-group
                                               [--acquire-policy-token]
                                               [--capacity --sku-capacity]
                                               [--change-reference]
                                               [--deployment-name]
                                               [--model-source]
                                               [--scale-capacity --scale-settings-capacity]
                                               [--scale-settings-scale-type --scale-type {Manual, Standard}]
                                               [--sku --sku-name]
                                               [--spillover-deployment-name --spillover-name]

Examples

Create a deployment for Azure Cognitive Services account.

az cognitiveservices account deployment create -g yuanyang-test-sdk -n yytest-oai --deployment-name dpy --model-name ada --model-version "1" --model-format OpenAI --sku-capacity 1 --sku-name "Standard"

Required Parameters

--model-format

Cognitive Services account deployment model format.

Property Value
Parameter group: DeploymentModel Arguments
--model-name

Cognitive Services account deployment model name.

Property Value
Parameter group: DeploymentModel Arguments
--model-version

Cognitive Services account deployment model version.

Property Value
Parameter group: DeploymentModel Arguments
--name -n

Cognitive service account name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--capacity --sku-capacity

Capacity value of the Sku of Cognitive Services account/deployment.

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--deployment-name

Cognitive Services account deployment name.

--model-source

Cognitive Services account deployment model source.

Property Value
Parameter group: DeploymentModel Arguments
--scale-capacity --scale-settings-capacity

Cognitive Services account deployment scale settings capacity.

Property Value
Parameter group: DeploymentScaleSettings Arguments
--scale-settings-scale-type --scale-type

Cognitive Services account deployment scale settings scale type.

Property Value
Parameter group: DeploymentScaleSettings Arguments
Accepted values: Manual, Standard
--sku --sku-name

Name of the Sku of Cognitive Services account/deployment.

--spillover-deployment-name --spillover-name

The name of the standard deployment to use as a spillover when at capacity.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az cognitiveservices account deployment create (foundry-cost-control extension)

Preview

Command group 'az cognitiveservices' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Cognitive Services account deployment.

az cognitiveservices account deployment create --deployment-name
                                               --model-format
                                               --model-name
                                               --model-version
                                               --name
                                               --resource-group
                                               [--acquire-policy-token]
                                               [--capacity --sku-capacity]
                                               [--change-reference]
                                               [--cost-control-ids]
                                               [--model-source]
                                               [--scale-capacity --scale-settings-capacity]
                                               [--scale-settings-scale-type --scale-type {Manual, Standard}]
                                               [--sku --sku-name]
                                               [--spillover-deployment-name --spillover-name]

Examples

Create a deployment with a cost-control attachment

az cognitiveservices account deployment create --name my-account --resource-group my-resource-group --deployment-name my-deployment --model-name gpt-4.1 --model-version 2025-04-14 --model-format OpenAI --sku-name GlobalStandard --sku-capacity 10 --cost-control-ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.CognitiveServices/accounts/my-account/costControls/my-control

Required Parameters

--deployment-name

Cognitive Services account deployment name.

--model-format

Cognitive Services account deployment model format.

Property Value
Parameter group: DeploymentModel Arguments
--model-name

Cognitive Services account deployment model name.

Property Value
Parameter group: DeploymentModel Arguments
--model-version

Cognitive Services account deployment model version.

Property Value
Parameter group: DeploymentModel Arguments
--name -n

Cognitive service account name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--capacity --sku-capacity

Capacity value of the Sku of Cognitive Services account/deployment.

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cost-control-ids

Resource ID of the cost control attached to the deployment. Specify the option without a value to remove the attachment.

Property Value
Parameter group: Cost Control Arguments
--model-source

Cognitive Services account deployment model source.

Property Value
Parameter group: DeploymentModel Arguments
--scale-capacity --scale-settings-capacity

Cognitive Services account deployment scale settings capacity.

Property Value
Parameter group: DeploymentScaleSettings Arguments
--scale-settings-scale-type --scale-type

Cognitive Services account deployment scale settings scale type.

Property Value
Parameter group: DeploymentScaleSettings Arguments
Accepted values: Manual, Standard
--sku --sku-name

Name of the Sku of Cognitive Services account/deployment.

--spillover-deployment-name --spillover-name

The standard deployment to use as a spillover when at capacity.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az cognitiveservices account deployment delete

Edit

Delete a deployment from Azure Cognitive Services account.

This article lists the Azure CLI commands for Azure Cognitive Services account and subscription management only. Refer to the documentation at https://learn.microsoft.com/azure/cognitive-services/ for individual services to learn how to use the APIs and supported SDKs.

az cognitiveservices account deployment delete --name
                                               --resource-group
                                               [--acquire-policy-token]
                                               [--change-reference]
                                               [--deployment-name]

Examples

Delete a deployment from Azure Cognitive Services account.

az cognitiveservices account deployment delete -g yuanyang-test-sdk -n yytest-oai --deployment-name dpy

Required Parameters

--name -n

Cognitive service account name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--deployment-name

Cognitive Services account deployment name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az cognitiveservices account deployment list

Edit

Show all deployments for Azure Cognitive Services account.

This article lists the Azure CLI commands for Azure Cognitive Services account and subscription management only. Refer to the documentation at https://learn.microsoft.com/azure/cognitive-services/ for individual services to learn how to use the APIs and supported SDKs.

az cognitiveservices account deployment list --name
                                             --resource-group

Examples

Show all deployments for Azure Cognitive Services account.

az cognitiveservices account deployment list -g yuanyang-test-sdk -n yytest-oai

Required Parameters

--name -n

Cognitive service account name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az cognitiveservices account deployment show

Edit

Show a deployment for Azure Cognitive Services account.

This article lists the Azure CLI commands for Azure Cognitive Services account and subscription management only. Refer to the documentation at https://learn.microsoft.com/azure/cognitive-services/ for individual services to learn how to use the APIs and supported SDKs.

az cognitiveservices account deployment show --name
                                             --resource-group
                                             [--deployment-name]

Examples

Show a deployment for Azure Cognitive Services account.

az cognitiveservices account deployment show -g yuanyang-test-sdk -n yytest-oai --deployment-name dpy

Required Parameters

--name -n

Cognitive service account name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--deployment-name

Cognitive Services account deployment name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az cognitiveservices account deployment update

Preview

Command group 'az cognitiveservices' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a Cognitive Services account deployment.

az cognitiveservices account deployment update --deployment-name
                                               --name
                                               --resource-group
                                               [--acquire-policy-token]
                                               [--change-reference]
                                               [--cost-control-ids]

Examples

Attach a cost control to an existing deployment

az cognitiveservices account deployment update --name my-account --resource-group my-resource-group --deployment-name my-deployment --cost-control-ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.CognitiveServices/accounts/my-account/costControls/my-control

Remove the cost-control attachment

az cognitiveservices account deployment update --name my-account --resource-group my-resource-group --deployment-name my-deployment --cost-control-ids

Required Parameters

--deployment-name

Cognitive Services account deployment name.

--name -n

Cognitive service account name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cost-control-ids

Resource ID of the cost control attached to the deployment. Specify the option without a value to remove the attachment.

Property Value
Parameter group: Cost Control Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False