az discovery workspace chat-model-deployment

Note

This reference is part of the discovery extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az discovery workspace chat-model-deployment command. Learn more about extensions.

Manage Chat Model Deployment.

Commands

Name	Description	Type	Status
az discovery workspace chat-model-deployment create	Create a ChatModelDeployment.	Extension	GA
az discovery workspace chat-model-deployment delete	Delete a ChatModelDeployment.	Extension	GA
az discovery workspace chat-model-deployment list	List ChatModelDeployment resources by Workspace.	Extension	GA
az discovery workspace chat-model-deployment show	Get a ChatModelDeployment.	Extension	GA
az discovery workspace chat-model-deployment update	Update a ChatModelDeployment.	Extension	GA
az discovery workspace chat-model-deployment wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az discovery workspace chat-model-deployment create

Create a ChatModelDeployment.

az discovery workspace chat-model-deployment create --chat-model-deployment-name --name
                                                    --resource-group
                                                    --workspace-name
                                                    [--acquire-policy-token]
                                                    [--capacity]
                                                    [--change-reference]
                                                    [--location]
                                                    [--model-format]
                                                    [--model-name]
                                                    [--model-version]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--sku-name]
                                                    [--tags]

Examples

Create a chat model deployment for GPT-4o.

az discovery workspace chat-model-deployment create --resource-group MyResourceGroup --workspace-name MyWorkspace --name MyChatModelDeployment --location eastus --model-format OpenAI --model-name gpt-4o --capacity 10

Required Parameters

--chat-model-deployment-name --name -n

The name of the ChatModelDeployment.

--resource-group -g

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

--workspace-name

The name of the Workspace.

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

Provisioned SKU capacity units for this chat model deployment.

Property	Value
Parameter group:	Properties Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Resource Arguments

--model-format

Model format as published by the provider. Verify supported formats per region using the Model Catalog API.

Property	Value
Parameter group:	Properties Arguments

--model-name

Canonical provider model name available in the selected region. Verify supported values per region using the Model Catalog API.

Property	Value
Parameter group:	Properties Arguments

--model-version

Provider-published version of the selected model.

Property	Value
Parameter group:	Properties Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--sku-name

SKU tier used by this chat model deployment.

Property	Value
Parameter group:	Properties Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource 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

az discovery workspace chat-model-deployment delete

Delete a ChatModelDeployment.

az discovery workspace chat-model-deployment delete [--acquire-policy-token]
                                                    [--change-reference]
                                                    [--chat-model-deployment-name --name]
                                                    [--ids]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--workspace-name]
                                                    [--yes]

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

--chat-model-deployment-name --name -n

The name of the ChatModelDeployment.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

The name of the Workspace.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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.

--verbose

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

Property	Value
Default value:	False

az discovery workspace chat-model-deployment list

List ChatModelDeployment resources by Workspace.

az discovery workspace chat-model-deployment list --resource-group
                                                  --workspace-name
                                                  [--max-items]
                                                  [--next-token]

Required Parameters

--resource-group -g

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

--workspace-name

The name of the Workspace.

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination 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

az discovery workspace chat-model-deployment show

Get a ChatModelDeployment.

az discovery workspace chat-model-deployment show [--chat-model-deployment-name --name]
                                                  [--ids]
                                                  [--resource-group]
                                                  [--subscription]
                                                  [--workspace-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.

--chat-model-deployment-name --name -n

The name of the ChatModelDeployment.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

The name of the Workspace.

Property	Value
Parameter group:	Resource Id 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.

--verbose

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

Property	Value
Default value:	False

az discovery workspace chat-model-deployment update

Update a ChatModelDeployment.

az discovery workspace chat-model-deployment update [--acquire-policy-token]
                                                    [--add]
                                                    [--capacity]
                                                    [--change-reference]
                                                    [--chat-model-deployment-name --name]
                                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--ids]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--remove]
                                                    [--resource-group]
                                                    [--set]
                                                    [--subscription]
                                                    [--tags]
                                                    [--workspace-name]

Examples

Increase capacity for a chat model deployment.

az discovery workspace chat-model-deployment update --resource-group MyResourceGroup --workspace-name MyWorkspace --name MyChatModelDeployment --capacity 20

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--capacity

Provisioned SKU capacity units for this chat model deployment.

Property	Value
Parameter group:	Properties Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--chat-model-deployment-name --name -n

The name of the ChatModelDeployment.

Property	Value
Parameter group:	Resource Id Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

--workspace-name

The name of the Workspace.

Property	Value
Parameter group:	Resource Id 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.

--verbose

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

Property	Value
Default value:	False

az discovery workspace chat-model-deployment wait

Place the CLI in a waiting state until a condition is met.

az discovery workspace chat-model-deployment wait [--acquire-policy-token]
                                                  [--change-reference]
                                                  [--chat-model-deployment-name --name]
                                                  [--created]
                                                  [--custom]
                                                  [--deleted]
                                                  [--exists]
                                                  [--ids]
                                                  [--interval]
                                                  [--resource-group]
                                                  [--subscription]
                                                  [--timeout]
                                                  [--updated]
                                                  [--workspace-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.

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

--chat-model-deployment-name --name -n

The name of the ChatModelDeployment.

Property	Value
Parameter group:	Resource Id Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--workspace-name

The name of the Workspace.

Property	Value
Parameter group:	Resource Id 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.

--verbose

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

Property	Value
Default value:	False

Feedback

Was this page helpful?