az desktopvirtualization applicationgroup

  • Reference

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

Desktopvirtualization applicationgroup.

Commands

Name Description Type Status
az desktopvirtualization applicationgroup create

Create an applicationGroup.

 Extension GA
az desktopvirtualization applicationgroup delete

Remove an applicationGroup.

 Extension GA
az desktopvirtualization applicationgroup list

List applicationGroups in subscription.

 Extension GA
az desktopvirtualization applicationgroup show

Get an application group.

 Extension GA
az desktopvirtualization applicationgroup update

Update an applicationGroup.

 Extension GA

az desktopvirtualization applicationgroup create

Create an applicationGroup.

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

Examples

ApplicationGroup_Create

az desktopvirtualization applicationgroup create --location "centralus" --description "des1" --application-group-type "RemoteApp" --friendly-name "friendly" --host-pool-arm-path "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/MyResourceGroup/providers/Microsoft.DesktopVirtualization/hostPools/MyHostPool" --tags tag1="value1" tag2="value2" --name "MyApplicationGroup" --resource-group "MyResourceGroup"

Required Parameters

--application-group-type

Resource Type of ApplicationGroup.

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

HostPool arm path of ApplicationGroup.

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

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

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.

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

Remove an applicationGroup.

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

Examples

ApplicationGroup_Delete

az desktopvirtualization applicationgroup delete --name "MyApplicationGroup" --resource-group "MyResourceGroup"

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.

--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 applicationGroups in subscription.

az desktopvirtualization applicationgroup list [--filter]
                                               [--resource-group]

Examples

ApplicationGroup_ListByResourceGroup

az desktopvirtualization applicationgroup list --filter "applicationGroupType eq 'RailApplication'" --resource-group "MyResourceGroup"

Optional Parameters

--filter

OData filter expression. Valid properties for filtering are applicationGroupType.

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

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

Get an application group.

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

Examples

ApplicationGroup_Get

az desktopvirtualization applicationgroup show --name "MyApplicationGroup" --resource-group "MyResourceGroup"

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.

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

az desktopvirtualization applicationgroup update [--description]
                                                 [--friendly-name]
                                                 [--ids]
                                                 [--name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--tags]

Examples

ApplicationGroups_Update

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

Optional Parameters

--description

Description of ApplicationGroup.

--friendly-name

Friendly name of ApplicationGroup.

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

--tags

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

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.

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