Share via

az desktopvirtualization workspace

  • Reference

Note

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

Manage desktop virtualization workspace.

Commands

Name Description Type Status
az desktopvirtualization workspace create

Create a workspace.

 Extension GA
az desktopvirtualization workspace delete

Delete a workspace.

 Extension GA
az desktopvirtualization workspace list

List workspaces.

 Extension GA
az desktopvirtualization workspace show

Show a workspace.

 Extension GA
az desktopvirtualization workspace update

Update a workspace.

 Extension GA

az desktopvirtualization workspace create

Create a workspace.

az desktopvirtualization workspace create --name
                                          --resource-group
                                          [--application-group-references]
                                          [--description]
                                          [--friendly-name]
                                          [--location]
                                          [--tags]

Examples

Create workspace

az desktopvirtualization workspace create -g rg -n workspace-name --friendly-name friendly

Required Parameters

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

--application-group-references

List of application group resource Ids. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--description

Description of Workspace.

--friendly-name

Friendly name of Workspace.

--location -l

The geo-location where the resource lives.

--tags

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

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 desktopvirtualization workspace delete

Delete a workspace.

az desktopvirtualization workspace delete [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]
                                          [--yes]

Examples

Delete workspace

az desktopvirtualization workspace delete -g rg -n workspace-name

Optional Parameters

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

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
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 desktopvirtualization workspace list

List workspaces.

az desktopvirtualization workspace list [--max-items]
                                        [--next-token]
                                        [--resource-group]

Examples

List workspaces

az desktopvirtualization workspace list -g rg

Optional Parameters

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

--next-token

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

--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 desktopvirtualization workspace show

Show a workspace.

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

Examples

Show workspace

az desktopvirtualization workspace show -g rg -n workspace-name

Optional Parameters

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

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

--subscription

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

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 desktopvirtualization workspace update

Update a workspace.

az desktopvirtualization workspace update [--add]
                                          [--application-group-references]
                                          [--description]
                                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--friendly-name]
                                          [--ids]
                                          [--name]
                                          [--remove]
                                          [--resource-group]
                                          [--set]
                                          [--subscription]
                                          [--tags]

Examples

Update workspace

az desktopvirtualization workspace update -g rg -n workspace-name --tags tag=test

Optional Parameters

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

--application-group-references

List of application group resource Ids. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--description

Description of Workspace.

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--friendly-name

Friendly name of Workspace.

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

--name -n

The name of the workspace.

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

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

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.