Início Rápido: Execute a primeira consulta ao Resource Graph usando o Azure PowerShell

Artigo
04/24/2023

A primeira etapa para usar o Azure Resource Graph é garantir que o módulo do Azure PowerShell esteja instalado. Este início rápido orienta você pelo processo de adicionar o módulo à instalação do Azure PowerShell.

No final desse processo, você terá adicionado o módulo à instalação do Azure PowerShell de preferência e executado sua primeira consulta ao Resource Graph.

Pré-requisitos

Se você não tiver uma assinatura do Azure, crie uma conta gratuita antes de começar.

Azure Cloud Shell

O Azure hospeda o Azure Cloud Shell, um ambiente de shell interativo que pode ser usado por meio do navegador. É possível usar o bash ou o PowerShell com o Cloud Shell para trabalhar com os serviços do Azure. É possível usar os comandos pré-instalados do Cloud Shell para executar o código neste artigo, sem precisar instalar nada no seu ambiente local.

Para iniciar o Azure Cloud Shell:

Opção	Exemplo/Link
Selecione Experimentar no canto superior direito de um bloco de código ou de comando. Selecionar Experimentar não copia automaticamente o código nem o comando para o Cloud Shell.
Acesse https://shell.azure.com ou selecione o botão Iniciar o Cloud Shell para abri-lo no navegador.
Selecione o botão Cloud Shell na barra de menus no canto superior direito do portal do Azure.

Para usar o Azure Cloud Shell:

Inicie o Cloud Shell.
Selecione o botão Copiar em um bloco de código (ou bloco de comando) para copiar o código ou o comando.
Cole o código ou comando na sessão do Cloud Shell selecionando Ctrl+Shift+V no Windows e no Linux, ou selecionando Cmd+Shift+V no macOS.
Selecione Enter para executar o código ou o comando.

Adicionar o módulo do Resource Graph

Para habilitar o Azure PowerShell para consultar o Azure Resource Graph, o módulo precisa ser adicionado. Esse módulo pode ser usado com o PowerShell instalado localmente, com o Azure Cloud Shell ou com a imagem do Docker do PowerShell.

Requisitos base

O módulo Gráfico de Recursos do Azure requer o seguinte software:

Azure PowerShell 1.0.0 ou superior. Se ainda não estiver instalado, siga estas instruções.
PowerShellGet 2.0.1 ou superior. Se ele não estiver instalado ou atualizado, siga estas instruções.

Instalar o módulo

O módulo Azure Resource Graph para o PowerShell é Az.ResourceGraph.

De um prompt administrativo do PowerShell, execute o comando a seguir:

# Install the Resource Graph module from PowerShell Gallery
Install-Module -Name Az.ResourceGraph

Confirme se o módulo foi importado e é, no mínimo, a versão 0.11.0:

# Get a list of commands for the imported Az.ResourceGraph module
Get-Command -Module 'Az.ResourceGraph' -CommandType 'Cmdlet'

Executar a primeira consulta ao Resource Graph

Com o módulo do Azure PowerShell adicionado ao seu ambiente de preferência, é hora de experimentar uma consulta simples do Resource Graph com base em locatário. A consulta retorna os cinco primeiros recursos do Azure com o Nome e o Tipo de Recurso de cada um. Para consultar por grupo de gerenciamento ou assinatura, use os parâmetros -ManagementGroup ou -Subscription.

Execute a primeira consulta ao Azure Resource Graph usando o cmdlet Search-AzGraph:
```
# Login first with Connect-AzAccount if not using Cloud Shell

# Run Azure Resource Graph query
Search-AzGraph -Query 'Resources | project name, type | limit 5'
```
Observação

Por essa consulta de exemplo não fornecer um modificador de classificação, como order by, executar essa consulta várias vezes provavelmente produzirá um conjunto diferente de recursos por solicitação.
Atualizar a consulta para order by a propriedade Name:
```
# Run Azure Resource Graph query with 'order by'
Search-AzGraph -Query 'Resources | project name, type | limit 5 | order by name asc'
```
Observação

Assim como ocorre com a primeira consulta, executar esta consulta várias vezes provavelmente produzirá um conjunto diferente de recursos por solicitação. A ordem dos comandos de consulta é importante. Neste exemplo, o order by vem após o limit. Essa ordem de comando limita primeiro os resultados da consulta e os ordena.

Atualize a consulta para, primeiro, order by a propriedade Name e depois limit conforme os primeiros cinco resultados:

# Store the query in a variable
$query = 'Resources | project name, type | order by name asc | limit 5'

# Run Azure Resource Graph query with `order by` first, then with `limit`
Search-AzGraph -Query $query

Quando a consulta final for executada várias vezes, supondo que nada em seu ambiente seja alterado, os resultados retornados serão consistentes e ordenados segundo a propriedade Name, mas ainda limitados aos cinco primeiros resultados.

Observação

Se a consulta não retornar resultados de uma assinatura à qual você já tenha acesso, observe que o cmdlet Search-AzGraph é padronizado para assinaturas no contexto padrão. Para ver a lista de IDs de assinatura que fazem parte do contexto padrão, execute isso (Get-AzContext).Account.ExtendedProperties.Subscriptions Se você deseja pesquisar em todas as assinaturas às quais você tem acesso, é possível definir PSDefaultParameterValues para o cmdlet Search-AzGraph executando $PSDefaultParameterValues=@{"Search-AzGraph:Subscription"= $(Get-AzSubscription).ID}

Limpar os recursos

Se quiser remover o módulo do Resource Graph do seu ambiente do Azure PowerShell, você poderá fazer isso usando o comando a seguir:

# Remove the Resource Graph module from the current session
Remove-Module -Name 'Az.ResourceGraph'

# Uninstall the Resource Graph module from the environment
Uninstall-Module -Name 'Az.ResourceGraph'

Observação

Isso não exclui o arquivo de módulo baixado anteriormente. Isso apenas o remove da sessão do PowerShell em execução.

Próximas etapas

Neste início rápido, você adicionou o módulo do Resource Graph ao seu ambiente de Azure PowerShell e executou sua primeira consulta. Para saber mais sobre a linguagem do Resource Graph, prossiga para a página de detalhes da linguagem de consulta.

Obter mais informações sobre a linguagem de consulta