az desktopvirtualization hostpool

Uwaga

To odwołanie jest częścią rozszerzenia desktopvirtualization dla interfejsu wiersza polecenia platformy Azure (wersja 2.15.0 lub nowsza). Rozszerzenie automatycznie zainstaluje polecenie az desktopvirtualization hostpool po raz pierwszy. Dowiedz się więcej o rozszerzeniach.

Pula hostów desktopvirtualization.

Polecenia

az desktopvirtualization hostpool create	Utwórz pulę hostów.
az desktopvirtualization hostpool delete	Usuń pulę hostów.
az desktopvirtualization hostpool list	Wyświetl listę puli hostów w subskrypcji.
az desktopvirtualization hostpool retrieve-registration-token	Token rejestracji puli hostów.
az desktopvirtualization hostpool show	Pobierz pulę hostów.
az desktopvirtualization hostpool update	Aktualizowanie puli hostów.

az desktopvirtualization hostpool create

Utwórz pulę hostów.

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]

Przykłady

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"

Parametry wymagane

--host-pool-type

Typ puli hostów dla pulpitu.

akceptowane wartości: BYODesktop, Personal, Pooled

--load-balancer-type

Typ modułu równoważenia obciążenia.

akceptowane wartości: BreadthFirst, DepthFirst, Persistent

--name -n

Nazwa puli hostów w określonej grupie zasobów.

--preferred-app-group-type -t

Typ preferowanej grupy aplikacji domyślnie to Grupa aplikacji klasycznych.

akceptowane wartości: Desktop, None, RailApplications

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry opcjonalne

--custom-rdp-property

Niestandardowa właściwość rdp puli hostów.

--description

Opis puli hostów.

--friendly-name

Przyjazna nazwa puli hostów.

--location -l

Lokalizacja. Wartości z: az account list-locations. Lokalizację domyślną można skonfigurować przy użyciu polecenia az configure --defaults location=<location>.

--max-session-limit

Maksymalny limit sesji puli hostów.

--personal-desktop-assignment-type

PersonalDesktopAssignment typ puli hostów.

akceptowane wartości: Automatic, Direct

--registration-info

Informacje o rejestracji puli hostów.

--ring

Numer pierścienia puli hostów.

--sso-client-id

ClientId zarejestrowanej jednostki uzależnionej używanej do wystawiania certyfikatów logowania jednokrotnego WVD.

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

Ścieżka do usługi Azure KeyVault przechowując wpis tajny używany do komunikacji z usługą ADFS.

--sso-secret-type

Typ logowania jednokrotnego w typie wpisu tajnego.

akceptowane wartości: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault

--ssoadfs-authority

Adres URL serwera usługi ADFS klienta do podpisywania certyfikatów logowania jednokrotnego WVD.

--start-vm-on-connect

Flaga włączania/wyłączania funkcji StartVMOnConnect.

akceptowane wartości: false, true

--tags

Tagi rozdzielone spacjami: klucz[=wartość] [klucz[=wartość] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

--validation-environment

Jest środowiskiem weryfikacji.

akceptowane wartości: false, true

--vm-template

Szablon maszyny wirtualnej dla konfiguracji sessionhosts w puli hostów.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az desktopvirtualization hostpool delete

Usuń pulę hostów.

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

Przykłady

HostPool_Delete

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

Parametry wymagane

--name -n

Nazwa puli hostów w określonej grupie zasobów.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry opcjonalne

--force

Wymuś flagę usunięcia sesjiHost.

akceptowane wartości: false, true

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az desktopvirtualization hostpool list

Wyświetl listę puli hostów w subskrypcji.

az desktopvirtualization hostpool list [--resource-group]

Przykłady

HostPool_ListByResourceGroup

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

Parametry opcjonalne

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az desktopvirtualization hostpool retrieve-registration-token

Token rejestracji puli hostów.

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

Przykłady

HostPools_RetrieveRegistrationToken_Post

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

Parametry wymagane

--name -n

Nazwa puli hostów w określonej grupie zasobów.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az desktopvirtualization hostpool show

Pobierz pulę hostów.

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

Przykłady

HostPool_Get

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

Parametry wymagane

--name -n

Nazwa puli hostów w określonej grupie zasobów.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az desktopvirtualization hostpool update

Aktualizowanie puli hostów.

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]

Przykłady

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"

Parametry wymagane

--name -n

Nazwa puli hostów w określonej grupie zasobów.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry opcjonalne

--custom-rdp-property

Niestandardowa właściwość rdp puli hostów.

--description

Opis puli hostów.

--friendly-name

Przyjazna nazwa puli hostów.

--load-balancer-type

Typ modułu równoważenia obciążenia.

akceptowane wartości: BreadthFirst, DepthFirst, Persistent

--max-session-limit

Maksymalny limit sesji puli hostów.

--personal-desktop-assignment-type

PersonalDesktopAssignment typ puli hostów.

akceptowane wartości: Automatic, Direct

--preferred-app-group-type -t

Typ preferowanej grupy aplikacji domyślnie to Grupa aplikacji klasycznych.

akceptowane wartości: Desktop, None, RailApplications

--registration-info

Informacje o rejestracji puli hostów.

--ring

Numer pierścienia puli hostów.

--sso-client-id

ClientId zarejestrowanej jednostki uzależnionej używanej do wystawiania certyfikatów logowania jednokrotnego WVD.

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

Ścieżka do usługi Azure KeyVault przechowując wpis tajny używany do komunikacji z usługą ADFS.

--sso-secret-type

Typ logowania jednokrotnego w typie wpisu tajnego.

akceptowane wartości: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault

--ssoadfs-authority

Adres URL serwera usługi ADFS klienta do podpisywania certyfikatów logowania jednokrotnego WVD.

--start-vm-on-connect

Flaga włączania/wyłączania funkcji StartVMOnConnect.

akceptowane wartości: false, true

--tags

Tagi rozdzielone spacjami: klucz[=wartość] [klucz[=wartość] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

--validation-environment

Jest środowiskiem weryfikacji.

akceptowane wartości: false, true

--vm-template

Szablon maszyny wirtualnej dla konfiguracji sessionhosts w puli hostów.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.