Condividi tramite

az desktopvirtualization hostpool

  • Riferimento

Nota

Questo riferimento fa parte dell'estensione desktopvirtualization per l'interfaccia della riga di comando di Azure (versione 2.55.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az desktopvirtualization hostpool . Altre informazioni sulle estensioni.

Gestire il pool di host di virtualizzazione desktop.

Comandi

Nome Descrizione Tipo Stato
az desktopvirtualization hostpool create

Creare un pool di host.

 Estensione Disponibilità generale
az desktopvirtualization hostpool delete

Eliminare un pool di host.

 Estensione Disponibilità generale
az desktopvirtualization hostpool list

Elencare i pool di host.

 Estensione Disponibilità generale
az desktopvirtualization hostpool retrieve-registration-token

Token di registrazione del pool di host.

 Estensione Disponibilità generale
az desktopvirtualization hostpool show

Visualizzare un pool di host.

 Estensione Disponibilità generale
az desktopvirtualization hostpool update

Aggiornare un pool di host.

 Estensione Disponibilità generale

az desktopvirtualization hostpool create

Creare un pool di host.

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]

Esempio

Creare un pool di host

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

Parametri necessari

--host-pool-type

Tipo di pool di host per desktop.

valori accettati: BYODesktop, Personal, Pooled
--load-balancer-type

Tipo del servizio di bilanciamento del carico.

valori accettati: BreadthFirst, DepthFirst, Persistent
--name -n

Nome del pool di host all'interno del gruppo di risorse specificato.

--preferred-app-group-type -t

Tipo di gruppo di applicazioni preferito, impostazione predefinita per il gruppo di applicazioni desktop.

valori accettati: Desktop, None, RailApplications
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri facoltativi

--custom-rdp-property

Proprietà rdp personalizzata del pool di host.

--description

Descrizione di HostPool.

--friendly-name

Nome descrittivo di HostPool.

--location -l

Posizione geografica in cui risiede la risorsa.

--max-session-limit

Limite massimo di sessioni di HostPool.

--personal-desktop-assignment-type

Tipo PersonalDesktopAssignment per HostPool.

valori accettati: Automatic, Direct
--registration-info

Informazioni di registrazione di HostPool. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

--ring

Numero di anello di HostPool.

--sso-client-id

ClientId per la relying party registrata usata per rilasciare certificati SSO WVD.

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

Percorso di Azure KeyVault che archivia il segreto usato per la comunicazione con ADFS.

--sso-secret-type

Tipo di single sign-on Secret Type.

valori accettati: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL del server ADFS del cliente per la firma dei certificati SSO WVD.

--start-vm-on-connect

Flag per attivare/disattivare la funzionalità StartVMOn Connessione.

valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--tags

Tag di risorsa. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

--validation-environment

Ambiente di convalida.

valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Modello di macchina virtuale per la configurazione di sessionhosts all'interno del pool di host.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az desktopvirtualization hostpool delete

Eliminare un pool di host.

az desktopvirtualization hostpool delete [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

Esempio

Eliminare il pool di host

az desktopvirtualization hostpool delete -g rg -n hostpool-name

Parametri facoltativi

--force

Forzare il flag per eliminare sessionHost.

valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--name -n

Nome del pool di host all'interno del gruppo di risorse specificato.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--yes -y

Indica che non è richiesta la conferma.

valore predefinito: False
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az desktopvirtualization hostpool list

Elencare i pool di host.

az desktopvirtualization hostpool list [--max-items]
                                       [--next-token]
                                       [--resource-group]

Esempio

Elencare il pool di host

az desktopvirtualization hostpool list -g rg

Parametri facoltativi

--max-items

Numero totale di elementi da restituire nell'output del comando. Se il numero totale di elementi disponibili è maggiore del valore specificato, nell'output del comando viene fornito un token. Per riprendere la paginazione, specificare il valore del token nell'argomento --next-token di un comando successivo.

--next-token

Token per specificare dove iniziare la paginazione. Si tratta del valore del token di una risposta troncata in precedenza.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az desktopvirtualization hostpool retrieve-registration-token

Token di registrazione del pool di host.

az desktopvirtualization hostpool retrieve-registration-token [--ids]
                                                              [--name]
                                                              [--resource-group]
                                                              [--subscription]

Esempio

Token di registrazione del pool di host.

az desktopvirtualization hostpool retrieve-registration-token -n hostpool-name -g rg

Parametri facoltativi

--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--name -n

Nome del pool di host all'interno del gruppo di risorse specificato.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az desktopvirtualization hostpool show

Visualizzare un pool di host.

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

Esempio

Mostra pool di host

az desktopvirtualization hostpool show -g rg -n hostpool-name

Parametri facoltativi

--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--name -n

Nome del pool di host all'interno del gruppo di risorse specificato.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az desktopvirtualization hostpool update

Aggiornare un pool di host.

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]

Esempio

Aggiornare il pool di host

az desktopvirtualization hostpool update -g rg -n hostpool-name --tags tag=test

Parametri facoltativi

--add

Aggiungere un oggetto a un elenco di oggetti specificando un percorso e coppie chiave-valore. Esempio: --add property.listProperty <key=value, stringa o stringa> JSON.

--custom-rdp-property

Proprietà rdp personalizzata del pool di host.

--description

Descrizione di HostPool.

--force-string

Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.

valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--friendly-name

Nome descrittivo di HostPool.

--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--load-balancer-type

Tipo del servizio di bilanciamento del carico.

valori accettati: BreadthFirst, DepthFirst, Persistent
--max-session-limit

Limite massimo di sessioni di HostPool.

--name -n

Nome del pool di host all'interno del gruppo di risorse specificato.

--personal-desktop-assignment-type

Tipo PersonalDesktopAssignment per HostPool.

valori accettati: Automatic, Direct
--preferred-app-group-type -t

Tipo di gruppo di applicazioni preferito, impostazione predefinita per il gruppo di applicazioni desktop.

valori accettati: Desktop, None, RailApplications
--registration-info

Informazioni di registrazione di HostPool. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

--remove

Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--ring

Numero di anello di HostPool.

--set

Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=.

--sso-client-id

ClientId per la relying party registrata usata per rilasciare certificati SSO WVD.

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

Percorso di Azure KeyVault che archivia il segreto usato per la comunicazione con ADFS.

--sso-secret-type

Tipo di single sign-on Secret Type.

valori accettati: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL del server ADFS del cliente per la firma dei certificati SSO WVD.

--start-vm-on-connect

Flag per attivare/disattivare la funzionalità StartVMOn Connessione.

valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--tags

Tag di risorsa. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

--validation-environment

Ambiente di convalida.

valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Modello di macchina virtuale per la configurazione di sessionhosts all'interno del pool di host.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.