az desktopvirtualization hostpool

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

Desktopvirtualization hostpool.

Commands

az desktopvirtualization hostpool create

Create a host pool.

az desktopvirtualization hostpool delete

Remove a host pool.

az desktopvirtualization hostpool list

List hostPools in subscription.

az desktopvirtualization hostpool retrieve-registration-token

Registration token of the host pool.

az desktopvirtualization hostpool show

Get a host pool.

az desktopvirtualization hostpool update

Update a host pool.

az desktopvirtualization hostpool create

Create a host pool.

az desktopvirtualization hostpool create --host-pool-type {BYODesktop, Personal, Pooled}
                                         --load-balancer-type {BreadthFirst, DepthFirst, Persistent}
                                         --name
                                         --preferred-app-group-type {Desktop, None, RailApplications}
                                         --resource-group
                                         [--custom-rdp-property]
                                         [--description]
                                         [--friendly-name]
                                         [--location]
                                         [--max-session-limit]
                                         [--personal-desktop-assignment-type {Automatic, Direct}]
                                         [--registration-info]
                                         [--ring]
                                         [--sso-client-id]
                                         [--sso-client-secret-key-vault-path]
                                         [--sso-secret-type {Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault}]
                                         [--ssoadfs-authority]
                                         [--start-vm-on-connect {false, true}]
                                         [--tags]
                                         [--validation-environment {false, true}]
                                         [--vm-template]

Examples

HostPool_Create

az desktopvirtualization hostpool create --location "centralus" --description "des1" --friendly-name "friendly" --host-pool-type "Pooled" --load-balancer-type "BreadthFirst" --max-session-limit 999999 --personal-desktop-assignment-type "Automatic" --preferred-app-group-type "Desktop" --registration-info expiration-time="2020-10-01T14:01:54.9571247Z" registration-token-operation="Update" --sso-client-id "client" --sso-client-secret-key-vault-path "https://keyvault/secret" --sso-secret-type "SharedKey" --ssoadfs-authority "https://adfs" --start-vm-on-connect false --vm-template "{json:json}" --tags tag1="value1" tag2="value2" --name "MyHostPool" --resource-group "MyResourceGroup"

Required Parameters

--host-pool-type

HostPool type for desktop.

accepted values: BYODesktop, Personal, Pooled
--load-balancer-type

The type of the load balancer.

accepted values: BreadthFirst, DepthFirst, Persistent
--name -n

The name of the host pool within the specified resource group.

--preferred-app-group-type -t

The type of preferred application group type, default to Desktop Application Group.

accepted values: Desktop, None, RailApplications
--resource-group -g

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

Optional Parameters

--custom-rdp-property

Custom rdp property of HostPool.

--description

Description of HostPool.

--friendly-name

Friendly name of HostPool.

--location -l

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

--max-session-limit

The max session limit of HostPool.

--personal-desktop-assignment-type

PersonalDesktopAssignment type for HostPool.

accepted values: Automatic, Direct
--registration-info

The registration info of HostPool.

--ring

The ring number of HostPool.

--sso-client-id

ClientId for the registered Relying Party used to issue WVD SSO certificates.

--sso-client-secret-key-vault-path -p

Path to Azure KeyVault storing the secret used for communication to ADFS.

--sso-secret-type

The type of single sign on Secret Type.

accepted values: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL to customer ADFS server for signing WVD SSO certificates.

--start-vm-on-connect

The flag to turn on/off StartVMOnConnect feature.

accepted values: false, true
--tags

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

--validation-environment

Is validation environment.

accepted values: false, true
--vm-template

VM template for sessionhosts configuration within hostpool.

az desktopvirtualization hostpool delete

Remove a host pool.

az desktopvirtualization hostpool delete --name
                                         --resource-group
                                         [--force {false, true}]

Examples

HostPool_Delete

az desktopvirtualization hostpool delete --force true --name "MyHostPool" --resource-group "MyResourceGroup"

Required Parameters

--name -n

