Usar a CLI do Azure e o Azure PowerShell com a Área de Trabalho Virtual do Azure

Há uma extensão da CLI do Azure e um módulo do Azure PowerShell para a Área de Trabalho Virtual do Azure que você pode usar para criar, atualizar, excluir e interagir com objetos de serviço da Área de Trabalho Virtual do Azure como alternativas ao uso do portal do Azure. Eles fazem parte da CLI do Azure e do Azure PowerShell, que abrangem uma ampla gama de serviços do Azure.

Este artigo explica como você pode usar a extensão da CLI do Azure e um módulo do Azure PowerShell e fornece alguns comandos de exemplo úteis.

Extensão da CLI do Azure e módulo do Azure PowerShell

Aqui estão os nomes da extensão da CLI do Azure e do módulo do Azure PowerShell e links para nossa documentação de referência:

• CLI do Azure: az desktopvirtualization

• Azure PowerShell: Az.DesktopVirtualization

A CLI do Azure e o Azure PowerShell estão disponíveis para uso no Azure Cloud Shell nativamente no portal do Azure sem instalação, ou você pode instalá-los localmente em seu dispositivo para Windows, macOS e Linux.

Para saber como instalar a CLI do Azure e o Azure PowerShell em todas as plataformas suportadas, consulte os seguintes links:

• CLI do Azure: Como instalar a CLI do Azure

• Azure PowerShell: Instalar o módulo Azure Az PowerShell

Comandos de exemplo

Aqui estão alguns comandos de exemplo que você pode usar para obter informações e valores sobre seus recursos da Área de Trabalho Virtual do Azure que você pode achar úteis. Selecione a guia relevante para o seu cenário.

CLI do Azure

Importante

Nos exemplos a seguir, você precisará alterar os valores para os <placeholder> seus próprios.

Regiões disponíveis do Azure

Ao criar objetos de serviço da Área de Trabalho Virtual do Azure usando qualquer um dos comandos da CLI que contêm create, você precisa especificar a região do Azure na qual deseja criá-los. Para localizar o nome da região do Azure a ser usada com o parâmetro, execute o --location seguinte comando e use um valor da Location coluna:

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

Recuperar a ID do objeto de um pool de hosts, espaço de trabalho, grupo de aplicativos ou aplicativo

• Para recuperar a ID do objeto de um pool de hosts, execute o seguinte comando:

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

• Para recuperar a ID do objeto de um espaço de trabalho, execute o seguinte comando:

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

• Para recuperar a ID do objeto de um grupo de aplicativos, execute o seguinte comando:

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

Gorjeta

A extensão da CLI do Azure para a Área de Trabalho Virtual do Azure não tem comandos para aplicativos. Use o Azure PowerShell em vez disso.

Azure PowerShell

Importante

Nos exemplos a seguir, você precisará alterar os valores para os <placeholder> seus próprios.

Regiões disponíveis do Azure

Ao criar objetos de serviço da Área de Trabalho Virtual do Azure usando qualquer um dos cmdlets do PowerShell que começam New-AzWvd..., você precisa especificar a região do Azure na qual deseja criá-los. Para localizar o nome da região do Azure a ser usada com o parâmetro, execute o -Location seguinte comando e use um valor da Location coluna:

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

Recuperar a ID do objeto de um pool de hosts, espaço de trabalho, grupo de aplicativos ou aplicativo

Alguns cmdlets do PowerShell exigem que você forneça a ID do objeto dos objetos de serviço da Área de Trabalho Virtual do Azure. Seguem-se alguns exemplos:

• Para recuperar a ID do objeto de um pool de hosts, execute o seguinte comando:

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

• Para recuperar a ID do objeto de um espaço de trabalho, execute o seguinte comando:

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

• Para recuperar a ID do objeto de um grupo de aplicativos, execute o seguinte comando:

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

• Para recuperar a ID do objeto de um aplicativo da área de trabalho, execute o seguinte comando:

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

• Para recuperar as IDs de objeto de todos os aplicativos RemoteApp em um grupo de aplicativos, execute o seguinte comando:

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

Próximos passos

Agora que você sabe como usar a CLI do Azure e o Azure PowerShell com a Área de Trabalho Virtual do Azure, aqui estão alguns artigos que os usam:

• Criar um conjunto de anfitriões do Azure Virtual Desktop com o PowerShell ou a CLI do Azure
• Gerenciar grupos de aplicativos usando o PowerShell ou a CLI do Azure
• Para obter a documentação de referência completa do PowerShell, consulte Az.DesktopVirtualization.