Share via

az desktopvirtualization applicationgroup

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.

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

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

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

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

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

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

The name of the application group.

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

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

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

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

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

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

The name of the application group.

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

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

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

Resource type of application group.

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

Property Value
Parameter group: Generic Update Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the application group.

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

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