Guia de início rápido: executar a consulta do Gráfico de Recursos usando o Azure PowerShell

Artigo
06/28/2024

Este guia de início rápido descreve como executar uma consulta do Gráfico de Recursos do Azure usando o módulo para o Az.ResourceGraph Azure PowerShell. O módulo está incluído com a versão mais recente do Azure PowerShell e adiciona cmdlets para o Resource Graph.

O artigo também mostra como ordenar (classificar) e limitar os resultados da consulta. Você pode executar uma consulta de recursos em seu locatário, grupos de gerenciamento ou assinaturas.

Pré-requisitos

Se não tiver uma conta do Azure, crie uma conta gratuita antes de começar.
Versões mais recentes do PowerShell e do Azure PowerShell.
Visual Studio Code.

Instalar o módulo

Se você instalou as versões mais recentes do PowerShell e do Azure PowerShell, já tem o módulo e a Az.ResourceGraph versão necessária do PowerShellGet.

Instalação opcional do módulo

Use as etapas a seguir para instalar o módulo para que você possa usar o Az.ResourceGraph Azure PowerShell para executar consultas do Azure Resource Graph. O módulo Azure Resource Graph requer o PowerShellGet versão 2.0.1 ou superior.

Verifique sua versão do PowerShellGet:
```
Get-Module -Name PowerShellGet
```
Se você precisar atualizar, vá para PowerShellGet.
Instale o módulo:
```
Install-Module -Name Az.ResourceGraph -Repository PSGallery -Scope CurrentUser
```
O comando instala o CurrentUser módulo no escopo. Se você precisar instalar no AllUsers escopo, execute a instalação a partir de uma sessão administrativa do PowerShell.
Verifique se o módulo foi instalado:
```
Get-Command -Module Az.ResourceGraph -CommandType Cmdlet
```
O comando exibe a versão do Search-AzGraph cmdlet e carrega o módulo em sua sessão do PowerShell.

Ligar ao Azure

Em uma sessão de terminal do Visual Studio Code, conecte-se ao Azure. Se você tiver mais de uma assinatura, execute os comandos para definir o contexto da sua assinatura. Substitua <subscriptionID> pelo seu ID da subscrição do Azure.

Connect-AzAccount

# Run these commands if you have multiple subscriptions
Get-AzSubScription
Set-AzContext -Subscription <subscriptionID>

Executar uma consulta

Depois que o módulo for adicionado ao seu ambiente, você poderá executar uma consulta baseada em locatário. A consulta neste exemplo retorna cinco recursos do Azure com o name e type de cada recurso. Para consultar por grupo de gerenciamento ou assinatura, use os -ManagementGroup parâmetros ou -Subscription .

Execute uma consulta do Azure Resource Graph usando o Search-AzGraph cmdlet:
```
Search-AzGraph -Query 'Resources | project name, type | limit 5'
```
Este exemplo de consulta não usa um modificador de classificação como order by. Se você executar a consulta várias vezes, ela poderá gerar um conjunto diferente de recursos para cada solicitação.
Atualize a consulta para order by a name propriedade:
```
Search-AzGraph -Query 'Resources | project name, type | limit 5 | order by name asc'
```
Como a consulta anterior, se você executar essa consulta várias vezes pode gerar um conjunto diferente de recursos para cada solicitação. A ordem dos comandos da consulta é importante. Neste exemplo, order by vem depois de limit, A consulta limita os resultados a cinco recursos e, em seguida, ordena esses resultados pelo nome.
Atualize a consulta para order by a name propriedade e, em seguida, limit a saída para cinco resultados:
```
Search-AzGraph -Query 'Resources | project name, type | order by name asc | limit 5'
```
Se essa consulta for executada name várias vezes sem alterações no seu ambiente, os resultados serão consistentes e ordenados pela propriedade, mas ainda limitados a cinco resultados. A consulta ordena os resultados por nome e, em seguida, limita a saída a cinco recursos.

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

Clean up resources (Limpar recursos)

Para sair da sessão do Azure PowerShell:

Disconnect-AzAccount

Etapas de limpeza opcionais

Se você instalou a versão mais recente do Azure PowerShell, o Az.ResourceGraph módulo está incluído e não deve ser removido. As etapas a seguir são opcionais se você fez uma instalação manual do Az.ResourceGraph módulo e deseja remover o módulo.

Para remover o Az.ResourceGraph módulo da sessão do PowerShell, execute o seguinte comando:

Remove-Module -Name Az.ResourceGraph

Para desinstalar o Az.ResourceGraph módulo do computador, execute o seguinte comando:

Uninstall-Module -Name Az.ResourceGraph

Pode ser exibida uma mensagem informando que o módulo Az.ResourceGraph está em uso no momento. Em caso afirmativo, você precisará encerrar sua sessão do PowerShell e iniciar uma nova sessão. Em seguida, execute o comando para desinstalar o módulo do seu computador.

Próximos passos

Neste início rápido, você adicionou o módulo Gráfico de Recursos ao seu ambiente do Azure PowerShell e executou uma consulta. Para saber mais, vá para a página de detalhes do idioma da consulta.

Compreender a linguagem de consulta do Azure Resource Graph

Partilhar via