Membuat hub IoT menggunakan penyedia sumber daya REST API (.NET)

Artikel
06/03/2024

Anda dapat menggunakan IoT Hub Resource REST API untuk membuat dan mengelola hub Azure IoT secara terprogram. Artikel ini memperlihatkan kepada Anda cara menggunakan Sumber Daya IoT Hub untuk membuat hub IoT menggunakan Postman. Atau, Anda dapat menggunakan cURL. Jika salah satu perintah REST ini gagal, temukan bantuan dengan kode kesalahan umum IoT Hub API.

Catatan

Sebaiknya Anda menggunakan modul Azure Az PowerShell untuk berinteraksi dengan Azure. Untuk memulai, lihat Menginstal Azure PowerShell. Untuk mempelajari cara bermigrasi ke modul Az PowerShell, lihat Memigrasikan Azure PowerShell dari AzureRM ke Az.

Prasyarat

Modul Azure PowerShell atau Azure Cloud Shell
Postman atau cURL

Mendapatkan token akses Azure

Di cmdlet Azure PowerShell atau Azure Cloud Shell, masuk lalu ambil token dengan perintah berikut. Jika Anda menggunakan Cloud Shell, Anda sudah masuk, jadi lewati langkah ini.

az account get-access-token --resource https://management.azure.com

Anda akan melihat respons di konsol yang mirip dengan JSON ini (kecuali token aksesnya panjang):

{
    "accessToken": "eyJ ... pZA",
    "expiresOn": "2022-09-16 20:57:52.000000",
    "subscription": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "tenant": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "tokenType": "Bearer"
}

Di permintaan Postman baru, dari tab Auth, pilih daftar dropdown Jenis dan pilih Token Pembawa.
Tempelkan token akses ke bidang berlabel Token.

Perlu diingat bahwa token akses kedaluwarsa setelah 5-60 menit, jadi Anda mungkin perlu membuat token lain.

Membuat IoT Hub

Pilih daftar dropdown perintah REST dan pilih perintah PUT. Salin URL di bawah ini, mengganti nilai dalam {} dengan nilai Anda sendiri. Nilainya {resourceName} adalah nama yang Anda inginkan untuk hub IoT baru Anda. Tempelkan URL ke bidang di samping perintah PUT.
```
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2021-04-12
```
Lihat perintah PUT di Sumber Daya IoT Hub.
Dari tab Isi, pilih mentah dan JSON dari daftar dropdown.
Salin JSON berikut, ganti nilai dengan nilai <> Anda sendiri. Tempelkan JSON ke dalam kotak di Postman pada tab Isi . Pastikan nama hub IoT Anda cocok dengan yang ada di URL PUT Anda. Ubah lokasi ke lokasi Anda (lokasi yang ditetapkan ke grup sumber daya Anda).
```
{
    "name": "<my-iot-hub>",
    "location": "<region>",
    "tags": {},
    "properties": {},
    "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
    }
}
```
Lihat perintah PUT di Sumber Daya IoT Hub.
Pilih Kirim untuk mengirim permintaan Anda dan membuat hub IoT baru. Permintaan yang berhasil akan mengembalikan respons 201 Dibuat dengan cetakan JSON dari spesifikasi hub IoT Anda. Anda dapat menyimpan permintaan jika menggunakan Postman.

Menampilkan hub IoT

Untuk melihat semua spesifikasi hub IoT baru Anda, gunakan permintaan GET. Anda dapat menggunakan URL yang sama dengan yang Anda gunakan dengan permintaan PUT, tetapi harus menghapus Isi permintaan tersebut (jika belum kosong) karena permintaan GET tidak dapat memiliki isi. Berikut adalah templat permintaan GET:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2018-04-01

Lihat perintah GET di Sumber Daya IoT Hub.

Memperbarui hub IoT

Memperbarui sesederhana menggunakan permintaan PUT yang sama dari saat kami membuat hub IoT dan mengedit isi JSON untuk berisi parameter yang Anda pilih. Edit isi permintaan dengan menambahkan properti tag , lalu jalankan permintaan PUT.

{
    "name": "<my-iot-hub>",
    "location": "westus2",
    "tags": {
        "Animal": "Cat"
    },
    "properties": {},
    "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
    }
}

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2018-04-01

Respons akan menampilkan tag baru yang ditambahkan di konsol. Ingat, Anda mungkin perlu me-refresh token akses Anda jika terlalu banyak waktu telah berlalu sejak terakhir kali Anda membuatnya.

Lihat perintah PUT di Sumber Daya IoT Hub.

Atau, gunakan perintah PATCH di Sumber Daya IoT Hub untuk memperbarui tag.

Menghapus hub IoT

Jika Anda hanya menguji, Anda mungkin ingin membersihkan sumber daya dan menghapus hub IoT baru Anda, dengan mengirim permintaan DELETE. pastikan untuk mengganti nilai dengan {} nilai Anda sendiri. Nilainya {resourceName} adalah nama hub IoT Anda.

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2018-04-01

Lihat perintah DELETE di Sumber Daya IoT Hub.

Langkah berikutnya

Karena sudah menyebarkan hub IoT menggunakan REST API penyedia sumber, sebaiknya pelajari lebih lanjut:

Baca tentang kemampuan penyedia sumber daya REST API IoT Hub.
Baca Ringkasan Azure Resource Manager untuk mempelajari selengkapnya tentang kemampuan Azure Resource Manager.

Untuk mempelajari selengkapnya tentang mengembangkan IoT Hub, lihat artikel berikut ini:

SDK Azure IoT

Untuk mempelajari lebih lanjut kemampuan IoT Hub, lihat:

Menyebarkan AI ke perangkat edge dengan Azure IoT Edge

Bagikan melalui