az desktopvirtualization hostpool
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 hostpool command. Learn more about extensions.
Manage desktop virtualization host pool.
Commands
Name | Description | Type | Status |
---|---|---|---|
az desktopvirtualization hostpool create |
Create a host pool. |
Extension | GA |
az desktopvirtualization hostpool delete |
Delete a host pool. |
Extension | GA |
az desktopvirtualization hostpool list |
List host pools. |
Extension | GA |
az desktopvirtualization hostpool retrieve-registration-token |
Registration token of the host pool. |
Extension | GA |
az desktopvirtualization hostpool show |
Show 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 {0, 1, f, false, n, no, t, true, y, yes}]
[--tags]
[--validation-environment {0, 1, f, false, n, no, t, true, y, yes}]
[--vm-template]
Examples
Create host pool
az desktopvirtualization hostpool create -g rg -n hostpool-name --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="yyyy-mm-ddT08:38:08.189Z" registration-token-operation=Update --sso-client-id client --sso-client-secret-key-vault-path https://keyvault/secret --sso-secret-type SharedKey --start-vm-on-connect false
Required Parameters
Host pool type for desktop.
Property | Value |
---|---|
Accepted values: | BYODesktop, Personal, Pooled |
The type of the load balancer.
Property | Value |
---|---|
Accepted values: | BreadthFirst, DepthFirst, Persistent |
The name of the host pool within the specified resource group.
The type of preferred application group type, default to desktop application group.
Property | Value |
---|---|
Accepted values: | Desktop, None, RailApplications |
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.
Custom rdp property of host pool.
Description of HostPool.
Friendly name of HostPool.
The geo-location where the resource lives.
The max session limit of HostPool.
PersonalDesktopAssignment type for HostPool.
Property | Value |
---|---|
Accepted values: | Automatic, Direct |
The registration info of HostPool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
Property | Value |
---|---|
Accepted values: | Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault |
URL to customer ADFS server for signing WVD SSO certificates.
The flag to turn on/off StartVMOnConnect feature.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Is validation environment.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
VM template for sessionhosts configuration within hostpool.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az desktopvirtualization hostpool delete
Delete a host pool.
az desktopvirtualization hostpool delete [--force {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete host pool
az desktopvirtualization hostpool delete -g rg -n hostpool-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.
Force flag to delete sessionHost.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
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 |
The name of the host pool within the specified resource group.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az desktopvirtualization hostpool list
List host pools.
az desktopvirtualization hostpool list [--max-items]
[--next-token]
[--resource-group]
Examples
List host pool
az desktopvirtualization hostpool 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.
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 |
Token to specify where to start paginating. This is the token value from a previously truncated response.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
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.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az desktopvirtualization hostpool retrieve-registration-token
Registration token of the host pool.
az desktopvirtualization hostpool retrieve-registration-token [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Registration token of the host pool.
az desktopvirtualization hostpool retrieve-registration-token -n hostpool-name -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.
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 |
The name of the host pool within the specified resource group.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az desktopvirtualization hostpool show
Show a host pool.
az desktopvirtualization hostpool show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Show host pool
az desktopvirtualization hostpool show -g rg -n hostpool-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.
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 |
The name of the host pool within the specified resource group.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az desktopvirtualization hostpool update
Update a host pool.
az desktopvirtualization hostpool update [--add]
[--custom-rdp-property]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--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]
[--remove]
[--resource-group]
[--ring]
[--set]
[--sso-client-id]
[--sso-client-secret-key-vault-path]
[--sso-secret-type {Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault}]
[--ssoadfs-authority]
[--start-vm-on-connect {0, 1, f, false, n, no, t, true, y, yes}]
[--subscription]
[--tags]
[--validation-environment {0, 1, f, false, n, no, t, true, y, yes}]
[--vm-template]
Examples
Update host pool
az desktopvirtualization hostpool update -g rg -n hostpool-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 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 |
Custom rdp property of host pool.
Description of HostPool.
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 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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The type of the load balancer.
Property | Value |
---|---|
Accepted values: | BreadthFirst, DepthFirst, Persistent |
The max session limit of HostPool.
The name of the host pool within the specified resource group.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
PersonalDesktopAssignment type for HostPool.
Property | Value |
---|---|
Accepted values: | Automatic, Direct |
The type of preferred application group type, default to desktop application group.
Property | Value |
---|---|
Accepted values: | Desktop, None, RailApplications |
The registration info of HostPool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The ring number of HostPool.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
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.
Property | Value |
---|---|
Accepted values: | Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault |
URL to customer ADFS server for signing WVD SSO certificates.
The flag to turn on/off StartVMOnConnect feature.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
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 |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Is validation environment.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
VM template for sessionhosts configuration within hostpool.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |