az desktopvirtualization hostpool

  • Reference

Poznámka:

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

 Rozšíření GA
az desktopvirtualization hostpool delete

Odstraňte fond hostitelů.

 Rozšíření GA
az desktopvirtualization hostpool list

Zobrazit seznam fondů hostitelů

 Rozšíření GA
az desktopvirtualization hostpool retrieve-registration-token

Registrační token fondu hostitelů.

 Rozšíření GA
az desktopvirtualization hostpool show

Zobrazení fondu hostitelů

 Rozšíření GA
az desktopvirtualization hostpool update

Aktualizujte fond hostitelů.

 Rozšíření 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

--host-pool-type

Typ fondu hostitelů pro plochu.

přijímané hodnoty: BYODesktop, Personal, Pooled
--load-balancer-type

Typ nástroje pro vyrovnávání zatížení.

přijímané hodnoty: BreadthFirst, DepthFirst, Persistent
--name -n

Název fondu hostitelů v rámci zadané skupiny prostředků.

--preferred-app-group-type -t

Typ upřednostňovaného typu skupiny aplikací, výchozí hodnota je skupina desktopových aplikací.

přijímané hodnoty: Desktop, None, RailApplications
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Volitelné parametry

--custom-rdp-property

Vlastní vlastnost rdp fondu hostitelů

--description

Popis fondu hostitelů.

--friendly-name

Popisný název fondu hostitelů.

--location -l

Geografické umístění, ve kterém se nachází zdroj.

--max-session-limit

Maximální limit relace fondu hostitelů.

--personal-desktop-assignment-type

Typ PersonalDesktopAssignment pro Fond hostitelů.

přijímané hodnoty: Automatic, Direct
--registration-info

Informace o registraci fondu hostitelů. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--ring

Počet okruhů fondu hostitelů.

--sso-client-id

ClientId registrované předávající strany používané k vydávání certifikátů jednotného přihlašování služby WVD.

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

Cesta ke službě Azure KeyVault ukládá tajný klíč používaný ke komunikaci s ADFS.

--sso-secret-type

Typ jednotného přihlašování pro typ tajného klíče.

přijímané hodnoty: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

Adresa URL pro server ADFS zákazníka pro podepisování certifikátů jednotného přihlašování služby WVD

--start-vm-on-connect

Příznak pro zapnutí nebo vypnutí funkce StartVMOn Připojení

přijímané hodnoty: 0, 1, f, false, n, no, t, true, y, yes
--tags

Značky prostředků Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--validation-environment

Je prostředí pro ověřování.

přijímané hodnoty: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Šablona virtuálního počítače pro konfiguraci hostitelů relací v rámci fondu hostitelů

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

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

--force

Vynuťte příznak k odstranění sessionHost.

přijímané hodnoty: 0, 1, f, false, n, no, t, true, y, yes
--ids

Jedno nebo více ID prostředků (oddělených 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 argumenty --ids nebo jiné argumenty ID prostředku.

--name -n

Název fondu hostitelů v rámci zadané skupiny prostředků.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--yes -y

Nezotvádejte výzvu k potvrzení.

výchozí hodnota: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

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

--max-items

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. Chcete-li obnovit stránkování, zadejte hodnotu tokenu v --next-token argumentu následného příkazu.

--next-token

Token určující, kde se má stránkování spustit. Toto je hodnota tokenu z dříve zkrácené odpovědi.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

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

--ids

Jedno nebo více ID prostředků (oddělených 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 argumenty --ids nebo jiné argumenty ID prostředku.

--name -n

Název fondu hostitelů v rámci zadané skupiny prostředků.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

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

--ids

Jedno nebo více ID prostředků (oddělených 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 argumenty --ids nebo jiné argumenty ID prostředku.

--name -n

Název fondu hostitelů v rámci zadané skupiny prostředků.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

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

--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, řetězec nebo řetězec> JSON.

--custom-rdp-property

Vlastní vlastnost rdp fondu hostitelů

--description

Popis fondu hostitelů.

--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

přijímané hodnoty: 0, 1, f, false, n, no, t, true, y, yes
--friendly-name

Popisný název fondu hostitelů.

--ids

Jedno nebo více ID prostředků (oddělených 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 argumenty --ids nebo jiné argumenty ID prostředku.

--load-balancer-type

Typ nástroje pro vyrovnávání zatížení.

přijímané hodnoty: BreadthFirst, DepthFirst, Persistent
--max-session-limit

Maximální limit relace fondu hostitelů.

--name -n

Název fondu hostitelů v rámci zadané skupiny prostředků.

--personal-desktop-assignment-type

Typ PersonalDesktopAssignment pro Fond hostitelů.

přijímané hodnoty: Automatic, Direct
--preferred-app-group-type -t

Typ upřednostňovaného typu skupiny aplikací, výchozí hodnota je skupina desktopových aplikací.

přijímané hodnoty: Desktop, None, RailApplications
--registration-info

Informace o registraci fondu hostitelů. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--ring

Počet okruhů fondu hostitelů.

--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=.

--sso-client-id

ClientId registrované předávající strany používané k vydávání certifikátů jednotného přihlašování služby WVD.

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

Cesta ke službě Azure KeyVault ukládá tajný klíč používaný ke komunikaci s ADFS.

--sso-secret-type

Typ jednotného přihlašování pro typ tajného klíče.

přijímané hodnoty: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

Adresa URL pro server ADFS zákazníka pro podepisování certifikátů jednotného přihlašování služby WVD

--start-vm-on-connect

Příznak pro zapnutí nebo vypnutí funkce StartVMOn Připojení

přijímané hodnoty: 0, 1, f, false, n, no, t, true, y, yes
--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--tags

Značky prostředků Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--validation-environment

Je prostředí pro ověřování.

přijímané hodnoty: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Šablona virtuálního počítače pro konfiguraci hostitelů relací v rámci fondu hostitelů

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.