Rövid útmutató: Az első Resource Graph-lekérdezés futtatása REST API használatával

Cikk
03/05/2024

Az Azure Resource Graph REST API-val való használatának első lépése annak ellenőrzése, hogy rendelkezik-e elérhető REST API-k meghívására szolgáló eszközzel. Ez a rövid útmutató ezután végigvezeti egy lekérdezés futtatásának és az eredmények lekérésének folyamatán az Azure Resource Graph REST API-végpont meghívásával.

A folyamat végén rendelkezni fog a REST API-végpontok hívásához és az első Resource Graph-lekérdezés futtatásához szükséges eszközökkel.

Előfeltételek

Ha még nincs Azure-előfizetése, kezdés előtt hozzon létre egy ingyenes fiókot.

Azure Cloud Shell

Az Azure által üzemeltetett Azure Cloud Shell egy interaktív felület, amelyet a böngészőből használhat. A Bash vagy a PowerShell segítségével is használhatja a Cloud Shellt az Azure-szolgáltatásokhoz. A Cloud Shell előre telepített parancsaival futtathatja a jelen cikkben szereplő kódot anélkül, hogy bármit telepítenie kellene a helyi környezetben.

Az Azure Cloud Shell indítása:

Lehetőség	Példa/hivatkozás
Válassza a Kipróbálás lehetőséget egy kód vagy parancsblokk jobb felső sarkában. A Kipróbálás lehetőség választása nem másolja automatikusan a kódot vagy a parancsot a Cloud Shellbe.
Látogasson el a https://shell.azure.com webhelyre, vagy kattintson a Cloud Shell indítása gombra a böngészőben.
Az Azure Portal jobb felső sarkában található menüben kattintson a Cloud Shell gombra.

Az Azure Cloud Shell használata:

Indítsa el a Cloud Shellt.
A kód vagy parancs másolásához kattintson a Másolás gombra egy kódblokkon (vagy parancsblokkon).
Illessze be a kódot vagy parancsot a Cloud Shell-munkamenetbe a Windows és Linux rendszeren a Ctrl Shift+V billentyűkombinációval+, vagy a Cmd+Shift+V macOS rendszeren való kiválasztásával.
A kód vagy parancs futtatásához válassza az Enter lehetőséget .

Ismerkedés a REST API-val

Ha még nem ismeri a REST API-t, első lépésként tekintse át az Azure REST API-referenciát a REST API általános bemutatásáért, és fordítson különös figyelmet a kérések URI-azonosítójára és törzsére. Ez a cikk ezeket a fogalmakat használja az Azure Resource Graph használatához szükséges útmutatások megadásához, és feltételezi a használatukkal kapcsolatos ismereteket. Az ARMClient és hasonló eszközökkel automatikusan kezelhető az engedélyezés, ezért a kezdők számára mindenképp javasoljuk ezek használatát.

Az Azure Resource Graph specifikációiért tekintse meg az Azure Resource Graph REST API-t.

A REST API és a PowerShell

Ha még nem választott eszközt a REST API-hívások kezeléséhez, ennek az útmutatónak a keretében érdemes a PowerShellt használnia. Az alábbi kódminta egy fejlécet kap az Azure-ral való hitelesítéshez. Hozzon létre egy hitelesítési fejlécet, vagy más néven tulajdonosi jogkivonatot, és adja meg a kapcsolódáshoz szükséges REST API URI-t a paraméterekkel vagy egy kérelemtörzzsel:

# Log in first with Connect-AzAccount if not using Cloud Shell

$azContext = Get-AzContext
$azProfile = [Microsoft.Azure.Commands.Common.Authentication.Abstractions.AzureRmProfileProvider]::Instance.Profile
$profileClient = New-Object -TypeName Microsoft.Azure.Commands.ResourceManager.Common.RMProfileClient -ArgumentList ($azProfile)
$token = $profileClient.AcquireAccessToken($azContext.Subscription.TenantId)
$authHeader = @{
    'Content-Type'='application/json'
    'Authorization'='Bearer ' + $token.AccessToken
}

