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://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
[--capacity --sku-capacity]
[--deployment-name]
[--model-source]
[--scale-capacity --scale-settings-capacity]
[--scale-settings-scale-type --scale-type {Manual, Standard}]
[--sku --sku-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
Cognitive Services account deployment model format.
Property | Value |
---|---|
Parameter group: | DeploymentModel Arguments |
Cognitive Services account deployment model name.
Property | Value |
---|---|
Parameter group: | DeploymentModel Arguments |
Cognitive Services account deployment model version.
Property | Value |
---|---|
Parameter group: | DeploymentModel Arguments |
Cognitive service account name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Capacity value of the Sku of Cognitive Services account/deployment.
Cognitive Services account deployment name.
Cognitive Services account deployment model source.
Property | Value |
---|---|
Parameter group: | DeploymentModel Arguments |
Cognitive Services account deployment scale settings capacity.
Property | Value |
---|---|
Parameter group: | DeploymentScaleSettings Arguments |
Cognitive Services account deployment scale settings scale type.
Property | Value |
---|---|
Parameter group: | DeploymentScaleSettings Arguments |
Accepted values: | Manual, Standard |
Name of the Sku of Cognitive Services account/deployment.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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://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
[--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
Cognitive service account name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Cognitive Services account deployment name.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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://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
Cognitive service account name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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://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
Cognitive service account name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Cognitive Services account deployment name.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |