Bagikan melalui

az desktopvirtualization hostpool

  • Referensi

Catatan

Referensi ini adalah bagian dari ekstensi desktopvirtualisasi untuk Azure CLI (versi 2.55.0 atau yang lebih tinggi). Ekstensi akan secara otomatis menginstal pertama kali Anda menjalankan perintah hostpool desktopvirtualisasi az. Pelajari lebih lanjut tentang ekstensi.

Mengelola kumpulan host virtualisasi desktop.

Perintah

Nama Deskripsi Jenis Status
az desktopvirtualization hostpool create

Buat kumpulan host.

 Ekstensi GA
az desktopvirtualization hostpool delete

Menghapus kumpulan host.

 Ekstensi GA
az desktopvirtualization hostpool list

Mencantumkan kumpulan host.

 Ekstensi GA
az desktopvirtualization hostpool retrieve-registration-token

Token pendaftaran kumpulan host.

 Ekstensi GA
az desktopvirtualization hostpool show

Tampilkan kumpulan host.

 Ekstensi GA
az desktopvirtualization hostpool update

Memperbarui kumpulan host.

 Ekstensi GA

az desktopvirtualization hostpool create

Buat kumpulan host.

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]

Contoh

Membuat kumpulan host

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

Parameter yang Diperlukan

--host-pool-type

Jenis kumpulan host untuk desktop.

Nilai yang diterima: BYODesktop, Personal, Pooled
--load-balancer-type

Jenis load balancer.

Nilai yang diterima: BreadthFirst, DepthFirst, Persistent
--name -n

Nama kumpulan host dalam grup sumber daya yang ditentukan.

--preferred-app-group-type -t

Jenis jenis grup aplikasi pilihan, default ke grup aplikasi desktop.

Nilai yang diterima: Desktop, None, RailApplications
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Opsional

--custom-rdp-property

Properti rdp kustom kumpulan host.

--description

Deskripsi HostPool.

--friendly-name

Nama hostPool yang ramah.

--location -l

Lokasi geografis tempat sumber daya berada.

--max-session-limit

Batas sesi maksimum HostPool.

--personal-desktop-assignment-type

Jenis PersonalDesktopAssignment untuk HostPool.

Nilai yang diterima: Automatic, Direct
--registration-info

Info pendaftaran HostPool. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

--ring

Nomor cincin HostPool.

--sso-client-id

ClientId untuk Pihak Yang Mengandalkan terdaftar yang digunakan untuk menerbitkan sertifikat SSO WVD.

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

Jalur ke Azure KeyVault menyimpan rahasia yang digunakan untuk komunikasi ke ADFS.

--sso-secret-type

Jenis akses menyeluruh pada Jenis Rahasia.

Nilai yang diterima: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL ke server ADFS pelanggan untuk menandatangani sertifikat SSO WVD.

--start-vm-on-connect

Bendera untuk mengaktifkan/menonaktifkan fitur StartVMOn Koneksi.

Nilai yang diterima: 0, 1, f, false, n, no, t, true, y, yes
--tags

Tag sumber daya. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

--validation-environment

Adalah lingkungan validasi.

Nilai yang diterima: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Templat VM untuk konfigurasi sessionhosts dalam hostpool.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az desktopvirtualization hostpool delete

Menghapus kumpulan host.

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

Contoh

Menghapus kumpulan host

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

Parameter Opsional

--force

Paksa bendera untuk menghapus sessionHost.

Nilai yang diterima: 0, 1, f, false, n, no, t, true, y, yes
--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama kumpulan host dalam grup sumber daya yang ditentukan.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--yes -y

Jangan meminta konfirmasi.

Nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az desktopvirtualization hostpool list

Mencantumkan kumpulan host.

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

Contoh

Mencantumkan kumpulan host

az desktopvirtualization hostpool list -g rg

Parameter Opsional

--max-items

Jumlah total item yang akan dikembalikan dalam output perintah. Jika jumlah total item yang tersedia lebih dari nilai yang ditentukan, token disediakan dalam output perintah. Untuk melanjutkan penomoran halaman, berikan nilai token dalam --next-token argumen perintah berikutnya.

--next-token

Token untuk menentukan tempat untuk memulai paginating. Ini adalah nilai token dari respons yang dipotong sebelumnya.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az desktopvirtualization hostpool retrieve-registration-token

Token pendaftaran kumpulan host.

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

Contoh

Token pendaftaran kumpulan host.

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

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama kumpulan host dalam grup sumber daya yang ditentukan.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az desktopvirtualization hostpool show

Tampilkan kumpulan host.

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

Contoh

Perlihatkan kumpulan host

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

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama kumpulan host dalam grup sumber daya yang ditentukan.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az desktopvirtualization hostpool update

Memperbarui kumpulan host.

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]

Contoh

Memperbarui kumpulan host

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

Parameter Opsional

--add

Tambahkan objek ke daftar objek dengan menentukan jalur dan pasangan nilai kunci. Contoh: --add property.listProperty <key=value, string, atau string JSON>.

--custom-rdp-property

Properti rdp kustom kumpulan host.

--description

Deskripsi HostPool.

--force-string

Saat menggunakan 'set' atau 'add', pertahankan literal string alih-alih mencoba mengonversi ke JSON.

Nilai yang diterima: 0, 1, f, false, n, no, t, true, y, yes
--friendly-name

Nama hostPool yang ramah.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--load-balancer-type

Jenis load balancer.

Nilai yang diterima: BreadthFirst, DepthFirst, Persistent
--max-session-limit

Batas sesi maksimum HostPool.

--name -n

Nama kumpulan host dalam grup sumber daya yang ditentukan.

--personal-desktop-assignment-type

Jenis PersonalDesktopAssignment untuk HostPool.

Nilai yang diterima: Automatic, Direct
--preferred-app-group-type -t

Jenis jenis grup aplikasi pilihan, default ke grup aplikasi desktop.

Nilai yang diterima: Desktop, None, RailApplications
--registration-info

Info pendaftaran HostPool. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

--remove

Menghapus properti atau elemen dari daftar. Contoh: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--ring

Nomor cincin HostPool.

--set

Perbarui objek dengan menentukan jalur properti dan nilai yang akan diatur. Contoh: --set property1.property2=.

--sso-client-id

ClientId untuk Pihak Yang Mengandalkan terdaftar yang digunakan untuk menerbitkan sertifikat SSO WVD.

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

Jalur ke Azure KeyVault menyimpan rahasia yang digunakan untuk komunikasi ke ADFS.

--sso-secret-type

Jenis akses menyeluruh pada Jenis Rahasia.

Nilai yang diterima: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL ke server ADFS pelanggan untuk menandatangani sertifikat SSO WVD.

--start-vm-on-connect

Bendera untuk mengaktifkan/menonaktifkan fitur StartVMOn Koneksi.

Nilai yang diterima: 0, 1, f, false, n, no, t, true, y, yes
--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--tags

Tag sumber daya. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

--validation-environment

Adalah lingkungan validasi.

Nilai yang diterima: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Templat VM untuk konfigurasi sessionhosts dalam hostpool.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.