Início Rápido: Criar uma consulta compartilhada do Resource Graph usando a CLI do Azure

Artigo
12/04/2024

Este início rápido descreve como criar uma consulta compartilhada do Azure Resource Graph com a CLI do Azure e a extensão do Resource Graph. Os comandos az graph shared-query são um recurso experimental da consulta az graph.

Uma consulta partilhada pode ser executada a partir da CLI do Azure com os comandos da funcionalidade experimental, ou pode executar a consulta partilhada a partir do portal Azure. A consulta compartilhada é um objeto do Azure Resource Manager ao qual você pode conceder permissão ou o qual você pode executar no Explorador do Azure Resource Graph. Ao concluir, você pode remover a extensão do Resource Graph.

Pré-requisitos

Se você ainda não tiver uma conta do Azure, crie uma conta gratuita antes de começar.
A CLI do Azure deve ser a versão 2.22.0 ou superior para a extensão do Resource Graph.
Um ambiente de shell bash em que você pode executar comandos da CLI do Azure. Por exemplo, Git Bash em uma sessão de terminal do Visual Studio Code.

Instalar a extensão

Para permitir que a CLI do Azure faça consultas a recursos usando o Azure Resource Graph, a extensão do Resource Graph deve estar instalada. A primeira vez que você executa uma consulta com az graph um prompt é exibida para instalar a extensão. Caso contrário, use as etapas a seguir para fazer uma instalação manual.

Listar as extensões e versões disponíveis:
```
az extension list-available --output table
```
Instalar a extensão:
```
az extension add --name resource-graph
```
Verifique se a extensão foi instalada:
```
az extension list --output table
```
Exiba a sintaxe da extensão:
```
az graph query --help
```

Para obter mais informações sobre as extensões da CLI do Azure, acesse Usar e gerenciar extensões com a CLI do Azure.

Conectar-se 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 para sua assinatura. Substitua <subscriptionID> por sua ID da assinatura do Azure.

az login

# Run these commands if you have multiple subscriptions
az account list --output table
az account set --subscription <subscriptionID>

Criar uma consulta compartilhada

Crie um grupo de recursos e um compartilhado que resume a contagem de todos os recursos agrupados por local.

Crie um grupo de recursos para armazenar a consulta compartilhada do Azure Resource Graph.
```
az group create --name "demoSharedQuery" --location westus2
```

Crie a consulta compartilhada.

az graph shared-query create --name "Summarize resources by location" \
  --description "This shared query summarizes resources by location for a pinnable map graphic." \
  --graph-query "Resources | summarize count() by location" \
  --resource-group demoSharedQuery

Liste todas as consultas compartilhadas no grupo de recursos.

az graph shared-query list --resource-group demoSharedQuery

Limite os resultados a uma consulta compartilhada específica.

az graph shared-query show --resource-group "demoSharedQuery" \
  --name "Summarize resources by location"

Executar a consulta compartilhada

Você pode usar a sintaxe de recurso experimental da CLI do Azure ou o portal do Azure para executar a consulta compartilhada.

Usar o recurso experimental para executar a consulta compartilhada

Execute a consulta compartilhada na CLI do Azure com a sintaxe {{shared-query-uri}} em um comando az graph query. Você obtém a ID do recurso da consulta compartilhada e a armazena em uma variável. A variável é usada quando você executa a consulta compartilhada.

sharedqueryid=$(az graph shared-query show --resource-group "demoSharedQuery" \
  --name "Summarize resources by location" \
  --query id \
  --output tsv)

az graph query --graph-query "{{$sharedqueryid}}"

Você pode usar o parâmetro subscriptions para limitar os resultados.

az graph query --graph-query "{{$sharedqueryid}}" --subscriptions 11111111-1111-1111-1111-111111111111

Executar a consulta compartilhada no portal

Você pode verificar se a consulta compartilhada funciona usando o Azure Resource Graph Explorer. Para alterar o escopo, use o menu Escopo no lado esquerdo da página.

Entre no portal do Azure.
Insira o grafo de recursos no campo de pesquisa na parte superior da página.
Selecione Resource Graph Explorer.
Selecione Abrir consulta.
Altere Tipo para Consultas compartilhadas.
Selecione a consulta Contar VMs por SO.
Selecione Executar consulta e a saída da exibição na guia Resultados.
Selecione Gráficos e selecione Mapa para exibir o mapa de localização.

Você também pode executar a consulta em seu grupo de recursos.

No Azure, vá para o grupo de recursos, demoSharedQuery.
Na guia Visão geral, selecione a consulta Contar VMs por SO.
Selecione a guia Resultados.
Selecione Gráficos e selecione Mapa para exibir o mapa de localização.

Limpar os recursos

Para remover a consulta compartilhada:

az graph shared-query delete --name "Summarize resources by location" --resource-group demoSharedQuery

Quando um grupo de recursos é excluído, o grupo de recursos e todos os seus recursos são excluídos. Para remover o grupo de recursos:

az group delete --name demoSharedQuery

Para remover a extensão do Resource Graph, execute o seguinte comando:

az extension remove --name resource-graph

Para sair da sessão da CLI do Azure:

az logout

Próximas etapas

Neste guia de início rápido, você adicionou a extensão do Resource Graph ao ambiente da CLI do Azure e criou uma consulta compartilhada. Para saber mais sobre a linguagem do Resource Graph, prossiga para a página de detalhes da linguagem de consulta.

Noções básicas sobre a linguagem de consulta do Azure Resource Graph

Compartilhar via