az desktopvirtualization hostpool

Note

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 un az desktopvirtualization hostpool commande. Apprenez-en davantage sur les extensions.

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

Commandes

Nom	Description	Type	État
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.

Propriété	Valeur
Valeurs acceptées:	BYODesktop, Personal, Pooled

--load-balancer-type

Type de l’équilibreur de charge.

Propriété	Valeur
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.

Propriété	Valeur
Valeurs acceptées:	Desktop, None, RailApplications

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

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

Propriété	Valeur
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.

Propriété	Valeur
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é StartVMOnConnect.

Propriété	Valeur
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.

Propriété	Valeur
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 la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--force

Forcer l’indicateur à supprimer sessionHost.

Propriété	Valeur
Valeurs acceptées:	0, 1, f, false, n, no, t, true, y, yes

--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--name -n

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

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--subscription

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

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--yes -y

N’invitez pas à confirmer.

Propriété	Valeur
Valeur par défaut:	False

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--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 argument d’une commande suivante.

Propriété	Valeur
Groupe de paramètres:	Pagination Arguments

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

Propriété	Valeur
Groupe de paramètres:	Pagination Arguments

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--ids

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--name -n

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

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--subscription

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

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--ids

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--name -n

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

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--subscription

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

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--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 or JSON string>.

Propriété	Valeur
Groupe de paramètres:	Generic Update Arguments

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

Propriété	Valeur
Groupe de paramètres:	Generic Update Arguments
Valeurs acceptées:	0, 1, f, false, n, no, t, true, y, yes

--friendly-name

Nom convivial de HostPool.

--ids

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--load-balancer-type

Type de l’équilibreur de charge.

Propriété	Valeur
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é.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--personal-desktop-assignment-type

Type PersonalDesktopAssignment pour HostPool.

Propriété	Valeur
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.

Propriété	Valeur
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 <indexToRemove> OR --remove propertyToRemove.

Propriété	Valeur
Groupe de paramètres:	Generic Update Arguments

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

--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=<value>.

Propriété	Valeur
Groupe de paramètres:	Generic Update Arguments

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

Propriété	Valeur
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é StartVMOnConnect.

Propriété	Valeur
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 à l’aide de az account set -s NAME_OR_ID.

Propriété	Valeur
Groupe de paramètres:	Resource Id Arguments

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

Propriété	Valeur
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 la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

Commentaires

Cette page a-t-elle été utile ?

Partager via

az desktopvirtualization hostpool

Commandes

az desktopvirtualization hostpool create

Exemples

Paramètres obligatoires

Paramètres facultatifs

az desktopvirtualization hostpool delete

Exemples

Paramètres facultatifs

az desktopvirtualization hostpool list

Exemples

Paramètres facultatifs

az desktopvirtualization hostpool retrieve-registration-token

Exemples

Paramètres facultatifs

az desktopvirtualization hostpool show

Exemples

Paramètres facultatifs

az desktopvirtualization hostpool update

Exemples

Paramètres facultatifs

Commentaires