Utiliser Azure CLI et Azure PowerShell avec Azure Virtual Desktop

Il existe une extension Azure CLI et un module Azure PowerShell pour Azure Virtual Desktop que vous pouvez utiliser pour créer, mettre à jour, supprimer et interagir avec des objets de service Azure Virtual Desktop en guise d’alternatives à l’utilisation du Portail Azure. Ils font partie d’Azure CLI et d’Azure PowerShell, qui couvrent un large éventail de services Azure.

Cet article explique comment utiliser l’extension Azure CLI et un module Azure PowerShell, et fournit des exemples de commandes utiles.

Extension Azure CLI et module Azure PowerShell

Voici les noms de l’extension Azure CLI et du module Azure PowerShell, ainsi que des liens vers notre documentation de référence :

• Azure CLI : az desktopvirtualization

• Azure PowerShell : Az.DesktopVirtualization

Azure CLI et Azure PowerShell peuvent être utilisés dans Azure Cloud Shell en mode natif dans le Portail Azure sans installation, ou vous pouvez les installer localement sur votre appareil pour Windows, macOS et Linux.

Pour savoir comment installer Azure CLI et Azure PowerShell sur toutes les plateformes prises en charge, consultez les liens suivants :

• Azure CLI : Installation de l’interface de ligne de commande Azure

• Azure PowerShell : Installer le module PowerShell Azure Az

Exemple de commandes

Voici quelques exemples de commandes que vous pouvez utiliser pour obtenir des informations et des valeurs sur vos ressources Azure Virtual Desktop que vous pourriez trouver utiles. Sélectionnez l’onglet approprié pour votre scénario.

Azure CLI

Important

Dans les exemples suivants, vous devez remplacer les valeurs <placeholder> par les vôtres.

Régions Azure disponibles

Lorsque vous créez des objets de service Azure Virtual Desktop à l’aide de l’une des commandes CLI qui contiennent create, vous devez spécifier la région Azure dans laquelle vous souhaitez les créer. Pour trouver le nom de la région Azure à utiliser avec le paramètre --location, exécutez la commande suivante et utilisez une valeur de la colonne Location :

az account list-locations --query "sort_by([].{DisplayName:displayName, Location:name}, &Location)" -o table

Récupérer l’ID d’objet d’un pool d’hôtes, d’un espace de travail, d’un groupe d’applications ou d’une application

• Pour récupérer l’ID d’objet d’un pool d’hôtes, exécutez la commande suivante :

  az desktopvirtualization hostpool show \
       --name <Name> \
       --resource-group <ResourceGroupName> \
       --query objectId 
       --output tsv
  

• Pour récupérer l’ID d’objet d’un espace de travail, exécutez la commande suivante :

  az desktopvirtualization workspace show \
       --name <Name> \
       --resource-group <ResourceGroupName> \
       --query objectId 
       --output tsv
  

• Pour récupérer l’ID d’objet d’un groupe d’applications, exécutez la commande suivante :

  az desktopvirtualization applicationgroup show \
       --name <Name> \
       --resource-group <ResourceGroupName> \
       --query objectId 
       --output tsv
  

Conseil

L’extension Azure CLI pour Azure Virtual Desktop n’a pas de commandes pour les applications. Utilisez plutôt PowerShell.

Azure PowerShell

Important

Dans les exemples suivants, vous devez remplacer les valeurs <placeholder> par les vôtres.

Régions Azure disponibles

Lorsque vous créez des objets de service Azure Virtual Desktop à l’aide de l’une des cmdlets PowerShell qui commencent par New-AzWvd..., vous devez spécifier la région Azure dans laquelle vous souhaitez les créer. Pour trouver le nom de la région Azure à utiliser avec le paramètre -Location, exécutez la commande suivante et utilisez une valeur de la colonne Location :

Get-AzLocation | Sort-Object DisplayName | FT DisplayName, Location

Récupérer l’ID d’objet d’un pool d’hôtes, d’un espace de travail, d’un groupe d’applications ou d’une application

Certaines cmdlets PowerShell vous obligent à fournir l’ID d’objet des objets de service Azure Virtual Desktop. Voici quelques exemples :

• Pour récupérer l’ID d’objet d’un pool d’hôtes, exécutez la commande suivante :

  (Get-AzWvdHostPool -Name <HostPoolName> -ResourceGroupName <ResourceGroupName>).ObjectId
  

• Pour récupérer l’ID d’objet d’un espace de travail, exécutez la commande suivante :

  (Get-AzWvdWorkspace -Name <WorkspaceName> -ResourceGroupName <ResourceGroupName>).ObjectID
  

• Pour récupérer l’ID d’objet d’un groupe d’applications, exécutez la commande suivante :

  (Get-AzWvdApplicationGroup -Name <ApplicationGroupName> -ResourceGroupName <ResourceGroupName>).ObjectId
  

• Pour récupérer l’ID d’objet d’une application de bureau, exécutez la commande suivante :

  (Get-AzWvdDesktop -Name <DesktopName> -ApplicationGroupName <ApplicationGroupName> -ResourceGroupName <ResourceGroupName>).ObjectId
  

• Pour récupérer les ID d’objet de toutes les applications RemoteApp dans un groupe d’applications, exécutez la commande suivante :

  Get-AzWvdApplication -ApplicationGroupName <ApplicationGroupName> -ResourceGroupName <ResourceGroupName> | Select-Object Name, FilePath, ObjectId
  

Étapes suivantes

Maintenant que vous savez comment utiliser Azure CLI et Azure PowerShell avec Azure Virtual Desktop, voici quelques articles qui les utilisent :

• Créer un pool d’hôtes Azure Virtual Desktop avec PowerShell ou Azure CLI
• Gérer des groupes d’applications avec PowerShell ou Azure CLI
• Pour obtenir la documentation de référence PowerShell complète, consultez Az.DesktopVirtualization.