Guia de início rápido: criar consulta compartilhada do Gráfico de Recursos usando a CLI do Azure

Artigo
06/28/2024

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

Uma consulta compartilhada pode ser executada a partir da CLI do Azure com os comandos do recurso experimental ou você pode executar a consulta compartilhada no portal do Azure. Uma consulta compartilhada é um objeto do Azure Resource Manager ao qual você pode conceder permissão ou executar no Azure Resource Graph Explorer. Quando terminar, você poderá remover a extensão Resource Graph.

Pré-requisitos

Se 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 Resource Graph.
Um ambiente de shell Bash onde 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 consulte recursos usando o Azure Resource Graph, a extensão Resource Graph deve ser 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.

Liste as extensões e versões disponíveis:

az extension list-available --output table

Instale 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, vá para Usar e gerenciar extensões com a CLI do Azure.

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.

az login

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

Criar uma consulta partilhada

Crie um grupo de recursos e um compartilhado que resuma 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 do recurso experimental da CLI do Azure ou o portal do Azure para executar a consulta compartilhada.

Usar recurso experimental para executar consultas compartilhadas

Execute a consulta compartilhada na CLI do Azure com a {{shared-query-uri}} sintaxe em um az graph query comando. Você obtém o ID do recurso de sua consulta compartilhada e o 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 subscriptions parâmetro para limitar os resultados.

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

Executar a consulta partilhada a partir do 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.

Inicie sessão no portal do Azure.
Insira o gráfico 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, em seguida, selecione Mapa para visualizar o mapa de localização.

Também pode executar a consulta a partir do seu grupo de recursos.

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

Clean up resources (Limpar 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 Resource Graph, execute o seguinte comando:

az extension remove --name resource-graph

Para sair da sessão da CLI do Azure:

az logout

Próximos passos

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

Compreender a linguagem de consulta do Azure Resource Graph

Partilhar via