Ler em inglês

Compartilhar via

Início Rápido: Executar uma consulta do Resource Graph usando o Azure PowerShell

  • Artigo

Este início rápido descreve como executar uma consulta do Azure Resource Graph usando o módulo Az.ResourceGraph para o Azure PowerShell. O módulo é 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 para recursos em seu locatário, grupos de gerenciamento ou assinaturas.

Pré-requisitos

Instalar o módulo

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

Instalação opcional do módulo

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

  1. Verifique sua versão do PowerShellGet:

    Azure PowerShell 
    Get-Module -Name PowerShellGet

    Se você precisar atualizar, vá para PowerShellGet.

  2. Instalar o módulo :

    Azure PowerShell 
    Install-Module -Name Az.ResourceGraph -Repository PSGallery -Scope CurrentUser

    O comando instala o módulo no escopo CurrentUser. Se precisar instalar no escopo AllUsers, execute a instalação em uma sessão administrativa do PowerShell.

  3. Verifique se o módulo foi instalado:

    Azure PowerShell 
    Get-Command -Module Az.ResourceGraph -CommandType Cmdlet

    O comando exibe a versão do cmdlet Search-AzGraph e carrega o módulo em sua sessão do PowerShell.

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.

Azure PowerShell 
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 os name e type de cada recurso. Para consultar por grupo de gerenciamento ou assinatura, use os parâmetros -ManagementGroup ou -Subscription.

  1. Execute uma consulta do Azure Resource Graph usando o cmdlet Search-AzGraph:

    Azure PowerShell 
    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.

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

    Azure PowerShell 
    Search-AzGraph -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:

    Azure PowerShell 
    Search-AzGraph -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.

Se uma consulta não retornar resultados de uma assinatura à qual você já tem acesso, observe que o cmdlet Search-AzGraph tem como padrão as 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 quiser pesquisar em todas as assinaturas às quais tem acesso, defina o PSDefaultParameterValues para o cmdlet Search-AzGraph executando $PSDefaultParameterValues=@{"Search-AzGraph:Subscription"= $(Get-AzSubscription).ID}

Limpar os recursos

Para sair da sua sessão do Azure PowerShell:

Azure PowerShell 
Disconnect-AzAccount

Etapas opcionais de limpeza

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

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

Azure PowerShell 
Remove-Module -Name Az.ResourceGraph

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

Azure PowerShell 
Uninstall-Module -Name Az.ResourceGraph

Poderá ser exibida uma mensagem informando que módulo Az.ResourceGraph está sendo usado no momento. Nesse caso, você precisa 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óximas etapas

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

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