az desktopvirtualization hostpool

Note

Diese Referenz ist Teil der Desktopvirtualisierungserweiterung für die Azure CLI (Version 2.55.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az desktopvirtualization hostpool Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Verwalten des Desktopvirtualisierungshostpools.

Befehle

Name	Beschreibung	Typ	Status
az desktopvirtualization hostpool create	Erstellen eines Hostpools.	Extension	GA
az desktopvirtualization hostpool delete	Löschen eines Hostpools.	Extension	GA
az desktopvirtualization hostpool list	Hostpools auflisten.	Extension	GA
az desktopvirtualization hostpool retrieve-registration-token	Registrierungstoken des Hostpools.	Extension	GA
az desktopvirtualization hostpool show	Anzeigen eines Hostpools.	Extension	GA
az desktopvirtualization hostpool update	Aktualisieren eines Hostpools.	Extension	GA

az desktopvirtualization hostpool create

Erstellen eines Hostpools.

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]

Beispiele

Erstellen eines Hostpools

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

Erforderliche Parameter

--host-pool-type

Hostpooltyp für Desktop.

Eigenschaft	Wert
Zulässige Werte:	BYODesktop, Personal, Pooled

--load-balancer-type

Der Typ des Lastenausgleichs.

Eigenschaft	Wert
Zulässige Werte:	BreadthFirst, DepthFirst, Persistent

--name -n

Der Name des Hostpools innerhalb der angegebenen Ressourcengruppe.

--preferred-app-group-type -t

Der Typ des bevorzugten Anwendungsgruppentyps, standardmäßig für die Desktopanwendungsgruppe.

Eigenschaft	Wert
Zulässige Werte:	Desktop, None, RailApplications

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--custom-rdp-property

Benutzerdefinierte rdp-Eigenschaft des Hostpools.

--description

Beschreibung des HostPools.

--friendly-name

Anzeigename von HostPool.

--location -l

Der geografische Standort, an dem sich die Ressource befindet.

--max-session-limit

Der maximale Sitzungsgrenzwert von HostPool.

--personal-desktop-assignment-type

PersonalDesktopAssignment-Typ für HostPool.

Eigenschaft	Wert
Zulässige Werte:	Automatic, Direct

--registration-info

Die Registrierungsinformationen von HostPool. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--ring

Die Ringnummer von HostPool.

--sso-client-id

ClientId für die registrierte vertrauende Seite, die zum Ausgeben von WVD-SSO-Zertifikaten verwendet wird.

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

Pfad zu Azure KeyVault, der den geheimen Schlüssel speichert, der für die Kommunikation mit ADFS verwendet wird.

--sso-secret-type

Der Typ des einmaligen Anmeldens im geheimen Typ.

Eigenschaft	Wert
Zulässige Werte:	Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault

--ssoadfs-authority

URL zum ADFS-Server des Kunden zum Signieren von WVD-SSO-Zertifikaten.

--start-vm-on-connect

Das Kennzeichen zum Aktivieren/Deaktivieren des StartVMOnConnect-Features.

Eigenschaft	Wert
Zulässige Werte:	0, 1, f, false, n, no, t, true, y, yes

--tags

Ressourcentags. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--validation-environment

Ist die Überprüfungsumgebung.

Eigenschaft	Wert
Zulässige Werte:	0, 1, f, false, n, no, t, true, y, yes

--vm-template

VM-Vorlage für die Sessionhosts-Konfiguration innerhalb des Hostpools.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az desktopvirtualization hostpool delete

Löschen eines Hostpools.

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

Beispiele

Hostpool löschen

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

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--force

Kennzeichnung zum Löschen von sessionHost erzwingen.

Eigenschaft	Wert
Zulässige Werte:	0, 1, f, false, n, no, t, true, y, yes

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--name -n

Der Name des Hostpools innerhalb der angegebenen Ressourcengruppe.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft	Wert
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az desktopvirtualization hostpool list

Hostpools auflisten.

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

Beispiele

Hostpool auflisten

az desktopvirtualization hostpool list -g rg

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--max-items

Die Gesamtanzahl der Elemente, die in der Ausgabe des Befehls zurückgegeben werden sollen. Wenn die Gesamtanzahl der verfügbaren Elemente größer als der angegebene Wert ist, wird ein Token in der Ausgabe des Befehls bereitgestellt. Um die Paginierung fortzusetzen, geben Sie den Tokenwert in --next-token Argument eines nachfolgenden Befehls an.

