az desktopvirtualization hostpool

Hinweis

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 zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Verwalten des Desktopvirtualisierungshostpools.

Befehle

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

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.

Zulässige Werte: BYODesktop, Personal, Pooled

--load-balancer-type

Der Typ des Lastenausgleichs.

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.

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

--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.

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.

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 StartVMOn Verbinden-Features.

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.

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

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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

--force

Kennzeichnung zum Löschen von sessionHost erzwingen.

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

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--name -n

Der Name des Hostpools innerhalb der angegebenen Ressourcengruppe.

--resource-group -g

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--yes -y

Nicht zur Bestätigung auffordern

Standardwert: False

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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

--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 im --next-token Argument eines nachfolgenden Befehls an.

--next-token

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

--resource-group -g

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

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--name -n

Der Name des Hostpools innerhalb der angegebenen Ressourcengruppe.

--resource-group -g

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--name -n

Der Name des Hostpools innerhalb der angegebenen Ressourcengruppe.

--resource-group -g

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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

--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>.

--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.

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

--friendly-name

Anzeigename von HostPool.

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--load-balancer-type

Der Typ des Lastenausgleichs.

Zulässige Werte: BreadthFirst, DepthFirst, Persistent

--max-session-limit

Der maximale Sitzungsgrenzwert von HostPool.

--name -n

Der Name des Hostpools innerhalb der angegebenen Ressourcengruppe.

--personal-desktop-assignment-type

PersonalDesktopAssignment-Typ für HostPool.

Zulässige Werte: Automatic, Direct

--preferred-app-group-type -t

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

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 OR --remove propertyToRemove.

--resource-group -g

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

--ring

Die Ringnummer von HostPool.

--set

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

--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.

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 StartVMOn Verbinden-Features.

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--tags

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

--validation-environment

Ist die Überprüfungsumgebung.

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

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.