Guia de início rápido: executar a consulta do Gráfico de Recursos usando a API REST
Este guia de início rápido descreve como executar uma consulta do Azure Resource Graph com a API REST e exibir os resultados. Os elementos da API REST são um URI que inclui a versão da API e o corpo da solicitação que contém a consulta. Os exemplos usam a CLI do Azure para entrar no Azure e isso autentica sua conta para executar az rest comandos.
Se não estiver familiarizado com a API REST, comece por rever a Referência da API REST do Azure para obter uma compreensão geral da API REST, especificamente o URI do pedido e o corpo do pedido. Para obter as especificações do Azure Resource Graph, consulte Azure Resource Graph REST API.
Pré-requisitos
- Se não tiver uma conta do Azure, crie uma conta gratuita antes de começar.
- Versão mais recente do PowerShell ou shell Bash como Git Bash.
- Versão mais recente da CLI do Azure.
- Visual Studio Code.
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}
Use az login mesmo se estiver usando o PowerShell porque os exemplos usam comandos azur CLI az rest .
Revise a sintaxe da API REST
Há dois elementos para executar comandos da API REST: o URI DA API REST e o corpo da solicitação. Para obter informações, vá para Recursos. Para consultar por grupo de gerenciamento, use managementGroups em vez de subscriptions. Para consultar o locatário inteiro, omita as managementGroups propriedades e subscriptions do corpo da solicitação.
O exemplo a seguir mostra a sintaxe URI DA API REST para executar uma consulta para uma assinatura do Azure.
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2022-10-01
Um corpo de solicitação é necessário para executar uma consulta com a API REST. O exemplo a seguir é o JSON para criar um arquivo de corpo de solicitação.
{
"subscriptions": [
"{subscriptionID}"
],
"query": "Resources | project name, type | limit 5"
}
Executar consulta do Gráfico de Recursos
Os exemplos usam o mesmo az rest comando, mas você altera o corpo da solicitação para obter resultados diferentes. Os exemplos listam recursos, ordenam recursos name pela propriedade e ordenam recursos pela name propriedade e limitam o número de resultados.
Para executar todos os exemplos de consulta, use o seguinte az rest comando para seu ambiente de shell:
az rest --method post --uri https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2022-10-01 --body `@request-body.json
No PowerShell, o backtick (`) é necessário para escapar do at sign (@) para especificar um nome de arquivo para o corpo da solicitação.
Em cada exemplo de corpo de solicitação, substitua {subscriptionID} por sua ID de assinatura do Azure. Execute o seguinte comando para obter sua ID de assinatura do Azure para o corpo da solicitação:
az account show --query id --output tsv
Listar recursos
No Visual Studio Code, crie um novo arquivo chamado request-body.json. Copie e cole o JSON a seguir no arquivo e salve-o.
A consulta retorna cinco recursos do Azure com o name e resource type de cada recurso.
{
"subscriptions": [
"{subscriptionID}"
],
"query": "Resources | project name, type | limit 5"
}
Como este exemplo de consulta não fornece um modificador de classificação como order by, a execução dessa consulta várias vezes produz um conjunto diferente de recursos por solicitação.
Propriedade Ordenar por nome
Atualize request-body.json com o código a seguir que altera a consulta para order by a name propriedade. Salve o arquivo e use o az rest comando para executar a consulta.
{
"subscriptions": [
"{subscriptionID}"
],
"query": "Resources | project name, type | limit 5 | order by name asc"
}
Se você executar essa consulta várias vezes, ela produzirá um conjunto diferente de recursos por solicitação.
A ordem dos comandos da consulta é importante. Neste exemplo, order by vem depois de limit, Esta ordem de comandos limita os resultados da consulta a cinco recursos e, em seguida, ordena-os.
Ordenar por nome propriedade e limitar resultados
Atualize request-body.json com o seguinte código para order by a name propriedade e, em seguida, limit para os cinco principais resultados. Salve o arquivo e use o mesmo az rest comando para executar a consulta.
{
"subscriptions": [
"{subscriptionID}"
],
"query": "Resources | project name, type | order by name asc | limit 5"
}
Se a consulta for executada name várias vezes, supondo que nada em seu ambiente tenha mudado, os resultados retornados serão consistentes e ordenados pela propriedade, mas limitados aos cinco principais resultados.
Clean up resources (Limpar recursos)
Saia da sua sessão da CLI do Azure.
az logout
Próximos passos
Neste início rápido, você usou o ponto de extremidade da API REST do Azure Resource Graph para executar uma consulta. Para saber mais sobre a linguagem do Gráfico de Recursos, continue para a página de detalhes do idioma da consulta.