az desktopvirtualization applicationgroup

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

Manage desktop virtualization application group.

Commands

Name Description Type Status
az desktopvirtualization applicationgroup create

Create an application group.

 Extension GA
az desktopvirtualization applicationgroup delete

Delete an application group.

 Extension GA
az desktopvirtualization applicationgroup list

List application groups.

 Extension GA
az desktopvirtualization applicationgroup show

Show an application group.

 Extension GA
az desktopvirtualization applicationgroup update

Update an application group.

 Extension GA

az desktopvirtualization applicationgroup create

Create an application group.

az desktopvirtualization applicationgroup create --application-group-type {Desktop, RemoteApp}
                                                 --host-pool-arm-path
                                                 --name
                                                 --resource-group
                                                 [--description]
                                                 [--friendly-name]
                                                 [--location]
                                                 [--tags]

Examples

Create application group

az desktopvirtualization applicationgroup create -g rg -n app-group-name --host-pool-arm-path host-pool-id --application-group-type remoteapp

Required Parameters

--application-group-type

Resource type of application group.

accepted values: Desktop, RemoteApp
--host-pool-arm-path

Host pool arm path of application group.

--name -n

The name of the application group.

--resource-group -g

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

Optional Parameters

--description

Description of ApplicationGroup.

--friendly-name

Friendly name of application group.

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

Delete an application group.

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

Examples

Delete application group

az desktopvirtualization applicationgroup delete -g rg -n app-group-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 application group.

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

List application groups.

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

Examples

List application groups

az desktopvirtualization applicationgroup list -g rg

Optional Parameters

--filter

OData filter expression. Valid properties for filtering are applicationGroupType.

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

Show an application group.

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

Examples

Show application group

az desktopvirtualization applicationgroup show -g rg -n app-group-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 application group.

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

Update an application group.

az desktopvirtualization applicationgroup update [--add]
                                                 [--application-group-type {Desktop, RemoteApp}]
                                                 [--description]
                                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--friendly-name]
                                                 [--host-pool-arm-path]
                                                 [--ids]
                                                 [--name]
                                                 [--remove]
                                                 [--resource-group]
                                                 [--set]
                                                 [--subscription]
                                                 [--tags]

Examples

Update application group

az desktopvirtualization applicationgroup update -g rg -n app-group-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-type

Resource type of application group.

accepted values: Desktop, RemoteApp
--description

Description of ApplicationGroup.

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

--host-pool-arm-path

Host pool arm path of application group.

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

--remove

Remove a property or an element from a list. Example: --remove property.list 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=.

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