Udostępnij za pośrednictwem

az desktopvirtualization hostpool

  • Odwołanie

Uwaga

Ta dokumentacja jest częścią rozszerzenia pulpituwirtualizacji dla interfejsu wiersza polecenia platformy Azure (wersja 2.55.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az desktopvirtualization hostpool . Dowiedz się więcej o rozszerzeniach.

Zarządzanie pulą hostów wirtualizacji pulpitu.

Polecenia

Nazwa Opis Typ Stan
az desktopvirtualization hostpool create

Utwórz pulę hostów.

 Numer wewnętrzny Ogólna dostępność
az desktopvirtualization hostpool delete

Usuń pulę hostów.

 Numer wewnętrzny Ogólna dostępność
az desktopvirtualization hostpool list

Wyświetlanie listy pul hostów.

 Numer wewnętrzny Ogólna dostępność
az desktopvirtualization hostpool retrieve-registration-token

Token rejestracji puli hostów.

 Numer wewnętrzny Ogólna dostępność
az desktopvirtualization hostpool show

Pokaż pulę hostów.

 Numer wewnętrzny Ogólna dostępność
az desktopvirtualization hostpool update

Aktualizowanie puli hostów.

 Numer wewnętrzny Ogólna dostępność

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 {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]

Przykłady

Tworzenie puli hostów

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

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ślny dla grupy 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 geograficzna, w której znajduje się zasób.

--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. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

--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ługami ADFS.

--sso-secret-type

Typ logowania jednokrotnego w typie wpisu tajnego.

akceptowane wartości: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

Adres URL serwera usług AD FS klienta do podpisywania certyfikatów logowania jednokrotnego WVD.

--start-vm-on-connect

Flaga włączania/wyłączania funkcji StartVMOn Połączenie.

akceptowane wartości: 0, 1, f, false, n, no, t, true, y, yes
--tags

Tagi zasobów. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

--validation-environment

To środowisko weryfikacji.

akceptowane wartości: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Szablon maszyny wirtualnej dla konfiguracji hostów sesji 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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az desktopvirtualization hostpool delete

Usuń pulę hostów.

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

Przykłady

Usuwanie puli hostów

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

Parametry opcjonalne

--force

Wymuś flagę usunięcia sessionHost.

akceptowane wartości: 0, 1, f, false, n, no, t, true, y, yes
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--yes -y

Nie monituj o potwierdzenie.

wartość domyślna: False
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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az desktopvirtualization hostpool list

Wyświetlanie listy pul hostów.

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

Przykłady

Wyświetlanie listy puli hostów

az desktopvirtualization hostpool list -g rg

Parametry opcjonalne

--max-items

Łączna liczba elementów do zwrócenia w danych wyjściowych polecenia. Jeśli łączna liczba dostępnych elementów jest większa niż określona wartość, token jest udostępniany w danych wyjściowych polecenia. Aby wznowić stronicowanie, podaj wartość tokenu w --next-token argumencie kolejnego polecenia.

--next-token

Token do określenia, gdzie rozpocząć stronicowanie. Jest to wartość tokenu z wcześniej obciętej odpowiedzi.

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

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az desktopvirtualization hostpool retrieve-registration-token

Token rejestracji puli hostów.

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

Przykłady

Token rejestracji puli hostów.

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

Parametry opcjonalne

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az desktopvirtualization hostpool show

Pokaż pulę hostów.

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

Przykłady

Pokaż pulę hostów

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

Parametry opcjonalne

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az desktopvirtualization hostpool update

Aktualizowanie puli hostów.

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]

Przykłady

Aktualizowanie puli hostów

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

Parametry opcjonalne

--add

Dodaj obiekt do listy obiektów, określając pary ścieżki i wartości klucza. Przykład: --add property.listProperty <key=value, string lub ciąg> JSON.

--custom-rdp-property

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

--description

Opis puli hostów.

--force-string

W przypadku używania polecenia "set" lub "add" zachowaj literały ciągu zamiast próbować konwertować na format JSON.

akceptowane wartości: 0, 1, f, false, n, no, t, true, y, yes
--friendly-name

Przyjazna nazwa puli hostów.

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

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

--name -n

Nazwa puli hostów w określonej grupie zasobó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ślny dla grupy aplikacji klasycznych.

akceptowane wartości: Desktop, None, RailApplications
--registration-info

Informacje o rejestracji puli hostów. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

--remove

Usuń właściwość lub element z listy. Przykład: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--ring

Numer pierścienia puli hostów.

--set

Zaktualizuj obiekt, określając ścieżkę właściwości i wartość do ustawienia. Przykład: --set property1.property2=.

--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ługami ADFS.

--sso-secret-type

Typ logowania jednokrotnego w typie wpisu tajnego.

akceptowane wartości: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

Adres URL serwera usług AD FS klienta do podpisywania certyfikatów logowania jednokrotnego WVD.

--start-vm-on-connect

Flaga włączania/wyłączania funkcji StartVMOn Połączenie.

akceptowane wartości: 0, 1, f, false, n, no, t, true, y, yes
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--tags

Tagi zasobów. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

--validation-environment

To środowisko weryfikacji.

akceptowane wartości: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Szablon maszyny wirtualnej dla konfiguracji hostów sesji 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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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