Rychlý start: Spuštění dotazu Resource Graphu pomocí rozhraní REST API
Tento rychlý start popisuje, jak spustit dotaz Azure Resource Graphu pomocí rozhraní REST API a zobrazit výsledky. Elementy rozhraní REST API jsou identifikátor URI, který obsahuje verzi rozhraní API a text požadavku, který obsahuje dotaz. Příklady používají Azure CLI k přihlášení k Azure a ověření vašeho účtu ke spouštění az rest příkazů.
Pokud rozhraní REST API neznáte, nejprve si přečtěte referenční informace k rozhraní Azure REST API, kde najdete obecný přehled rozhraní REST API, zejména identifikátoru URI požadavku a textu požadavku. Specifikace Azure Resource Graphu najdete v tématu Rozhraní REST API služby Azure Resource Graph.
Požadavky
- Pokud nemáte účet Azure, vytvořte si bezplatný účet před tím, než začnete.
- Nejnovější verze PowerShellu nebo prostředí Bash, jako je Git Bash.
- Nejnovější verze Azure CLI
- Visual Studio Code.
Připojení k Azure
Z relace terminálu editoru Visual Studio Code se připojte k Azure. Pokud máte více než jedno předplatné, spusťte příkazy pro nastavení kontextu pro vaše předplatné. {subscriptionID} nahraďte ID vašeho předplatného Azure.
az login
# Run these commands if you have multiple subscriptions
az account list --output table
az account set --subscription {subscriptionID}
Použijte az login , i když používáte PowerShell, protože příklady používají Azure CLI az rest commands.
Kontrola syntaxe rozhraní REST API
Ke spuštění příkazů rozhraní REST API existují dva prvky: identifikátor URI rozhraní REST API a text požadavku. Informace najdete v části Zdroje. Pokud chcete dotazovat podle skupiny pro správu, použijte managementGroups místo subscriptions. Pokud chcete dotazovat celého tenanta, v textu požadavku vynecháte vlastnosti managementGroups i subscriptions vlastnosti.
Následující příklad ukazuje syntaxi identifikátoru URI rozhraní REST API pro spuštění dotazu pro předplatné Azure.
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2022-10-01
K spuštění dotazu s rozhraním REST API je potřeba text požadavku. Následující příklad je JSON pro vytvoření základního souboru požadavku.
{
"subscriptions": [
"{subscriptionID}"
],
"query": "Resources | project name, type | limit 5"
}
Spuštění dotazu Resource Graphu
Příklady používají stejný az rest příkaz, ale změníte text požadavku, aby se získaly různé výsledky. V příkladech jsou uvedeny prostředky, seřazení prostředků podle name vlastnosti a pořadí prostředků podle name vlastnosti a omezení počtu výsledků.
Pokud chcete spustit všechny příklady dotazů, použijte pro prostředí prostředí následující az rest příkaz:
az rest --method post --uri https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2022-10-01 --body `@request-body.json
V PowerShellu je nutné, aby backtick (`) utekl at sign (@) k zadání názvu souboru textu požadavku.
V každém příkladu textu požadavku nahraďte {subscriptionID} ID vašeho předplatného Azure. Spuštěním následujícího příkazu získejte ID předplatného Azure pro text požadavku:
az account show --query id --output tsv
Výpis prostředků
V editoru Visual Studio Code vytvořte nový soubor s názvem request-body.json. Zkopírujte následující JSON a vložte ho do souboru a uložte ho.
Dotaz vrátí pět prostředků Azure s každým prostředkem name a resource type z každého prostředku.
{
"subscriptions": [
"{subscriptionID}"
],
"query": "Resources | project name, type | limit 5"
}
Vzhledem k tomu, že tento příklad dotazu neposkytuje modifikátor řazení, jako je order by, spuštění tohoto dotazu několikrát poskytuje jinou sadu prostředků na požadavek.
Order by name property
Aktualizujte request-body.json následujícím kódem, který změní dotaz na order by name vlastnost. Uložte soubor a pomocí az rest příkazu spusťte dotaz.
{
"subscriptions": [
"{subscriptionID}"
],
"query": "Resources | project name, type | limit 5 | order by name asc"
}
Pokud tento dotaz spustíte několikrát, získá jinou sadu prostředků na každý požadavek.
Pořadí příkazů dotazů je důležité. V tomto příkladu order by přichází po limit. Toto pořadí příkazů omezuje výsledky dotazu na pět prostředků a pak je objednává.
Order by name property and limit results
Aktualizujte request-body.json následujícím kódem name na order by vlastnost a pak limit na prvních pět výsledků. Uložte soubor a pomocí stejného az rest příkazu spusťte dotaz.
{
"subscriptions": [
"{subscriptionID}"
],
"query": "Resources | project name, type | order by name asc | limit 5"
}
Pokud se dotaz spustí několikrát, za předpokladu, že se ve vašem prostředí nic nezměnilo, vrácené výsledky jsou konzistentní a seřazené name podle vlastnosti, ale omezeny na prvních pět výsledků.
Vyčištění prostředků
Odhlaste se z relace Azure CLI.
az logout
Další kroky
V tomto rychlém startu jste ke spuštění dotazu použili koncový bod rozhraní REST API služby Azure Resource Graph. Další informace o jazyce Resource Graph najdete na stránce podrobností dotazovacího jazyka.