az desktopvirtualization workspace

Note

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

Desktopvirtualization workspace.

Commands

az desktopvirtualization workspace create

Create a workspace.

az desktopvirtualization workspace delete

Remove a workspace.

az desktopvirtualization workspace list

List workspaces in subscription.

az desktopvirtualization workspace show

Get a workspace.

az desktopvirtualization workspace update

Update a workspace.

az desktopvirtualization workspace create

Create a workspace.

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

Examples

Workspace_Create

az desktopvirtualization workspace create --resource-group "MyResourceGroup" --location "centralus" --description "des1" --friendly-name "friendly" --tags tag1="value1" tag2="value2" --name "MyWorkspace"

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 applicationGroup resource Ids.

--description

Description of Workspace.

--friendly-name

Friendly name of Workspace.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az desktopvirtualization workspace delete

Remove a workspace.

az desktopvirtualization workspace delete --name
                                          --resource-group

Examples

Workspace_Delete

az desktopvirtualization workspace delete --resource-group "MyResourceGroup" --name "MyWorkspace"

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

az desktopvirtualization workspace list

List workspaces in subscription.

az desktopvirtualization workspace list [--resource-group]

Examples

Workspace_ListByResourceGroup

az desktopvirtualization workspace list --resource-group "MyResourceGroup"

Optional Parameters

--resource-group -g

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

az desktopvirtualization workspace show

Get a workspace.

az desktopvirtualization workspace show --name
                                        --resource-group

Examples

Workspace_Get

az desktopvirtualization workspace show --resource-group "MyResourceGroup" --name "MyWorkspace"

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

az desktopvirtualization workspace update

Update a workspace.

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

Examples

Workspace_Update

az desktopvirtualization workspace update --resource-group "MyResourceGroup" --description "des1" --friendly-name "friendly" --tags tag1="value1" tag2="value2" --name "MyWorkspace"

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

--description

Description of Workspace.

--friendly-name

Friendly name of Workspace.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.