az cognitiveservices account deployment

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 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 create

Experimental Preview Deprecated

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://docs.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
                                               [--capacity]
                                               [--deployment-name]
                                               [--model-source]
                                               [--scale-capacity]
                                               [--scale-settings-scale-type {Manual, Standard}]
                                               [--sku]

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
Experimental Preview Deprecated

Cognitive Services account deployment model format.

--model-name
Experimental Preview Deprecated

Cognitive Services account deployment model name.

--model-version
Experimental Preview Deprecated

Cognitive Services account deployment model version.

--name -n
Experimental Preview Deprecated

Cognitive service account name.

--resource-group -g
Experimental Preview Deprecated

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

Optional Parameters

--capacity --sku-capacity
Experimental Preview Deprecated

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

--deployment-name
Experimental Preview Deprecated

Cognitive Services account deployment name.

--model-source
Experimental Preview Deprecated

Cognitive Services account deployment model source.

--scale-capacity --scale-settings-capacity
Experimental Preview Deprecated

Cognitive Services account deployment scale settings capacity.

--scale-settings-scale-type --scale-type
Experimental Preview Deprecated

Cognitive Services account deployment scale settings scale type.

Accepted values: Manual, Standard
--sku --sku-name
Experimental Preview Deprecated

Name of the Sku of Cognitive Services account/deployment.

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az cognitiveservices account deployment delete

Experimental Preview Deprecated

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://docs.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
                                               [--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
Experimental Preview Deprecated

Cognitive service account name.

--resource-group -g
Experimental Preview Deprecated

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

Optional Parameters

--deployment-name
Experimental Preview Deprecated

Cognitive Services account deployment name.

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az cognitiveservices account deployment list

Experimental Preview Deprecated

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://docs.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
Experimental Preview Deprecated

Cognitive service account name.

--resource-group -g
Experimental Preview Deprecated

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

Optional Parameters

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az cognitiveservices account deployment show

Experimental Preview Deprecated

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://docs.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
Experimental Preview Deprecated

Cognitive service account name.

--resource-group -g
Experimental Preview Deprecated

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

Optional Parameters

--deployment-name
Experimental Preview Deprecated

Cognitive Services account deployment name.

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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