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

Esse início rápido descreve como executar uma consulta do Azure Resource Graph usando a CLI do Azure e a extensão do Resource Graph. O artigo também mostra como ordenar (classificar) e limitar os resultados da consulta. Você pode executar uma consulta para recursos em seu locatário, grupos de gerenciamento ou assinaturas. Quando terminar, você poderá remover a extensão.

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 do Bash no qual você pode executar comandos da CLI do Azure. Por exemplo, o Bash do Git em uma sessão de terminal do Visual Studio Code.

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>

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. Da primeira vez que você executa uma consulta com o az graph, aparece uma solicitação para você instalar a extensão. Se isso não ocorrer, use as etapas a seguir para fazer uma instalação manual.

  1. Listar as extensões e versões disponíveis:

    az extension list-available --output table
    
  2. Instalar a extensão:

    az extension add --name resource-graph
    
  3. Verifique se a extensão foi instalada:

    az extension list --output table
    
  4. 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.

Executar uma consulta

Depois que a extensão da CLI do Azure for adicionada ao seu ambiente, você poderá executar uma consulta baseada em locatário. A consulta neste exemplo retorna cinco recursos do Azure com os name e type de cada recurso. Para consultar por grupo de gerenciamento ou assinatura, use os argumentos --management-groups ou --subscriptions.

  1. Executar uma consulta do Azure Resource Graph:

    az graph query --graph-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.

  2. Atualize a consulta para order by a propriedade name:

    az graph query --graph-query 'Resources | project name, type | limit 5 | order by name asc'
    

    Como na consulta anterior, se você executar essa consulta várias vezes, poderá obter um conjunto diferente de recursos para cada solicitação. A ordem dos comandos de consulta é importante. Neste exemplo, o order by vem após o limit. A consulta limita os resultados a cinco recursos e, em seguida, ordena esses resultados por nome.

  3. Atualize a consulta para order by a propriedade name e, em seguida, limit a saída para cinco resultados:

    az graph query --graph-query 'Resources | project name, type | order by name asc | limit 5'
    

    Se essa consulta for executada várias vezes sem alterações em seu ambiente, os resultados serão consistentes e ordenados pela propriedade name, mas ainda limitados a cinco resultados. A consulta ordena os resultados por nome e, em seguida, limita a saída a cinco recursos.

Limpar os recursos

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 início rápido, você executou consultas do Azure Resource Graph usando a extensão para a CLI do Azure. Para saber mais, acesse o artigo sobre os detalhes da linguagem de consulta.