az discovery workspace

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 command. Learn more about extensions.

Manage workspaces, projects, and chat model deployments.

Commands

Name	Description	Type	Status
az discovery workspace chat-model-deployment	Manage Chat Model Deployment.	Extension	GA
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 create	Create a Workspace.	Extension	GA
az discovery workspace delete	Delete a Workspace.	Extension	GA
az discovery workspace list	List Workspace resources by subscription ID.	Extension	GA
az discovery workspace private-endpoint-connection	Manage Private Endpoint Connection.	Extension	GA
az discovery workspace private-endpoint-connection create	Create the specified private endpoint connection.	Extension	GA
az discovery workspace private-endpoint-connection delete	Delete the specified private endpoint connection.	Extension	GA
az discovery workspace private-endpoint-connection list	List all private endpoint connections for a workspace.	Extension	GA
az discovery workspace private-endpoint-connection show	Get the specified private endpoint connection associated with the workspace.	Extension	GA
az discovery workspace private-endpoint-connection update	Update the specified private endpoint connection.	Extension	GA
az discovery workspace private-endpoint-connection wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az discovery workspace private-link-resource	Manage Private Link Resource.	Extension	GA
az discovery workspace private-link-resource list	List all private link resources for the workspace.	Extension	GA
az discovery workspace private-link-resource show	Get the specified private link resource for the workspace.	Extension	GA
az discovery workspace project	Manage Project.	Extension	GA
az discovery workspace project create	Create a Project.	Extension	GA
az discovery workspace project delete	Delete a Project.	Extension	GA
az discovery workspace project list	List Project resources by Workspace.	Extension	GA
az discovery workspace project show	Get a Project.	Extension	GA
az discovery workspace project update	Update a Project.	Extension	GA
az discovery workspace project wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az discovery workspace show	Get a Workspace.	Extension	GA
az discovery workspace update	Update a Workspace.	Extension	GA
az discovery workspace wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az discovery workspace create

Create a Workspace.

az discovery workspace create --name --workspace-name
                              --resource-group
                              [--acquire-policy-token]
                              [--agent-subnet-id]
                              [--change-reference]
                              [--customer-managed-keys {Disabled, Enabled}]
                              [--key-vault-properties]
                              [--la-cluster-id --log-analytics-cluster-id]
                              [--location]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--pe-subnet-id --private-endpoint-subnet-id]
                              [--public-network-access {Disabled, Enabled}]
                              [--supercomputer-ids]
                              [--tags]
                              [--workspace-identity]
                              [--workspace-subnet-id]

Examples

Create a workspace with dedicated subnets and a user-assigned identity.

az discovery workspace create --resource-group MyResourceGroup --name MyWorkspace --location eastus --workspace-identity id=/subscriptions/<subscription-id>/resourceGroups/MyIdentityRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyWorkspaceIdentity --pe-subnet-id /subscriptions/<subscription-id>/resourceGroups/MyNetworkRG/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/MyPrivateEndpointSubnet --agent-subnet-id /subscriptions/<subscription-id>/resourceGroups/MyNetworkRG/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/MyAgentSubnet --workspace-subnet-id /subscriptions/<subscription-id>/resourceGroups/MyNetworkRG/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/MyWorkspaceSubnet --tags SkipAssociateKeyVaultToNsp=True networkIsolation=true

Required Parameters

--name --workspace-name -n

The name of the Workspace.

--resource-group -g

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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--agent-subnet-id

Agent Subnet ID for agent resources.

Property	Value
Parameter group:	Properties Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--customer-managed-keys

Whether or not to use a customer managed key when encrypting data at rest.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--key-vault-properties

The key to use for encrypting data at rest when customer managed keys are enabled. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--la-cluster-id --log-analytics-cluster-id

The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.

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

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

--pe-subnet-id --private-endpoint-subnet-id

Private Endpoint Subnet ID for private endpoint connections.

Property	Value
Parameter group:	Properties Arguments

--public-network-access

Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--supercomputer-ids

List of linked SuperComputers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--workspace-identity

Identity IDs used for leveraging Workspace resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--workspace-subnet-id

Function Subnet ID for workspace resources.

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

Delete a Workspace.

az discovery workspace delete [--acquire-policy-token]
                              [--change-reference]
                              [--ids]
                              [--name --workspace-name]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--resource-group]
                              [--subscription]
                              [--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

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

--name --workspace-name -n

The name of the Workspace.

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

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

List Workspace resources by subscription ID.

az discovery workspace list [--max-items]
                            [--next-token]
                            [--resource-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.

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

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

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 show

Get a Workspace.

az discovery workspace show [--ids]
                            [--name --workspace-name]
                            [--resource-group]
                            [--subscription]

Optional Parameters

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --workspace-name -n

The name of the Workspace.

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

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 update

Update a Workspace.

az discovery workspace update [--acquire-policy-token]
                              [--add]
                              [--change-reference]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--key-vault-properties]
                              [--name --workspace-name]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--public-network-access {Disabled, Enabled}]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--subscription]
                              [--supercomputer-ids]
                              [--tags]

Examples

Disable public network access for a workspace.

az discovery workspace update --resource-group MyResourceGroup --name MyWorkspace --public-network-access Disabled

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

--change-reference

The related change reference ID for this resource operation.

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

--key-vault-properties

The key to use for encrypting data at rest when customer managed keys are enabled. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--name --workspace-name -n

The name of the Workspace.

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

--public-network-access

Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

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

--supercomputer-ids

List of linked SuperComputers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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.

--verbose

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

Property	Value
Default value:	False

az discovery workspace wait

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

az discovery workspace wait [--acquire-policy-token]
                            [--change-reference]
                            [--created]
                            [--custom]
                            [--deleted]
                            [--exists]
                            [--ids]
                            [--interval]
                            [--name --workspace-name]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

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

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

--name --workspace-name -n

The name of the Workspace.

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

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

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?