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ê poderá usar para criar, atualizar, excluir e interagir com os 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 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

A seguir, são apresentados os nomes da extensão da CLI do Azure e do módulo do Azure PowerShell e os links para nossa documentação de referência:

• CLI do Azure: az desktopvirtualization

• Azure PowerShell: Az.DesktopVirtualization

Tanto a CLI do Azure quanto o Azure PowerShell estão disponíveis para uso no Azure Cloud Shell nativamente no portal do Azure sem nenhuma instalação ou você poderá instalá-los localmente no dispositivo para Windows, macOS e Linux.

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

• Azure CLI: Como instalar a CLI do Azure

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

Comandos de exemplo

A seguir, estão alguns comandos de exemplo que poderão ser usados para você obter as informações e os valores sobre os recursos da Área de Trabalho Virtual do Azure que achar úteis. Selecione a guia relevante ao seu cenário.

CLI do Azure

Importante

Nos exemplos a seguir, será necessário alterar os valores de <placeholder> para os seus próprios.

Regiões do Azure disponíveis

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

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

Recuperar a ID de objeto de um pool de host, workspace, grupo de aplicativos ou aplicativo

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

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

• Para recuperar a ID de objeto de um workspace, execute o seguinte comando:

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

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

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

Dica

Não há comandos para aplicativos da extensão da CLI do Azure para a Área de Trabalho Virtual do Azure. Em vez disso, use o Azure PowerShell.

PowerShell do Azure

Importante

Nos exemplos a seguir, será necessário alterar os valores de <placeholder> para os seus próprios.

Regiões do Azure disponíveis

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

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

Recuperar a ID de objeto de um pool de host, workspace, grupo de aplicativos ou aplicativo

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

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

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

• Para recuperar a ID de objeto de um workspace, execute o seguinte comando:

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

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

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

• Para recuperar o ID de 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óximas etapas

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

• Criar um pool de host na Área de Trabalho Virtual do Azure com 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.