Eigenschaft	Wert
Parametergruppe:	Pagination Arguments

--next-token

Token, das angibt, wo die Paginierung beginnen soll. Dies ist der Tokenwert aus einer zuvor abgeschnittenen Antwort.

Eigenschaft	Wert
Parametergruppe:	Pagination Arguments

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az desktopvirtualization hostpool retrieve-registration-token

Registrierungstoken des Hostpools.

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

Beispiele

Registrierungstoken des Hostpools.

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

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--ids

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--name -n

Der Name des Hostpools innerhalb der angegebenen Ressourcengruppe.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az desktopvirtualization hostpool show

Anzeigen eines Hostpools.

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

Beispiele

Hostpool anzeigen

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

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--ids

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--name -n

Der Name des Hostpools innerhalb der angegebenen Ressourcengruppe.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az desktopvirtualization hostpool update

Aktualisieren eines Hostpools.

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]

Beispiele

Hostpool aktualisieren

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

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

Eigenschaft	Wert
Parametergruppe:	Generic Update Arguments

--custom-rdp-property

Benutzerdefinierte rdp-Eigenschaft des Hostpools.

--description

Beschreibung des HostPools.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Eigenschaft	Wert
Parametergruppe:	Generic Update Arguments
Zulässige Werte:	0, 1, f, false, n, no, t, true, y, yes

--friendly-name

Anzeigename von HostPool.

--ids

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--load-balancer-type

Der Typ des Lastenausgleichs.

Eigenschaft	Wert
Zulässige Werte:	BreadthFirst, DepthFirst, Persistent

--max-session-limit

Der maximale Sitzungsgrenzwert von HostPool.

--name -n

Der Name des Hostpools innerhalb der angegebenen Ressourcengruppe.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--personal-desktop-assignment-type

PersonalDesktopAssignment-Typ für HostPool.

Eigenschaft	Wert
Zulässige Werte:	Automatic, Direct

--preferred-app-group-type -t

Der Typ des bevorzugten Anwendungsgruppentyps, standardmäßig für die Desktopanwendungsgruppe.

Eigenschaft	Wert
Zulässige Werte:	Desktop, None, RailApplications

--registration-info

Die Registrierungsinformationen von HostPool. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

Eigenschaft	Wert
Parametergruppe:	Generic Update Arguments

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--ring

Die Ringnummer von HostPool.

--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>.

Eigenschaft	Wert
Parametergruppe:	Generic Update Arguments

--sso-client-id

ClientId für die registrierte vertrauende Seite, die zum Ausgeben von WVD-SSO-Zertifikaten verwendet wird.

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

Pfad zu Azure KeyVault, der den geheimen Schlüssel speichert, der für die Kommunikation mit ADFS verwendet wird.

--sso-secret-type

Der Typ des einmaligen Anmeldens im geheimen Typ.

Eigenschaft	Wert
Zulässige Werte:	Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault

--ssoadfs-authority

URL zum ADFS-Server des Kunden zum Signieren von WVD-SSO-Zertifikaten.

--start-vm-on-connect

Das Kennzeichen zum Aktivieren/Deaktivieren des StartVMOnConnect-Features.

Eigenschaft	Wert
Zulässige Werte:	0, 1, f, false, n, no, t, true, y, yes

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--tags

Ressourcentags. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--validation-environment

Ist die Überprüfungsumgebung.

Eigenschaft	Wert
Zulässige Werte:	0, 1, f, false, n, no, t, true, y, yes

--vm-template

VM-Vorlage für die Sessionhosts-Konfiguration innerhalb des Hostpools.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

Feedback

War diese Seite hilfreich?

Freigeben über

az desktopvirtualization hostpool

Befehle

az desktopvirtualization hostpool create

Beispiele

Erforderliche Parameter

Optionale Parameter

az desktopvirtualization hostpool delete

Beispiele

Optionale Parameter

az desktopvirtualization hostpool list

Beispiele

Optionale Parameter

az desktopvirtualization hostpool retrieve-registration-token

Beispiele

Optionale Parameter

az desktopvirtualization hostpool show

Beispiele

Optionale Parameter

az desktopvirtualization hostpool update

Beispiele

Optionale Parameter

Feedback