The name of the host pool within the specified resource group.

--resource-group -g

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

Optional Parameters

--force

Force flag to delete sessionHost.

accepted values: false, true

az desktopvirtualization hostpool list

List hostPools in subscription.

az desktopvirtualization hostpool list [--resource-group]

Examples

HostPool_ListByResourceGroup

az desktopvirtualization hostpool 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 hostpool retrieve-registration-token

Registration token of the host pool.

az desktopvirtualization hostpool retrieve-registration-token --name
                                                              --resource-group

Examples

HostPools_RetrieveRegistrationToken_Post

az desktopvirtualization hostpool retrieve-registration-token --name "MyHostPool" --resource-group "MyResourceGroup"

Required Parameters

--name -n

The name of the host pool within the specified resource group.

--resource-group -g

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

az desktopvirtualization hostpool show

Get a host pool.

az desktopvirtualization hostpool show --name
                                       --resource-group

Examples

HostPool_Get

az desktopvirtualization hostpool show --name "MyHostPool" --resource-group "MyResourceGroup"

Required Parameters

--name -n

The name of the host pool within the specified resource group.

--resource-group -g

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

az desktopvirtualization hostpool update

Update a host pool.

az desktopvirtualization hostpool update --name
                                         --resource-group
                                         [--custom-rdp-property]
                                         [--description]
                                         [--friendly-name]
                                         [--load-balancer-type {BreadthFirst, DepthFirst, Persistent}]
                                         [--max-session-limit]
                                         [--personal-desktop-assignment-type {Automatic, Direct}]
                                         [--preferred-app-group-type {Desktop, None, RailApplications}]
                                         [--registration-info]
                                         [--ring]
                                         [--sso-client-id]
                                         [--sso-client-secret-key-vault-path]
                                         [--sso-secret-type {Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault}]
                                         [--ssoadfs-authority]
                                         [--start-vm-on-connect {false, true}]
                                         [--tags]
                                         [--validation-environment {false, true}]
                                         [--vm-template]

Examples

HostPool_Update

az desktopvirtualization hostpool update --description "des1" --friendly-name "friendly" --load-balancer-type "BreadthFirst" --max-session-limit 999999 --personal-desktop-assignment-type "Automatic" --registration-info expiration-time="2020-10-01T15:01:54.9571247Z" registration-token-operation="Update" --sso-client-id "client" --sso-client-secret-key-vault-path "https://keyvault/secret" --sso-secret-type "SharedKey" --ssoadfs-authority "https://adfs" --start-vm-on-connect false --vm-template "{json:json}" --tags tag1="value1" tag2="value2" --name "MyHostPool" --resource-group "MyResourceGroup"

Required Parameters

--name -n

The name of the host pool within the specified resource group.

--resource-group -g

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

Optional Parameters

--custom-rdp-property

Custom rdp property of HostPool.

--description

Description of HostPool.

--friendly-name

Friendly name of HostPool.

--load-balancer-type

The type of the load balancer.

accepted values: BreadthFirst, DepthFirst, Persistent
--max-session-limit

The max session limit of HostPool.

--personal-desktop-assignment-type

PersonalDesktopAssignment type for HostPool.

accepted values: Automatic, Direct
--preferred-app-group-type -t

The type of preferred application group type, default to Desktop Application Group.

accepted values: Desktop, None, RailApplications
--registration-info

The registration info of HostPool.

--ring

The ring number of HostPool.

--sso-client-id

ClientId for the registered Relying Party used to issue WVD SSO certificates.

--sso-client-secret-key-vault-path -p

Path to Azure KeyVault storing the secret used for communication to ADFS.

--sso-secret-type

The type of single sign on Secret Type.

accepted values: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL to customer ADFS server for signing WVD SSO certificates.

--start-vm-on-connect

The flag to turn on/off StartVMOnConnect feature.

accepted values: false, true
--tags

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

--validation-environment

Is validation environment.

accepted values: false, true
--vm-template

VM template for sessionhosts configuration within hostpool.