az desktopvirtualization hostpool
Note
Tento odkaz je součástí rozšíření desktopvirtualizace pro Azure CLI (verze 2.55.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az desktopvirtualization hostpool. Přečtěte si další informace o rozšířeních.
Správa fondu hostitelů virtualizace plochy
Příkazy
| Name | Description | Typ | Stav |
|---|---|---|---|
| az desktopvirtualization hostpool create |
Vytvořte fond hostitelů. |
Extension | GA |
| az desktopvirtualization hostpool delete |
Odstraňte fond hostitelů. |
Extension | GA |
| az desktopvirtualization hostpool list |
Zobrazit seznam fondů hostitelů |
Extension | GA |
| az desktopvirtualization hostpool retrieve-registration-token |
Registrační token fondu hostitelů. |
Extension | GA |
| az desktopvirtualization hostpool show |
Zobrazení fondu hostitelů |
Extension | GA |
| az desktopvirtualization hostpool update |
Aktualizujte fond hostitelů. |
Extension | GA |
az desktopvirtualization hostpool create
Vytvořte fond hostitelů.
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]
Příklady
Vytvoření fondu hostitelů
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
Povinné parametry
Typ fondu hostitelů pro plochu.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | BYODesktop, Personal, Pooled |
Typ nástroje pro vyrovnávání zatížení.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | BreadthFirst, DepthFirst, Persistent |
Název fondu hostitelů v rámci zadané skupiny prostředků.
Typ upřednostňovaného typu skupiny aplikací, výchozí hodnota je skupina desktopových aplikací.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | Desktop, None, RailApplications |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
Volitelné parametry
Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.
Vlastní vlastnost rdp fondu hostitelů
Popis fondu hostitelů.
Popisný název fondu hostitelů.
Geografické umístění, ve kterém se nachází zdroj.
Maximální limit relace fondu hostitelů.
Typ PersonalDesktopAssignment pro Fond hostitelů.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | Automatic, Direct |
Informace o registraci fondu hostitelů. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.
Počet okruhů fondu hostitelů.
ClientId registrované předávající strany používané k vydávání certifikátů jednotného přihlašování služby WVD.
Cesta ke službě Azure KeyVault ukládá tajný klíč používaný ke komunikaci s ADFS.
Typ jednotného přihlašování pro typ tajného klíče.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault |
Adresa URL pro server ADFS zákazníka pro podepisování certifikátů jednotného přihlašování služby WVD
Příznak pro zapnutí nebo vypnutí funkce StartVMOnConnect
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | 0, 1, f, false, n, no, t, true, y, yes |
Značky prostředků Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.
Je prostředí pro ověřování.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | 0, 1, f, false, n, no, t, true, y, yes |
Šablona virtuálního počítače pro konfiguraci hostitelů relací v rámci fondu hostitelů
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az desktopvirtualization hostpool delete
Odstraňte fond hostitelů.
az desktopvirtualization hostpool delete [--force {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Příklady
Odstranění fondu hostitelů
az desktopvirtualization hostpool delete -g rg -n hostpool-name
Volitelné parametry
Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.
Vynuťte příznak k odstranění sessionHost.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | 0, 1, f, false, n, no, t, true, y, yes |
Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název fondu hostitelů v rámci zadané skupiny prostředků.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Nevyzývejte k potvrzení.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az desktopvirtualization hostpool list
Zobrazit seznam fondů hostitelů
az desktopvirtualization hostpool list [--max-items]
[--next-token]
[--resource-group]
Příklady
Výpis fondu hostitelů
az desktopvirtualization hostpool list -g rg
Volitelné parametry
Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.
Celkový počet položek, které se mají vrátit ve výstupu příkazu Pokud je celkový počet dostupných položek větší než zadaná hodnota, zobrazí se ve výstupu příkazu token. Pokud chcete pokračovat ve stránkování, zadejte hodnotu tokenu v --next-token argumentu následného příkazu.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Pagination Arguments |
Token určující, kde se má stránkování spustit. Toto je hodnota tokenu z dříve zkrácené odpovědi.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Pagination Arguments |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az desktopvirtualization hostpool retrieve-registration-token
Registrační token fondu hostitelů.
az desktopvirtualization hostpool retrieve-registration-token [--ids]
[--name]
[--resource-group]
[--subscription]
Příklady
Registrační token fondu hostitelů.
az desktopvirtualization hostpool retrieve-registration-token -n hostpool-name -g rg
Volitelné parametry
Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.
Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název fondu hostitelů v rámci zadané skupiny prostředků.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az desktopvirtualization hostpool show
Zobrazení fondu hostitelů
az desktopvirtualization hostpool show [--ids]
[--name]
[--resource-group]
[--subscription]
Příklady
Zobrazit fond hostitelů
az desktopvirtualization hostpool show -g rg -n hostpool-name
Volitelné parametry
Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.
Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název fondu hostitelů v rámci zadané skupiny prostředků.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az desktopvirtualization hostpool update
Aktualizujte fond hostitelů.
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]
Příklady
Aktualizace fondu hostitelů
az desktopvirtualization hostpool update -g rg -n hostpool-name --tags tag=test
Volitelné parametry
Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.
Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Generic Update Arguments |
Vlastní vlastnost rdp fondu hostitelů
Popis fondu hostitelů.
Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Generic Update Arguments |
| Přípustné hodnoty: | 0, 1, f, false, n, no, t, true, y, yes |
Popisný název fondu hostitelů.
Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Typ nástroje pro vyrovnávání zatížení.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | BreadthFirst, DepthFirst, Persistent |
Maximální limit relace fondu hostitelů.
Název fondu hostitelů v rámci zadané skupiny prostředků.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Typ PersonalDesktopAssignment pro Fond hostitelů.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | Automatic, Direct |
Typ upřednostňovaného typu skupiny aplikací, výchozí hodnota je skupina desktopových aplikací.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | Desktop, None, RailApplications |
Informace o registraci fondu hostitelů. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.
Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Generic Update Arguments |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Počet okruhů fondu hostitelů.
Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Generic Update Arguments |
ClientId registrované předávající strany používané k vydávání certifikátů jednotného přihlašování služby WVD.
Cesta ke službě Azure KeyVault ukládá tajný klíč používaný ke komunikaci s ADFS.
Typ jednotného přihlašování pro typ tajného klíče.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault |
Adresa URL pro server ADFS zákazníka pro podepisování certifikátů jednotného přihlašování služby WVD
Příznak pro zapnutí nebo vypnutí funkce StartVMOnConnect
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | 0, 1, f, false, n, no, t, true, y, yes |
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Značky prostředků Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.
Je prostředí pro ověřování.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | 0, 1, f, false, n, no, t, true, y, yes |
Šablona virtuálního počítače pro konfiguraci hostitelů relací v rámci fondu hostitelů
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |