az desktopvirtualization hostpool

Hinweis

Dieser Verweis ist Teil der Desktopvirtualisierungserweiterung für die Azure CLI (Version 2.15.0 oder höher). Die Erweiterung installiert automatisch beim ersten Ausführen eines az desktopvirtualization hostpool-Befehls . Weitere Informationen zu Erweiterungen

Desktopvirtualisierungshostpool.

Befehle

az desktopvirtualization hostpool create

Erstellen Sie einen Hostpool.

az desktopvirtualization hostpool delete

Entfernen Sie einen Hostpool.

az desktopvirtualization hostpool list

Listen von HostPools im Abonnement auf.

az desktopvirtualization hostpool retrieve-registration-token

Registrierungstoken des Hostpools.

az desktopvirtualization hostpool show

Rufen Sie einen Hostpool ab.

az desktopvirtualization hostpool update

Aktualisieren eines Hostpools.

az desktopvirtualization hostpool create

Erstellen Sie einen Hostpool.

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 {false, true}]
                                         [--tags]
                                         [--validation-environment {false, true}]
                                         [--vm-template]

Beispiele

HostPool_Create

az desktopvirtualization hostpool create --location "centralus" --description "des1" --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="2020-10-01T14:01:54.9571247Z" registration-token-operation="Update" --sso-client-id "client" --sso-client-secret-key-vault-path "https://keyvault/secret" --sso-secret-type "SharedKey" --ssoadfs-authority "https://adfs" --start-vm-on-connect false --vm-template "{json:json}" --tags tag1="value1" tag2="value2" --name "MyHostPool" --resource-group "MyResourceGroup"

Erforderliche Parameter

--host-pool-type

HostPool-Typ 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 in der 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 von HostPool.

--description

Beschreibung des HostPools.

--friendly-name

Anzeigename von HostPool.

--location -l

Der Standort. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

--max-session-limit

Die maximale Sitzungsgrenze von HostPool.

--personal-desktop-assignment-type

PersonalDesktopAssignment-Typ für HostPool.

Zulässige Werte: Automatic, Direct
--registration-info

Die Registrierungsinformationen von HostPool.

--ring

Die Ringnummer des HostPools.

--sso-client-id

ClientId für die registrierte vertrauende Partei, die verwendet wird, um WVD-SSO-Zertifikate zu erstellen.

--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 Flag zum Aktivieren/Deaktivieren der StartVMOnConnect-Funktion.

Zulässige Werte: false, true
--tags

Leergetrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--validation-environment

Ist die Validierungsumgebung.

Zulässige Werte: false, true
--vm-template

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

az desktopvirtualization hostpool delete

Entfernen Sie einen Hostpool.

az desktopvirtualization hostpool delete --name
                                         --resource-group
                                         [--force {false, true}]

Beispiele

HostPool_Delete

az desktopvirtualization hostpool delete --force true --name "MyHostPool" --resource-group "MyResourceGroup"

Erforderliche Parameter

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

Optionale Parameter

--force

Erzwingen Sie das Flag zum Löschen von SessionHost.

Zulässige Werte: false, true

az desktopvirtualization hostpool list

Listen von HostPools im Abonnement auf.

az desktopvirtualization hostpool list [--resource-group]

Beispiele

HostPool_ListByResourceGroup

az desktopvirtualization hostpool list --resource-group "MyResourceGroup"

Optionale Parameter

--resource-group -g

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

az desktopvirtualization hostpool retrieve-registration-token

Registrierungstoken des Hostpools.

az desktopvirtualization hostpool retrieve-registration-token --name
                                                              --resource-group

Beispiele

HostPools_RetrieveRegistrationToken_Post

az desktopvirtualization hostpool retrieve-registration-token --name "MyHostPool" --resource-group "MyResourceGroup"

Erforderliche Parameter

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

az desktopvirtualization hostpool show

Rufen Sie einen Hostpool ab.

az desktopvirtualization hostpool show --name
                                       --resource-group

Beispiele

HostPool_Get

az desktopvirtualization hostpool show --name "MyHostPool" --resource-group "MyResourceGroup"

Erforderliche Parameter

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

az desktopvirtualization hostpool update

Aktualisieren eines Hostpools.

az desktopvirtualization hostpool update --name
                                         --resource-group
                                         [--custom-rdp-property]
                                         [--description]
                                         [--friendly-name]
                                         [--load-balancer-type {BreadthFirst, DepthFirst, Persistent}]
                                         [--max-session-limit]
                                         [--personal-desktop-assignment-type {Automatic, Direct}]
                                         [--preferred-app-group-type {Desktop, None, RailApplications}]
                                         [--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 {false, true}]
                                         [--tags]
                                         [--validation-environment {false, true}]
                                         [--vm-template]

Beispiele

HostPool_Update

az desktopvirtualization hostpool update --description "des1" --friendly-name "friendly" --load-balancer-type "BreadthFirst" --max-session-limit 999999 --personal-desktop-assignment-type "Automatic" --registration-info expiration-time="2020-10-01T15:01:54.9571247Z" registration-token-operation="Update" --sso-client-id "client" --sso-client-secret-key-vault-path "https://keyvault/secret" --sso-secret-type "SharedKey" --ssoadfs-authority "https://adfs" --start-vm-on-connect false --vm-template "{json:json}" --tags tag1="value1" tag2="value2" --name "MyHostPool" --resource-group "MyResourceGroup"

Erforderliche Parameter

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

Optionale Parameter

--custom-rdp-property

Benutzerdefinierte rdp-Eigenschaft von HostPool.

--description

Beschreibung des HostPools.

--friendly-name

Anzeigename von HostPool.

--load-balancer-type

Der Typ des Lastenausgleichs.

Zulässige Werte: BreadthFirst, DepthFirst, Persistent
--max-session-limit

Die maximale Sitzungsgrenze von HostPool.

--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 in der Desktopanwendungsgruppe.

Zulässige Werte: Desktop, None, RailApplications
--registration-info

Die Registrierungsinformationen von HostPool.

--ring

Die Ringnummer des HostPools.

--sso-client-id

ClientId für die registrierte vertrauende Partei, die verwendet wird, um WVD-SSO-Zertifikate zu erstellen.

--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 Flag zum Aktivieren/Deaktivieren der StartVMOnConnect-Funktion.

Zulässige Werte: false, true
--tags

Leergetrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--validation-environment

Ist die Validierungsumgebung.

Zulässige Werte: false, true
--vm-template

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