Delen via

az desktopvirtualization hostpool

  • Referentie

Notitie

Deze verwijzing maakt deel uit van de bureaubladvirtualisatie-extensie voor de Azure CLI (versie 2.55.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az desktopvirtualization hostpool-opdracht uitvoert. Meer informatie over extensies.

Beheer de hostgroep voor bureaubladvirtualisatie.

Opdracht

Name Description Type Status
az desktopvirtualization hostpool create

Maak een hostgroep.

 Toestel GA
az desktopvirtualization hostpool delete

Een hostgroep verwijderen.

 Toestel GA
az desktopvirtualization hostpool list

Geef hostgroepen weer.

 Toestel GA
az desktopvirtualization hostpool retrieve-registration-token

Registratietoken van de hostgroep.

 Toestel GA
az desktopvirtualization hostpool show

Een hostgroep weergeven.

 Toestel GA
az desktopvirtualization hostpool update

Een hostgroep bijwerken.

 Toestel GA

az desktopvirtualization hostpool create

Maak een hostgroep.

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]

Voorbeelden

Hostgroep maken

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

Vereiste parameters

--host-pool-type

Type hostgroep voor desktop.

geaccepteerde waarden: BYODesktop, Personal, Pooled
--load-balancer-type

Het type load balancer.

geaccepteerde waarden: BreadthFirst, DepthFirst, Persistent
--name -n

De naam van de hostgroep binnen de opgegeven resourcegroep.

--preferred-app-group-type -t

Het type voorkeurstoepassingsgroep, standaard ingesteld op bureaubladtoepassingsgroep.

geaccepteerde waarden: Desktop, None, RailApplications
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

--custom-rdp-property

Aangepaste rdp-eigenschap van hostgroep.

--description

Beschrijving van HostPool.

--friendly-name

Beschrijvende naam van HostPool.

--location -l

De geografische locatie waar de resource zich bevindt.

--max-session-limit

De maximale sessielimiet van HostPool.

--personal-desktop-assignment-type

Type PersonalDesktopAssignment voor HostPool.

geaccepteerde waarden: Automatic, Direct
--registration-info

De registratiegegevens van HostPool. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--ring

Het ringnummer van HostPool.

--sso-client-id

ClientId voor de geregistreerde Relying Party die wordt gebruikt voor het uitgeven van WVD SSO-certificaten.

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

Pad naar Azure KeyVault waarmee het geheim wordt opgeslagen dat wordt gebruikt voor communicatie met ADFS.

--sso-secret-type

Het type eenmalige aanmelding bij Secret Type.

geaccepteerde waarden: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL naar de ADFS-server van de klant voor het ondertekenen van WVD SSO-certificaten.

--start-vm-on-connect

De vlag voor het in-/uitschakelen van StartVMOn Verbinding maken functie.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--tags

Resourcetags. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--validation-environment

Is validatieomgeving.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

VM-sjabloon voor sessionhosts-configuratie in hostpool.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az desktopvirtualization hostpool delete

Een hostgroep verwijderen.

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

Voorbeelden

Hostgroep verwijderen

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

Optionele parameters

--force

Forceer vlag om sessionHost te verwijderen.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--name -n

De naam van de hostgroep binnen de opgegeven resourcegroep.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--yes -y

Niet vragen om bevestiging.

standaardwaarde: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az desktopvirtualization hostpool list

Geef hostgroepen weer.

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

Voorbeelden

Hostgroep vermelden

az desktopvirtualization hostpool list -g rg

Optionele parameters

--max-items

Totaal aantal items dat moet worden geretourneerd in de uitvoer van de opdracht. Als het totale aantal beschikbare items groter is dan de opgegeven waarde, wordt een token opgegeven in de uitvoer van de opdracht. Als u paginering wilt hervatten, geeft u de tokenwaarde op in --next-token het argument van een volgende opdracht.

--next-token

Token om op te geven waar paginering moet worden gestart. Dit is de tokenwaarde van een eerder afgekapt antwoord.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az desktopvirtualization hostpool retrieve-registration-token

Registratietoken van de hostgroep.

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

Voorbeelden

Registratietoken van de hostgroep.

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

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--name -n

De naam van de hostgroep binnen de opgegeven resourcegroep.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az desktopvirtualization hostpool show

Een hostgroep weergeven.

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

Voorbeelden

Hostgroep weergeven

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

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--name -n

De naam van de hostgroep binnen de opgegeven resourcegroep.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az desktopvirtualization hostpool update

Een hostgroep bijwerken.

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]

Voorbeelden

Hostgroep bijwerken

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

Optionele parameters

--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string of JSON string>.

--custom-rdp-property

Aangepaste rdp-eigenschap van hostgroep.

--description

Beschrijving van HostPool.

--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--friendly-name

Beschrijvende naam van HostPool.

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--load-balancer-type

Het type load balancer.

geaccepteerde waarden: BreadthFirst, DepthFirst, Persistent
--max-session-limit

De maximale sessielimiet van HostPool.

--name -n

De naam van de hostgroep binnen de opgegeven resourcegroep.

--personal-desktop-assignment-type

Type PersonalDesktopAssignment voor HostPool.

geaccepteerde waarden: Automatic, Direct
--preferred-app-group-type -t

Het type voorkeurstoepassingsgroep, standaard ingesteld op bureaubladtoepassingsgroep.

geaccepteerde waarden: Desktop, None, RailApplications
--registration-info

De registratiegegevens van HostPool. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list OR --remove propertyToRemove.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--ring

Het ringnummer van HostPool.

--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=.

--sso-client-id

ClientId voor de geregistreerde Relying Party die wordt gebruikt voor het uitgeven van WVD SSO-certificaten.

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

Pad naar Azure KeyVault waarmee het geheim wordt opgeslagen dat wordt gebruikt voor communicatie met ADFS.

--sso-secret-type

Het type eenmalige aanmelding bij Secret Type.

geaccepteerde waarden: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL naar de ADFS-server van de klant voor het ondertekenen van WVD SSO-certificaten.

--start-vm-on-connect

De vlag voor het in-/uitschakelen van StartVMOn Verbinding maken functie.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--tags

Resourcetags. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--validation-environment

Is validatieomgeving.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

VM-sjabloon voor sessionhosts-configuratie in hostpool.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.