Udostępnij za pośrednictwem

Szybki start: uruchamianie zapytania usługi Resource Graph przy użyciu interfejsu API REST

  • Artykuł

W tym przewodniku Szybki start opisano sposób uruchamiania zapytania usługi Azure Resource Graph przy użyciu interfejsu API REST i wyświetlania wyników. Elementy interfejsu API REST to identyfikator URI, który zawiera wersję interfejsu API i treść żądania zawierającą zapytanie. W przykładach użyto interfejsu wiersza polecenia platformy Azure do zalogowania się na platformie Azure i uwierzytelnienia konta w celu uruchamiania az rest poleceń.

Jeśli jeszcze nie znasz interfejsu API REST, zacznij od przejrzenia dokumentacji interfejsu API REST platformy Azure, aby uzyskać ogólny opis interfejsu API REST, a w szczególności identyfikatora URI żądania i treści żądania. Aby uzyskać specyfikacje usługi Azure Resource Graph, zobacz Interfejs API REST usługi Azure Resource Graph.

Wymagania wstępne

Łączenie się z platformą Azure

Z poziomu sesji terminalu programu Visual Studio Code nawiąż połączenie z platformą Azure. Jeśli masz więcej niż jedną subskrypcję, uruchom polecenia, aby ustawić kontekst na subskrypcję. Zamień wartość {subscriptionID} na identyfikator swojej subskrypcji platformy Azure.

az login

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

Użyj az login polecenia az rest, nawet jeśli używasz programu PowerShell, ponieważ w przykładach użyto poleceń az rest interfejsu wiersza polecenia platformy Azure.

Przejrzyj składnię interfejsu API REST

Istnieją dwa elementy do uruchamiania poleceń interfejsu API REST: identyfikator URI interfejsu API REST i treść żądania. Aby uzyskać informacje, przejdź do obszaru Zasoby. Aby wykonywać zapytania według grupy zarządzania, użyj polecenia managementGroups zamiast subscriptions. Aby wysłać zapytanie do całej dzierżawy, pomiń właściwości managementGroups i subscriptions z treści żądania.

Poniższy przykład przedstawia składnię identyfikatora URI interfejsu API REST w celu uruchomienia zapytania dotyczącego subskrypcji platformy Azure.

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2022-10-01

Treść żądania jest wymagana do uruchomienia zapytania za pomocą interfejsu API REST. Poniższy przykład to kod JSON umożliwiający utworzenie pliku treści żądania.

{
  "subscriptions": [
    "{subscriptionID}"
  ],
  "query": "Resources | project name, type | limit 5"
}

Uruchamianie zapytania usługi Resource Graph

W przykładach użyto tego samego az rest polecenia, ale zmienisz treść żądania, aby uzyskać różne wyniki. Przykłady zawierają listę zasobów, zamawianie zasobów według name właściwości i zamawianie zasobów według name właściwości oraz ograniczanie liczby wyników.

Aby uruchomić wszystkie przykłady zapytań, użyj następującego az rest polecenia dla środowiska powłoki:

az rest --method post --uri https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2022-10-01 --body `@request-body.json

W programie PowerShell backtick (`) jest wymagany do ucieczki at sign (@) w celu określenia nazwy pliku treści żądania.

W każdym przykładzie treści żądania zastąp {subscriptionID} ciąg identyfikatorem subskrypcji platformy Azure. Uruchom następujące polecenie, aby uzyskać identyfikator subskrypcji platformy Azure dla treści żądania:

az account show --query id --output tsv

Wyświetlanie listy zasobów

W programie Visual Studio Code utwórz nowy plik o nazwie request-body.json. Skopiuj i wklej następujący kod JSON do pliku i zapisz go.

Zapytanie zwraca pięć zasobów platformy Azure z elementami name i resource type każdego zasobu.

{
  "subscriptions": [
    "{subscriptionID}"
  ],
  "query": "Resources | project name, type | limit 5"
}

Ponieważ ten przykład zapytania nie udostępnia modyfikatora sortowania, takiego jak order by, uruchomienie tego zapytania wielokrotnie daje inny zestaw zasobów na żądanie.

Właściwość Order by name

Zaktualizuj request-body.json przy użyciu następującego kodu, który zmienia zapytanie na order by name właściwość. Zapisz plik i użyj polecenia , az rest aby uruchomić zapytanie.

{
  "subscriptions": [
    "{subscriptionID}"
  ],
  "query": "Resources | project name, type | limit 5 | order by name asc"
}

Jeśli uruchamiasz to zapytanie wielokrotnie, zwraca on inny zestaw zasobów na żądanie.

Kolejność poleceń zapytania jest ważna. W tym przykładzie polecenie order by następuje po poleceniu limit. To polecenie ogranicza wyniki zapytania do pięciu zasobów, a następnie je porządkuje.

Order by name property and limit results (Kolejność według właściwości i ograniczeń wyników)

Zaktualizuj request-body.json przy użyciu następującego kodu do order by name właściwości, a następnie limit do pięciu pierwszych wyników. Zapisz plik i użyj tego samego az rest polecenia, aby uruchomić zapytanie.

{
  "subscriptions": [
    "{subscriptionID}"
  ],
  "query": "Resources | project name, type | order by name asc | limit 5"
}

Jeśli zapytanie jest uruchamiane kilka razy, przy założeniu, że nic w środowisku się nie zmieniło, zwracane wyniki są spójne i uporządkowane przez name właściwość, ale ograniczone do pięciu pierwszych wyników.

Czyszczenie zasobów

Wyloguj się z sesji interfejsu wiersza polecenia platformy Azure.

az logout

Następne kroki

W tym przewodniku Szybki start użyto punktu końcowego interfejsu API REST usługi Azure Resource Graph do uruchomienia zapytania. Aby dowiedzieć się więcej na temat języka usługi Resource Graph, przejdź do strony szczegółów języka zapytań.

Omówienie języka zapytań usługi Azure Resource Graph