az desktopvirtualization hostpool

Note

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 az desktopvirtualization hostpool polecenia. 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.	Extension	ogólna dostępność
az desktopvirtualization hostpool delete	Usuń pulę hostów.	Extension	ogólna dostępność
az desktopvirtualization hostpool list	Wyświetlanie listy pul hostów.	Extension	ogólna dostępność
az desktopvirtualization hostpool retrieve-registration-token	Token rejestracji puli hostów.	Extension	ogólna dostępność
az desktopvirtualization hostpool show	Pokaż pulę hostów.	Extension	ogólna dostępność
az desktopvirtualization hostpool update	Aktualizowanie puli hostów.	Extension	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.

Właściwość	Wartość
Dopuszczalne wartości:	BYODesktop, Personal, Pooled

--load-balancer-type

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

Właściwość	Wartość
Dopuszczalne 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.

Właściwość	Wartość
Dopuszczalne wartości:	Desktop, None, RailApplications

--resource-group -g

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

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

Właściwość	Wartość
Dopuszczalne 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.

Właściwość	Wartość
Dopuszczalne 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 StartVMOnConnect.

Właściwość	Wartość
Dopuszczalne 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.

Właściwość	Wartość
Dopuszczalne 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.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

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

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--force

Wymuś flagę usunięcia sessionHost.

Właściwość	Wartość
Dopuszczalne wartości:	0, 1, f, false, n, no, t, true, y, yes

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--name -n

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--resource-group -g

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--yes -y

Nie monituj o potwierdzenie.

Właściwość	Wartość
Domyślna wartość:	False

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

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

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--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 argumentu kolejnego polecenia.

Właściwość	Wartość
Grupa parametrów:	Pagination Arguments

--next-token

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

Właściwość	Wartość
Grupa parametrów:	Pagination Arguments

--resource-group -g

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

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

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

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--ids

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--name -n

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--resource-group -g

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

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

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--ids

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--name -n

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--resource-group -g

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

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

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--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 or JSON string>.

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments

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

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments
Dopuszczalne wartości:	0, 1, f, false, n, no, t, true, y, yes

--friendly-name

Przyjazna nazwa puli hostów.

--ids

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--load-balancer-type

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

Właściwość	Wartość
Dopuszczalne 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.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--personal-desktop-assignment-type

PersonalDesktopAssignment typ puli hostów.

Właściwość	Wartość
Dopuszczalne wartości:	Automatic, Direct

--preferred-app-group-type -t

Typ preferowanej grupy aplikacji, domyślny dla grupy aplikacji klasycznych.

Właściwość	Wartość
Dopuszczalne 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 <indexToRemove> OR --remove propertyToRemove.

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments

--resource-group -g

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

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

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments

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

Właściwość	Wartość
Dopuszczalne 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 StartVMOnConnect.

Właściwość	Wartość
Dopuszczalne 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 az account set -s NAME_OR_ID.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

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

Właściwość	Wartość
Dopuszczalne 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.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

Sprzężenie zwrotne

Czy ta strona była pomocna?

Udostępnij przez

az desktopvirtualization hostpool

Polecenia

az desktopvirtualization hostpool create

Przykłady

Parametry wymagane

Parametry opcjonalne

az desktopvirtualization hostpool delete

Przykłady

Parametry opcjonalne

az desktopvirtualization hostpool list

Przykłady

Parametry opcjonalne

az desktopvirtualization hostpool retrieve-registration-token

Przykłady

Parametry opcjonalne

az desktopvirtualization hostpool show

Przykłady

Parametry opcjonalne

az desktopvirtualization hostpool update

Przykłady

Parametry opcjonalne

Sprzężenie zwrotne