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
| Name | Description | Type | Status |
|---|---|---|---|
| az desktopvirtualization hostpool create |
Create a host pool. |
Extension | GA |
| az desktopvirtualization hostpool delete |
Remove a host pool. |
Extension | GA |
| az desktopvirtualization hostpool list |
List hostPools in subscription. |
Extension | GA |
| az desktopvirtualization hostpool retrieve-registration-token |
Registration token of the host pool. |
Extension | GA |
| az desktopvirtualization hostpool show |
Get a host pool. |
Extension | GA |
| az desktopvirtualization hostpool update |
Update a host pool. |
Extension | GA |
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
HostPool type for desktop.
Personal: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. BYODesktop: Users assign their own machines, load balancing logic remains the same as Personal. --personal-desktop-ssignment-type must be Direct.
The type of the load balancer.
The name of the host pool within the specified resource group.
The type of preferred application group type, default to Desktop Application Group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Custom rdp property of HostPool.
Description of HostPool.
Friendly name of HostPool.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
The max session limit of HostPool.
PersonalDesktopAssignment type for HostPool.
The registration info of HostPool.
Usage: --registration-info expiration-time=XX token=XX registration-token-operation=XX
expiration-time: Expiration time of registration token. token: The registration token base64 encoded string. registration-token-operation: The type of resetting the token.
The ring number of HostPool.
ClientId for the registered Relying Party used to issue WVD SSO certificates.
Path to Azure KeyVault storing the secret used for communication to ADFS.
The type of single sign on Secret Type.
URL to customer ADFS server for signing WVD SSO certificates.
The flag to turn on/off StartVMOnConnect feature.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Is validation environment.
VM template for sessionhosts configuration within hostpool.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az desktopvirtualization hostpool delete
Remove a host pool.
az desktopvirtualization hostpool delete [--force {false, true}]
[--ids]
[--name]
[--resource-group]
[--subscription]Examples
HostPool_Delete
az desktopvirtualization hostpool delete --force true --name "MyHostPool" --resource-group "MyResourceGroup"Optional Parameters
Force flag to delete sessionHost.
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.
The name of the host pool within the specified resource group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az desktopvirtualization hostpool retrieve-registration-token
Registration token of the host pool.
az desktopvirtualization hostpool retrieve-registration-token [--ids]
[--name]
[--resource-group]
[--subscription]Examples
HostPools_RetrieveRegistrationToken_Post
az desktopvirtualization hostpool retrieve-registration-token --name "MyHostPool" --resource-group "MyResourceGroup"Optional Parameters
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.
The name of the host pool within the specified resource group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az desktopvirtualization hostpool show
Get a host pool.
az desktopvirtualization hostpool show [--ids]
[--name]
[--resource-group]
[--subscription]Examples
HostPool_Get
az desktopvirtualization hostpool show --name "MyHostPool" --resource-group "MyResourceGroup"Optional Parameters
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.
The name of the host pool within the specified resource group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az desktopvirtualization hostpool update
Update a host pool.
az desktopvirtualization hostpool update [--custom-rdp-property]
[--description]
[--friendly-name]
[--ids]
[--load-balancer-type {BreadthFirst, DepthFirst, Persistent}]
[--max-session-limit]
[--name]
[--personal-desktop-assignment-type {Automatic, Direct}]
[--preferred-app-group-type {Desktop, None, RailApplications}]
[--registration-info]
[--resource-group]
[--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}]
[--subscription]
[--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"Optional Parameters
Custom rdp property of HostPool.
Description of HostPool.
Friendly name of HostPool.
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.
The type of the load balancer.
The max session limit of HostPool.
The name of the host pool within the specified resource group.
PersonalDesktopAssignment type for HostPool.
The type of preferred application group type, default to Desktop Application Group.
The registration info of HostPool.
Usage: --registration-info expiration-time=XX registration-token-operation=XX
expiration-time: Expiration time of registration token. registration-token-operation: The type of resetting the token.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The ring number of HostPool.
ClientId for the registered Relying Party used to issue WVD SSO certificates.
Path to Azure KeyVault storing the secret used for communication to ADFS.
The type of single sign on Secret Type.
URL to customer ADFS server for signing WVD SSO certificates.
The flag to turn on/off StartVMOnConnect feature.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Is validation environment.
VM template for sessionhosts configuration within hostpool.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Submit and view feedback for