az desktopvirtualization hostpool
Nota:
Esta referencia forma parte de la extensión desktopvirtualization para la CLI de Azure (versión 2.55.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az desktopvirtualization hostpool . Obtenga más información sobre las extensiones.
Administrar el grupo de hosts de virtualización de escritorio.
Comandos
| Nombre | Description | Tipo | Estado |
|---|---|---|---|
| az desktopvirtualization hostpool create |
Crear un grupo de hosts. |
Extensión | GA |
| az desktopvirtualization hostpool delete |
Elimine un grupo de hosts. |
Extensión | GA |
| az desktopvirtualization hostpool list |
Enumera los grupos de hosts. |
Extensión | GA |
| az desktopvirtualization hostpool retrieve-registration-token |
Token de registro del grupo de hosts. |
Extensión | GA |
| az desktopvirtualization hostpool show |
Mostrar un grupo host. |
Extensión | GA |
| az desktopvirtualization hostpool update |
Actualice un grupo de hosts. |
Extensión | GA |
az desktopvirtualization hostpool create
Crear un grupo de hosts.
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]Ejemplos
Creación de un grupo de hosts
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 falseParámetros requeridos
Tipo de grupo de hosts para escritorio.
Tipo del equilibrador de carga.
Nombre del grupo de hosts dentro del grupo de recursos especificado.
El tipo de grupo de aplicaciones preferido, el valor predeterminado es el grupo de aplicaciones de escritorio.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Parámetros opcionales
Propiedad rdp personalizada del grupo de hosts.
Descripción de HostPool.
Nombre descriptivo de HostPool.
Ubicación geográfica donde reside el recurso.
Límite máximo de sesión de HostPool.
Tipo PersonalDesktopAssignment para HostPool.
La información de registro de HostPool. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.
Número de anillo de HostPool.
ClientId para el usuario de confianza registrado usado para emitir certificados SSO de WVD.
Ruta de acceso a Azure KeyVault que almacena el secreto usado para la comunicación con ADFS.
Tipo de inicio de sesión único en Tipo secreto.
Dirección URL al servidor ADFS del cliente para firmar certificados SSO de WVD.
Marca para activar o desactivar la característica StartVMOn Conectar.
Etiquetas del recurso. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.
Es el entorno de validación.
Plantilla de máquina virtual para la configuración de sessionhosts dentro del grupo de hosts.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
az desktopvirtualization hostpool delete
Elimine un grupo de hosts.
az desktopvirtualization hostpool delete [--force {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]Ejemplos
Eliminación del grupo de hosts
az desktopvirtualization hostpool delete -g rg -n hostpool-nameParámetros opcionales
Forzar la marca para eliminar sessionHost.
Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
Nombre del grupo de hosts dentro del grupo de recursos especificado.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
No solicita confirmación.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
az desktopvirtualization hostpool list
Enumera los grupos de hosts.
az desktopvirtualization hostpool list [--max-items]
[--next-token]
[--resource-group]Ejemplos
Enumeración del grupo de hosts
az desktopvirtualization hostpool list -g rgParámetros opcionales
Número total de elementos que se van a devolver en la salida del comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un token en la salida del comando. Para reanudar la paginación, proporcione el valor del token en --next-token el argumento de un comando posterior.
Token para especificar dónde iniciar la paginación. Este es el valor del token de una respuesta truncada anteriormente.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
az desktopvirtualization hostpool retrieve-registration-token
Token de registro del grupo de hosts.
az desktopvirtualization hostpool retrieve-registration-token [--ids]
[--name]
[--resource-group]
[--subscription]Ejemplos
Token de registro del grupo de hosts.
az desktopvirtualization hostpool retrieve-registration-token -n hostpool-name -g rgParámetros opcionales
Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
Nombre del grupo de hosts dentro del grupo de recursos especificado.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
az desktopvirtualization hostpool show
Mostrar un grupo host.
az desktopvirtualization hostpool show [--ids]
[--name]
[--resource-group]
[--subscription]Ejemplos
Mostrar grupo de hosts
az desktopvirtualization hostpool show -g rg -n hostpool-nameParámetros opcionales
Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
Nombre del grupo de hosts dentro del grupo de recursos especificado.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
az desktopvirtualization hostpool update
Actualice un grupo de hosts.
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]Ejemplos
Actualización del grupo de hosts
az desktopvirtualization hostpool update -g rg -n hostpool-name --tags tag=testParámetros opcionales
Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string o JSON string>.
Propiedad rdp personalizada del grupo de hosts.
Descripción de HostPool.
Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.
Nombre descriptivo de HostPool.
Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
Tipo del equilibrador de carga.
Límite máximo de sesión de HostPool.
Nombre del grupo de hosts dentro del grupo de recursos especificado.
Tipo PersonalDesktopAssignment para HostPool.
El tipo de grupo de aplicaciones preferido, el valor predeterminado es el grupo de aplicaciones de escritorio.
La información de registro de HostPool. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.
Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list OR --remove propertyToRemove.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Número de anillo de HostPool.
Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=.
ClientId para el usuario de confianza registrado usado para emitir certificados SSO de WVD.
Ruta de acceso a Azure KeyVault que almacena el secreto usado para la comunicación con ADFS.
Tipo de inicio de sesión único en Tipo secreto.
Dirección URL al servidor ADFS del cliente para firmar certificados SSO de WVD.
Marca para activar o desactivar la característica StartVMOn Conectar.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Etiquetas del recurso. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.
Es el entorno de validación.
Plantilla de máquina virtual para la configuración de sessionhosts dentro del grupo de hosts.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de