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

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

Cognitive Services account deployment model format.

--model-name

Cognitive Services account deployment model name.

--model-version

Cognitive Services account deployment model version.

--name -n

Cognitive service account name.

--resource-group -g

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

Optional Parameters

--capacity --sku-capacity

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

--deployment-name

Cognitive Services account deployment name.

--model-source

Cognitive Services account deployment model source.

--scale-capacity --scale-settings-capacity

Cognitive Services account deployment scale settings capacity.

--scale-settings-scale-type --scale-type

Cognitive Services account deployment scale settings scale type.

Accepted values: Manual, Standard

--sku --sku-name

Name of the Sku of Cognitive Services account/deployment.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az cognitiveservices account deployment delete

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

Cognitive service account name.

--resource-group -g

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

Optional Parameters

--deployment-name

Cognitive Services account deployment name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az cognitiveservices account deployment list

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

Cognitive service account name.

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az cognitiveservices account deployment show

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

Cognitive service account name.

--resource-group -g

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

Optional Parameters

--deployment-name

Cognitive Services account deployment name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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