Поделиться через

az desktopvirtualization hostpool

  • Ссылка

Примечание.

Эта ссылка является частью расширения desktopvirtualization для Azure CLI (версия 2.55.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az desktopvirtualization hostpool . Подробнее о расширениях.

Управление пулом узлов виртуализации рабочих столов.

Команды

Имя Описание Тип Состояние
az desktopvirtualization hostpool create

Создайте пул узлов.

 Расширение Общедоступная версия
az desktopvirtualization hostpool delete

Удаление пула узлов.

 Расширение Общедоступная версия
az desktopvirtualization hostpool list

Вывод списка пулов узлов.

 Расширение Общедоступная версия
az desktopvirtualization hostpool retrieve-registration-token

Маркер регистрации пула узлов.

 Расширение Общедоступная версия
az desktopvirtualization hostpool show

Отображение пула узлов.

 Расширение Общедоступная версия
az desktopvirtualization hostpool update

Обновление пула узлов.

 Расширение Общедоступная версия

az desktopvirtualization hostpool create

Создайте пул узлов.

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]

Примеры

Создание пула узлов

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

Обязательные параметры

--host-pool-type

Тип пула узлов для настольных компьютеров.

допустимые значения: BYODesktop, Personal, Pooled
--load-balancer-type

Тип подсистемы балансировки нагрузки.

допустимые значения: BreadthFirst, DepthFirst, Persistent
--name -n

Имя пула узлов в указанной группе ресурсов.

--preferred-app-group-type -t

Тип предпочтительного типа группы приложений по умолчанию для группы классических приложений.

допустимые значения: Desktop, None, RailApplications
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--custom-rdp-property

Настраиваемое свойство rdp пула узлов.

--description

Описание HostPool.

--friendly-name

Понятное имя HostPool.

--location -l

Географическое расположение, в котором находится ресурс.

--max-session-limit

Максимальное ограничение сеанса HostPool.

--personal-desktop-assignment-type

Тип PersonalDesktopAssignment для HostPool.

допустимые значения: Automatic, Direct
--registration-info

Сведения о регистрации HostPool. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

--ring

Номер кольца HostPool.

--sso-client-id

ClientId для зарегистрированной проверяющей стороны, используемой для выдачи сертификатов единого входа WVD.

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

Путь к Azure KeyVault, в котором хранится секрет, используемый для обмена данными с ADFS.

--sso-secret-type

Тип единого входа в Secret Type.

допустимые значения: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL-адрес сервера ADFS клиента для подписывания сертификатов единого входа WVD.

--start-vm-on-connect

Флаг для включения или отключения функции StartVMOn Подключение.

допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--tags

Теги ресурсов. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

--validation-environment

Среда проверки.

допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Шаблон виртуальной машины для конфигурации sessionhosts в hostpool.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az desktopvirtualization hostpool delete

Удаление пула узлов.

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

Примеры

Удаление пула узлов

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

Необязательные параметры

--force

Принудительное удаление sessionHost.

допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--name -n

Имя пула узлов в указанной группе ресурсов.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--yes -y

Не запрашивать подтверждение.

значение по умолчанию: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az desktopvirtualization hostpool list

Вывод списка пулов узлов.

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

Примеры

Список пула узлов

az desktopvirtualization hostpool list -g rg

Необязательные параметры

--max-items

Общее количество элементов, возвращаемых в выходных данных команды. Если общее количество доступных элементов превышает указанное значение, маркер предоставляется в выходных данных команды. Чтобы возобновить разбиение на страницы, укажите значение маркера в --next-token аргументе последующей команды.

--next-token

Маркер, чтобы указать, где начать разбиение на страницы. Это значение маркера из ранее усеченного ответа.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az desktopvirtualization hostpool retrieve-registration-token

Маркер регистрации пула узлов.

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

Примеры

Маркер регистрации пула узлов.

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

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--name -n

Имя пула узлов в указанной группе ресурсов.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az desktopvirtualization hostpool show

Отображение пула узлов.

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

Примеры

Показать пул узлов

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

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--name -n

Имя пула узлов в указанной группе ресурсов.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az desktopvirtualization hostpool update

Обновление пула узлов.

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]

Примеры

Обновление пула узлов

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

Необязательные параметры

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string или JSON string>.

--custom-rdp-property

Настраиваемое свойство rdp пула узлов.

--description

Описание HostPool.

--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--friendly-name

Понятное имя HostPool.

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--load-balancer-type

Тип подсистемы балансировки нагрузки.

допустимые значения: BreadthFirst, DepthFirst, Persistent
--max-session-limit

Максимальное ограничение сеанса HostPool.

--name -n

Имя пула узлов в указанной группе ресурсов.

--personal-desktop-assignment-type

Тип PersonalDesktopAssignment для HostPool.

допустимые значения: Automatic, Direct
--preferred-app-group-type -t

Тип предпочтительного типа группы приложений по умолчанию для группы классических приложений.

допустимые значения: Desktop, None, RailApplications
--registration-info

Сведения о регистрации HostPool. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

--remove

Удалите свойство или элемент из списка. Пример: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--ring

Номер кольца HostPool.

--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=.

--sso-client-id

ClientId для зарегистрированной проверяющей стороны, используемой для выдачи сертификатов единого входа WVD.

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

Путь к Azure KeyVault, в котором хранится секрет, используемый для обмена данными с ADFS.

--sso-secret-type

Тип единого входа в Secret Type.

допустимые значения: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL-адрес сервера ADFS клиента для подписывания сертификатов единого входа WVD.

--start-vm-on-connect

Флаг для включения или отключения функции StartVMOn Подключение.

допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--tags

Теги ресурсов. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

--validation-environment

Среда проверки.

допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Шаблон виртуальной машины для конфигурации sessionhosts в hostpool.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.