# Invoke the REST API
$restUri = "https://management.azure.com/subscriptions/$($azContext.Subscription.Id)?api-version=2020-01-01"
$response = Invoke-RestMethod -Uri $restUri -Method Get -Headers $authHeader

A $response változó a parancsmag eredményét Invoke-RestMethod tartalmazza, amely olyan parancsmagokkal elemezhető, mint a ConvertFrom-Json. Ha a REST API szolgáltatásvégpontja kérelemtörzset vár, adjon meg egy JSON formátumú változót az Invoke-RestMethod-Body paraméterében.

Az első Resource Graph-lekérdezés futtatása

Ha a REST API-eszközöket hozzáadja a választott környezethez, ideje kipróbálni egy egyszerű előfizetés-alapú Resource Graph-lekérdezést. A lekérdezés az első öt Azure-erőforrást adja vissza az egyes erőforrások nevével és erőforrástípusával . A felügyeleti csoport szerinti lekérdezéshez használja managementgroups ahelyettsubscriptions, hogy a . A teljes bérlő lekérdezéséhez hagyja ki a kérelem törzséből a tulajdonságokat és subscriptions a managementgroups tulajdonságokat is.

Az egyes REST API-hívások kérelemtörzsében van egy változó, amelyet a saját értékére kell cserélnie:

{subscriptionID} – Cserélje le az előfizetése azonosítójára

Futtassa az első Azure Resource Graph-lekérdezést a REST API és a resources végpont használatával:
- REST API URI
```
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2021-03-01
```
- Kérelem törzse
```
{
    "subscriptions": [
        "{subscriptionID}"
    ],
    "query": "Resources | project name, type | limit 5"
}
```
Feljegyzés

Mivel ez a lekérdezési példa nem biztosít olyan rendezési módosító elemet, mint például order by, a lekérdezés többszöri futtatása valószínűleg kérésenként eltérő erőforráskészletet eredményez.
Frissítse a végpont hívását, resouces és módosítsa a lekérdezésta Név tulajdonságraorder by:
- REST API URI
```
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2021-03-01
```
- Kérelem törzse
```
{
    "subscriptions": [
        "{subscriptionID}"
    ],
    "query": "Resources | project name, type | limit 5 | order by name asc"
}
```
Feljegyzés

Csakúgy, mint az első lekérdezésnél, e lekérdezés többszöri futtatása esetén is valószínűleg minden kéréssel eltérő erőforráslistát fog kapni. Fontos a lekérdezési parancsok sorrendje. Ebben a példában az order by a limit után következik. Ez a parancsrend először korlátozza a lekérdezés eredményeit, majd megrendeli őket.

Frissítse a végpont hívását resources , és módosítsa a lekérdezést először order by a Név tulajdonságra, majd limit az első öt találatra:

REST API URI

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

Kérelem törzse

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

Ha a végső lekérdezés többször is lefut, feltételezve, hogy a környezetben semmi sem változik, a visszaadott eredmények konzisztensek és a Név tulajdonság szerint vannak rendezve, de továbbra is az első öt találatra korlátozódnak.

Az Azure Resource GraphHOZ tartozó REST API-hívásokra további példákat az Azure Resource Graph REST-példáiban talál.

Az erőforrások eltávolítása

A REST API-nak nincsenek eltávolítandó kódtárai vagy moduljai. Ha az ARMClienthez hasonló eszközt telepített a hívások indításához, és már nincs rá szüksége, eltávolíthatja az eszközt.

Következő lépések

Ebben a rövid útmutatóban meghívta a Resource Graph REST API-végpontot, és futtatta az első lekérdezést. A Resource Graph nyelvével kapcsolatos további információkért lépjen a lekérdezés nyelvének részleteit tartalmazó oldalra.

További információ a lekérdezés nyelvéről