Mengelola sumber daya Azure dengan menggunakan REST API

  • Artikel

Pelajari cara menggunakan REST API untuk Azure Resource Manager untuk mengelola sumber daya Azure Anda. Untuk referensi komprehensif tentang cara menyusun panggilan Azure REST, lihat Memulai REST. Lihat referensi REST API Resource Management untuk detail selengkapnya tentang operasi yang tersedia.

Mendapatkan token akses

Untuk melakukan panggilan REST API ke Azure, Anda harus terlebih dahulu mendapatkan token akses. Sertakan token akses ini di header panggilan Azure REST API Anda menggunakan header "Otorisasi" dan atur nilai ke "Bearer {access-token}".

Jika Anda perlu mengambil token baru secara terprogram sebagai bagian dari aplikasi, Anda dapat memperoleh token akses dengan Mendaftarkan aplikasi klien Anda dengan ID Microsoft Entra.

Jika Anda memulai dan ingin menguji REST API Azure menggunakan token individual, Anda dapat mengambil token akses Anda saat ini dengan cepat dengan Azure PowerShell atau Azure CLI.

token=$(az account get-access-token --query accessToken --output tsv)

Lingkup operasi

Anda dapat memanggil banyak operasi Azure Resource Manager pada cakupan yang berbeda:

Jenis Scope
Grup manajemen providers/Microsoft.Management/managementGroups/{managementGroupId}
Langganan subscriptions/{subscriptionId}
Grup sumber daya subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}
Sumber daya subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderName}/{resourceType}/{resourceName}

Mencantumkan sumber daya

Operasi REST berikut mengembalikan sumber daya dalam grup sumber daya yang disediakan.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources?api-version=2021-04-01 HTTP/1.1
Authorization: Bearer <bearer-token>
Host: management.azure.com

Berikut adalah contoh perintah cURL yang dapat Anda gunakan untuk mencantumkan semua sumber daya dalam grup sumber daya menggunakan API Azure Resource Manager:

curl  -H "Authorization: Bearer $token" -H 'Content-Type: application/json' -X GET 'https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources?api-version=2021-04-01'

Dengan langkah autentikasi, contoh ini terlihat seperti:

token=$(az account get-access-token --query accessToken --output tsv)
curl  -H "Authorization: Bearer $token" -H 'Content-Type: application/json' -X GET 'https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources?api-version=2021-04-01'

Terapkan sumber daya ke grup sumber daya yang sudah ada

Anda dapat menyebarkan sumber daya Azure secara langsung dengan menggunakan REST API, atau menyebarkan templat Resource Manager untuk membuat sumber daya Azure.

Terapkan sumber daya

Operasi REST berikut membuat akun penyimpanan. Untuk melihat contoh ini secara lebih rinci, lihat Membuat akun Azure Storage dengan REST API. Dokumentasi referensi lengkap dan sampel untuk Penyedia Sumber Daya Penyimpanan tersedia di Referensi REST API Penyedia Sumber Daya Penyimpanan.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2018-02-01 HTTP/1.1
Authorization: Bearer <bearer-token>
Content-Type: application/json
Host: management.azure.com

{
  "sku": {
    "name": "Standard_GRS"
  },
  "kind": "StorageV2",
  "location": "eastus2",
}

Terapkan pola dasar

Operasi berikut menyebarkan templat Mulai Cepat untuk membuat akun penyimpanan. Untuk informasi selengkapnya, lihat Quickstart: Membuat templat Azure Resource Manager menggunakan Visual Studio Code. Untuk referensi API dari panggilan ini, lihat Penyebaran - Buat Atau Perbarui.

PUT /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/my-deployment?api-version=2021-04-01 HTTP/1.1
Authorization: Bearer <bearer-token>
Content-Type: application/json
Host: management.azure.com

{
  "properties": {
    "templateLink": {
      "uri": "https://example.com/azuretemplates/azuredeploy.json"
    },
    "parametersLink": {
        "uri": "https://example.com/azuretemplates/azuredeploy.parameters.json"
    },
    "mode": "Incremental"
  }
}

Untuk REST API, nilai uri tidak boleh berupa file lokal atau file yang hanya tersedia di jaringan lokal Anda. Azure Resource Manager harus bisa mengakses templat. Menyediakan nilai URI yang dapat diunduh sebagai HTTP atau HTTPS. Untuk mengetahui informasi selengkapnya, lihat Menyebarkan sumber daya dengan templat Resource Manager dan Microsoft Azure PowerShell.

Menyebarkan grup sumber daya dan sumber daya

Anda dapat membuat grup sumber daya dan menyebarkan sumber daya ke grup dengan menggunakan templat. Untuk informasi selengkapnya, lihat Membuat grup sumber daya dan menyebarkan sumber daya.

Menyebarkan sumber daya ke beberapa langganan atau grup sumber daya

Biasanya, Anda menyebarkan semua sumber daya dalam templat Anda ke satu grup sumber daya. Namun, ada skenario di mana Anda ingin menyebarkan set sumber daya bersamaan tetapi menempatkannya di grup sumber daya atau langganan yang berbeda. Untuk informasi lebih lanjut, lihat Menyebarkan sumber daya Azure ke beberapa langganan atau grup sumber daya.

Menghapus sumber daya

Operasi berikut menunjukkan cara menghapus akun penyimpanan.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2022-09-01 HTTP/1.1
Authorization: Bearer <bearer-token>
Host: management.azure.com

Untuk informasi selengkapnya tentang cara Azure Resource Manager memerintahkan penghapusan sumber daya, lihat Penghapusan grup sumber daya Azure Resource Manager.

Kelola akses ke sumber daya

Kontrol akses berbasis peran Azure (Azure RBAC) adalah cara Anda mengelola akses ke sumber daya di Azure. Untuk informasi selengkapnya, lihat Menambahkan atau menghapus penetapan peran Azure menggunakan REST.

Langkah berikutnya