az desktopvirtualization hostpool

  • Référence

Remarque

Cette référence fait partie de l’extension desktopvirtualization pour Azure CLI (version 2.55.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az desktopvirtualization hostpool . En savoir plus sur les extensions.

Gérer le pool d’hôtes de virtualisation de bureau.

Commandes

Nom Description Type Statut
az desktopvirtualization hostpool create

Créez un pool d’hôtes.

 Extension GA
az desktopvirtualization hostpool delete

Supprimez un pool d’hôtes.

 Extension GA
az desktopvirtualization hostpool list

Répertorier les pools d’hôtes.

 Extension GA
az desktopvirtualization hostpool retrieve-registration-token

Jeton d’inscription du pool d’hôtes.

 Extension GA
az desktopvirtualization hostpool show

Afficher un pool d’hôtes.

 Extension GA
az desktopvirtualization hostpool update

Mettez à jour un pool d’hôtes.

 Extension GA

az desktopvirtualization hostpool create

Créez un pool d’hôtes.

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]

Exemples

Créer un pool d’hôtes

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

Paramètres obligatoires

--host-pool-type

Type de pool d’hôtes pour le bureau.

valeurs acceptées: BYODesktop, Personal, Pooled
--load-balancer-type

Type de l’équilibreur de charge.

valeurs acceptées: BreadthFirst, DepthFirst, Persistent
--name -n

Nom du pool d’hôtes dans le groupe de ressources spécifié.

--preferred-app-group-type -t

Type de groupe d’applications préféré, par défaut pour le groupe d’applications de bureau.

valeurs acceptées: Desktop, None, RailApplications
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--custom-rdp-property

Propriété rdp personnalisée du pool d’hôtes.

--description

Description de HostPool.

--friendly-name

Nom convivial de HostPool.

--location -l

Emplacement géographique où réside la ressource.

--max-session-limit

Limite de session maximale de HostPool.

--personal-desktop-assignment-type

Type PersonalDesktopAssignment pour HostPool.

valeurs acceptées: Automatic, Direct
--registration-info

Informations d’inscription de HostPool. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--ring

Numéro d’anneau de HostPool.

--sso-client-id

ClientId pour la partie de confiance inscrite utilisée pour émettre des certificats WVD SSO.

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

Chemin d’accès à Azure KeyVault stockant le secret utilisé pour la communication avec ADFS.

--sso-secret-type

Type d’authentification unique Secret Type.

valeurs acceptées: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL du serveur ADFS client pour la signature de certificats WVD SSO.

--start-vm-on-connect

Indicateur permettant d’activer/désactiver la fonctionnalité StartVMOn Connecter.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--tags

Balises de ressource. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--validation-environment

Environnement de validation.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Modèle de machine virtuelle pour la configuration de sessionhosts dans le pool d’hôtes.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az desktopvirtualization hostpool delete

Supprimez un pool d’hôtes.

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

Exemples

Supprimer le pool d’hôtes

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

Paramètres facultatifs

--force

Forcer l’indicateur à supprimer sessionHost.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name -n

Nom du pool d’hôtes dans le groupe de ressources spécifié.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az desktopvirtualization hostpool list

Répertorier les pools d’hôtes.

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

Exemples

Répertorier le pool d’hôtes

az desktopvirtualization hostpool list -g rg

Paramètres facultatifs

--max-items

Nombre total d’éléments à retourner dans la sortie de la commande. Si le nombre total d’éléments disponibles est supérieur à la valeur spécifiée, un jeton est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur du jeton dans --next-token l’argument d’une commande suivante.

--next-token

Jeton pour spécifier où commencer la pagination. Il s’agit de la valeur du jeton d’une réponse tronquée précédemment.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az desktopvirtualization hostpool retrieve-registration-token

Jeton d’inscription du pool d’hôtes.

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

Exemples

Jeton d’inscription du pool d’hôtes.

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

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name -n

Nom du pool d’hôtes dans le groupe de ressources spécifié.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az desktopvirtualization hostpool show

Afficher un pool d’hôtes.

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

Exemples

Afficher le pool d’hôtes

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

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name -n

Nom du pool d’hôtes dans le groupe de ressources spécifié.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az desktopvirtualization hostpool update

Mettez à jour un pool d’hôtes.

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]

Exemples

Mettre à jour le pool d’hôtes

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

Paramètres facultatifs

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string ou JSON string>.

--custom-rdp-property

Propriété rdp personnalisée du pool d’hôtes.

--description

Description de HostPool.

--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--friendly-name

Nom convivial de HostPool.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--load-balancer-type

Type de l’équilibreur de charge.

valeurs acceptées: BreadthFirst, DepthFirst, Persistent
--max-session-limit

Limite de session maximale de HostPool.

--name -n

Nom du pool d’hôtes dans le groupe de ressources spécifié.

--personal-desktop-assignment-type

Type PersonalDesktopAssignment pour HostPool.

valeurs acceptées: Automatic, Direct
--preferred-app-group-type -t

Type de groupe d’applications préféré, par défaut pour le groupe d’applications de bureau.

valeurs acceptées: Desktop, None, RailApplications
--registration-info

Informations d’inscription de HostPool. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list OR --remove propertyToRemove.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--ring

Numéro d’anneau de HostPool.

--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=.

--sso-client-id

ClientId pour la partie de confiance inscrite utilisée pour émettre des certificats WVD SSO.

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

Chemin d’accès à Azure KeyVault stockant le secret utilisé pour la communication avec ADFS.

--sso-secret-type

Type d’authentification unique Secret Type.

valeurs acceptées: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL du serveur ADFS client pour la signature de certificats WVD SSO.

--start-vm-on-connect

Indicateur permettant d’activer/désactiver la fonctionnalité StartVMOn Connecter.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--tags

Balises de ressource. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--validation-environment

Environnement de validation.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Modèle de machine virtuelle pour la configuration de sessionhosts dans le pool d’hôtes.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.