Dela via

az desktopvirtualization hostpool

  • Referens

Anmärkning

Den här referensen är en del av desktopvirtualization-tillägget för Azure CLI (version 2.55.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az desktopvirtualization hostpool kommando. Läs mer om tillägg.

Hantera värdpoolen för skrivbordsvirtualisering.

Kommandon

Name Description Typ Status
az desktopvirtualization hostpool create

Skapa en värdpool.

 Förlängning GA
az desktopvirtualization hostpool delete

Ta bort en värdpool.

 Förlängning GA
az desktopvirtualization hostpool list

Lista värdpooler.

 Förlängning GA
az desktopvirtualization hostpool retrieve-registration-token

Registreringstoken för värdpoolen.

 Förlängning GA
az desktopvirtualization hostpool show

Visa en värdpool.

 Förlängning GA
az desktopvirtualization hostpool update

Uppdatera en värdpool.

 Förlängning GA

az desktopvirtualization hostpool create

Skapa en värdpool.

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]

Exempel

Skapa värdpool

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

Obligatoriska parametrar

--host-pool-type

Värdpoolstyp för skrivbordet.

Godkända värden: BYODesktop, Personal, Pooled
--load-balancer-type

Typen av lastbalanserare.

Godkända värden: BreadthFirst, DepthFirst, Persistent
--name -n

Namnet på värdpoolen i den angivna resursgruppen.

--preferred-app-group-type -t

Typ av önskad programgruppstyp, som standard för skrivbordsprogramgrupp.

Godkända värden: Desktop, None, RailApplications
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Valfria parametrar

--custom-rdp-property

Anpassad rdp-egenskap för värdpoolen.

--description

Beskrivning av HostPool.

--friendly-name

Eget namn på HostPool.

--location -l

Den geo-plats där resursen finns.

--max-session-limit

Maximal sessionsgräns för HostPool.

--personal-desktop-assignment-type

PersonalDesktopAssignment-typ för HostPool.

Godkända värden: Automatic, Direct
--registration-info

Registreringsinformationen för HostPool. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--ring

Ringnumret för HostPool.

--sso-client-id

ClientId för den registrerade förlitande parten som används för att utfärda WVD SSO-certifikat.

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

Sökväg till Azure KeyVault som lagrar hemligheten som används för kommunikation till ADFS.

--sso-secret-type

Typen av enkel inloggning på hemlig typ.

Godkända värden: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL till kundens ADFS-server för signering av WVD SSO-certifikat.

--start-vm-on-connect

Flaggan för att aktivera/inaktivera funktionen StartVMOnConnect.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--tags

Resurstaggar. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--validation-environment

Är valideringsmiljö.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

VM-mall för konfiguration av sessionsvärdar i värdpoolen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az desktopvirtualization hostpool delete

Ta bort en värdpool.

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

Exempel

Ta bort värdpool

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

Valfria parametrar

--force

Tvinga flaggan att ta bort sessionHost.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name -n

Namnet på värdpoolen i den angivna resursgruppen.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--yes -y

Fråga inte efter bekräftelse.

Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az desktopvirtualization hostpool list

Lista värdpooler.

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

Exempel

Lista värdpool

az desktopvirtualization hostpool list -g rg

Valfria parametrar

--max-items

Totalt antal objekt som ska returneras i kommandots utdata. Om det totala antalet tillgängliga objekt är mer än det angivna värdet anges en token i kommandots utdata. Om du vill återuppta sidnumreringen anger du tokenvärdet i --next-token argument för ett efterföljande kommando.

--next-token

Token för att ange var sidnumrering ska börja. Detta är tokenvärdet från ett tidigare trunkerat svar.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az desktopvirtualization hostpool retrieve-registration-token

Registreringstoken för värdpoolen.

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

Exempel

Registreringstoken för värdpoolen.

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

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name -n

Namnet på värdpoolen i den angivna resursgruppen.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az desktopvirtualization hostpool show

Visa en värdpool.

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

Exempel

Visa värdpool

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

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name -n

Namnet på värdpoolen i den angivna resursgruppen.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az desktopvirtualization hostpool update

Uppdatera en värdpool.

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]

Exempel

Uppdatera värdpool

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

Valfria parametrar

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

--custom-rdp-property

Anpassad rdp-egenskap för värdpoolen.

--description

Beskrivning av HostPool.

--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--friendly-name

Eget namn på HostPool.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--load-balancer-type

Typen av lastbalanserare.

Godkända värden: BreadthFirst, DepthFirst, Persistent
--max-session-limit

Maximal sessionsgräns för HostPool.

--name -n

Namnet på värdpoolen i den angivna resursgruppen.

--personal-desktop-assignment-type

PersonalDesktopAssignment-typ för HostPool.

Godkända värden: Automatic, Direct
--preferred-app-group-type -t

Typ av önskad programgruppstyp, som standard för skrivbordsprogramgrupp.

Godkända värden: Desktop, None, RailApplications
--registration-info

Registreringsinformationen för HostPool. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--ring

Ringnumret för HostPool.

--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

--sso-client-id

ClientId för den registrerade förlitande parten som används för att utfärda WVD SSO-certifikat.

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

Sökväg till Azure KeyVault som lagrar hemligheten som används för kommunikation till ADFS.

--sso-secret-type

Typen av enkel inloggning på hemlig typ.

Godkända värden: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL till kundens ADFS-server för signering av WVD SSO-certifikat.

--start-vm-on-connect

Flaggan för att aktivera/inaktivera funktionen StartVMOnConnect.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--tags

Resurstaggar. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--validation-environment

Är valideringsmiljö.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

VM-mall för konfiguration av sessionsvärdar i värdpoolen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.