Mulai Cepat: Menjalankan kueri Resource Graph pertama Anda menggunakan REST API

Artikel
03/05/2024

Langkah pertama untuk menggunakan Azure Resource Graph dengan REST API adalah memeriksa apakah alat yang Anda miliki untuk memanggil REST API yang tersedia. Mulai cepat ini kemudian memandu Anda melalui proses menjalankan kueri dan mengambil hasilnya dengan memanggil titik akhir REST API Azure Resource Graph.

Di akhir proses ini, Anda akan memiliki alat untuk memanggil titik akhir REST API dan menjalankan kueri Resource Graph pertama Anda.

Prasyarat

Jika Anda tidak memiliki langganan Azure, buat akun gratis sebelum Anda memulai.

Azure Cloud Shell

Azure meng-hosting Azure Cloud Shell, lingkungan shell interaktif yang dapat Anda gunakan melalui browser. Anda dapat menggunakan Bash atau PowerShell dengan Cloud Shell untuk bekerja dengan layanan Azure. Anda dapat menggunakan perintah Cloud Shell yang telah diinstal sebelumnya untuk menjalankan kode dalam artikel ini tanpa harus menginstal apa-apa di lingkungan lokal Anda.

Untuk memulai Azure Cloud Shell:

Opsi	Contoh/Tautan
Pilih Coba di pojok kanan atas blok kode atau perintah. Memilih Coba tidak otomatis menyalin kode atau perintah ke Cloud Shell.
Buka https://shell.azure.com, atau pilih tombol Luncurkan Cloud Shell untuk membuka Cloud Shell di browser Anda.
Pilih tombol Cloud Shell pada bilah menu di kanan atas di portal Microsoft Azure.

Untuk menggunakan Azure Cloud Shell:

Mulai Cloud Shell.
Pilih tombol Salin pada blok kode (atau blok perintah) untuk menyalin kode atau perintah.
Tempel kode atau perintah ke dalam sesi Cloud Shell dengan memilih Ctrl+Shift+V di Windows dan Linux, atau dengan memilih Cmd+Shift+V di macOS.
Pilih Masukkan untuk menjalankan kode atau perintah.

Mulai menggunakan REST API

Jika Anda tidak terbiasa menggunakan REST API, mulailah dengan meninjau Referensi REST API Azure untuk memahami REST API secara umum, khususnya URI dan isi permintaan. Artikel ini menggunakan konsep berikut untuk memberikan petunjuk cara menggunakan Azure Resource Graph dan mengasumsikan pengetahuan tentangnya. Alat seperti ARMClient dan lainnya dapat menangani otorisasi secara otomatis dan direkomendasikan untuk pemula.

Untuk spesifikasi Azure Resource Graph, lihat REST API Azure Resource Graph.

REST API dan PowerShell

Jika Anda belum memiliki alat untuk melakukan panggilan REST API, sebaiknya gunakan PowerShell untuk petunjuk ini. Sampel kode berikut ini mendapatkan header untuk diautentikasi dengan Azure. Buat header autentikasi, kadang-kadang disebut token Pembawa, dan sediakan REST API URI untuk tersambung dengan parameter atau Isi Permintaan:

# 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

Variabel $response memiliki hasil cmdlet Invoke-RestMethod, yang dapat diurai dengan cmdlet seperti ConvertFrom-Json. Jika titik akhir layanan REST API mengharapkan Isi Permintaan, sediakan variabel berformat JSON ke parameter -Body dari Invoke-RestMethod.

Menjalankan kueri Resource Graph pertama Anda

Dengan alat REST API yang telah ditambahkan ke lingkungan pilihan Anda, sekarang saatnya untuk mencoba kueri Resource Graph berdasarkan langganan sederhana. Kueri mengembalikan lima sumber daya Azure pertama dengan Nama dan Jenis Sumber Daya dari setiap sumber daya. Untuk membuat kueri grup manajemen, gunakan managementgroups bukan subscriptions. Untuk membuat kueri untuk semua penyewa, hapus properti managementgroups dan subscriptions dari isi permintaan.

Dalam isi permintaan setiap panggilan REST API, terdapat variabel yang digunakan yang harus diganti dengan nilai Anda sendiri:

{subscriptionID} - Ganti dengan ID langganan Anda

Jalankan kueri Azure Resource Graph pertama Anda menggunakan REST API dan titik akhir resources:
- REST API URI
```
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2021-03-01
```
- Isi Permintaan
```
{
    "subscriptions": [
        "{subscriptionID}"
    ],
    "query": "Resources | project name, type | limit 5"
}
```
Catatan

Karena contoh kueri ini tidak menyediakan pengubah urutan seperti order by, menjalankan kueri ini beberapa kali kemungkinan akan menghasilkan set sumber daya yang berbeda untuk setiap permintaan.
Perbarui panggilan ke titik akhir resouces dan ubah kueri ke order by properti Nama:
- REST API URI
```
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2021-03-01
```
- Isi Permintaan
```
{
    "subscriptions": [
        "{subscriptionID}"
    ],
    "query": "Resources | project name, type | limit 5 | order by name asc"
}
```
Catatan

Sama seperti kueri pertama, menjalankan kueri ini beberapa kali kemungkinan akan menghasilkan kumpulan sumber daya yang berbeda untuk setiap permintaan. Urutan perintah kueri adalah hal yang penting. Dalam contoh ini, order by muncul setelah limit. Urutan perintah ini pertama-tama membatasi hasil kueri dan kemudian mengurutkannya.

Perbarui panggilan ke titik akhir resources dan ubah kueri menjadi order by pertama properti Nama, kemudian limit ke lima hasil teratas:

REST API URI

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

Isi Permintaan

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

Ketika kueri akhir dijalankan beberapa kali, dengan asumsi bahwa tidak ada yang berubah di lingkungan Anda, hasil yang ditampilkan konsisten dan diurutkan berdasarkan properti Nama, tetapi masih terbatas pada lima hasil teratas.

Untuk contoh lain dari panggilan REST API untuk Azure Resource Graph, lihat Contoh REST Azure Resource Graph.

Membersihkan sumber daya

REST API tidak memiliki pustaka atau modul untuk dicopot. Jika Anda menginstal alat seperti ARMClient untuk melakukan panggilan dan tidak lagi membutuhkannya, Anda dapat menghapus instalan alat sekarang.

Langkah berikutnya

Dalam mulai cepat ini, Anda telah memanggil titik akhir REST API Resource Graph dan menjalankan kueri pertama Anda. Untuk mempelajari selengkapnya tentang bahasa Resource Graph, lanjutkan ke halaman detail bahasa kueri.

Mendapatkan informasi selengkapnya tentang bahasa kueri

Share via