Membuat dan menghapus rute dan titik akhir dengan menggunakan Azure CLI

Artikel
07/16/2024

Artikel ini memperlihatkan kepada Anda cara mengelola rute dan titik akhir Azure IoT Hub dengan menggunakan Azure CLI. Pelajari cara menggunakan Azure CLI untuk membuat rute dan titik akhir untuk Azure Event Hubs, antrean dan topik Azure Bus Layanan, Azure Storage, dan Cosmos DB.

Untuk mempelajari selengkapnya tentang cara kerja perutean di IoT Hub, lihat Menggunakan perutean pesan IoT Hub untuk mengirim pesan perangkat ke cloud ke titik akhir yang berbeda. Untuk menelusuri penyiapan rute yang mengirim pesan ke penyimpanan lalu menguji pada perangkat yang disimulasikan, lihat Tutorial: Mengirim data perangkat ke Azure Storage dengan menggunakan perutean pesan IoT Hub.

Prasyarat

Prosedur yang dijelaskan dalam artikel menggunakan sumber daya berikut:

Azure CLI
Sebuah hub IoT
Layanan titik akhir di Azure

Azure CLI

Artikel ini menggunakan Azure CLI untuk bekerja dengan IoT Hub dan layanan Azure lainnya. Anda dapat memilih cara mengakses Azure CLI:

Gunakan lingkungan Bash di Azure Cloud Shell. Untuk informasi selengkapnya, lihat Mulai Cepat untuk Bash di Azure Cloud Shell.
Jika Anda lebih suka menjalankan perintah referensi CLI secara lokal, instal Azure CLI. Jika Anda menjalankan Windows atau macOS, pertimbangkan untuk menjalankan Azure CLI dalam kontainer Docker. Untuk informasi lebih lanjut, lihat Cara menjalankan Azure CLI di kontainer Docker.
- Jika Anda menggunakan instalasi lokal, masuk ke Azure CLI dengan menggunakan perintah login az. Untuk menyelesaikan proses autentikasi, ikuti langkah-langkah yang ditampilkan di terminal Anda. Untuk opsi masuk lainnya, lihat Masuk dengan Azure CLI.
- Saat Anda diminta, instal ekstensi Azure CLI pada penggunaan pertama. Untuk informasi selengkapnya tentang ekstensi, lihat Menggunakan ekstensi dengan Azure CLI.
- Jalankan versi az untuk menemukan versi dan pustaka dependen yang diinstal. Untuk meningkatkan ke versi terbaru, jalankan peningkatan az.

IoT Hub

Memiliki hub IoT di langganan Azure Anda. Jika belum memiliki hub, Anda dapat mengikuti langkah-langkah di Membuat IoT hub.

Layanan titik akhir

Anda memerlukan setidaknya satu layanan Azure lainnya untuk digunakan sebagai titik akhir ke rute. Titik akhir menerima pesan perangkat dan log peristiwa.

Tentukan layanan Azure mana yang ingin Anda gunakan sebagai titik akhir untuk menerima data perangkat dan peristiwa yang dirutekan: hub peristiwa, antrean atau topik Layanan, akun penyimpanan, atau kontainer Cosmos DB. Untuk layanan yang Anda pilih untuk digunakan, selesaikan langkah-langkah untuk membuat layanan titik akhir.

Membuat ruang nama Azure Event Hubs dan pusat aktivitas. Untuk informasi selengkapnya, lihat Mulai Cepat: Membuat pusat aktivitas dengan menggunakan Azure CLI.
Buat aturan otorisasi yang akan digunakan untuk memberikan izin IoT Hub untuk mengirim data ke pusat aktivitas.

Tip

Nilai name parameter RootManageSharedAccessKey adalah nama default yang memungkinkan Kelola, Kirim, Dengarkan klaim (akses). Jika Anda ingin membatasi klaim, berikan name parameter nama unik Anda sendiri dan sertakan --rights bendera diikuti oleh salah satu klaim. Contohnya,--name my-name --rights Send.
```
az eventhubs eventhub authorization-rule create --resource-group my-resource-group --namespace-name my-routing-namespace --eventhub-name my-event-hubs --name RootManageSharedAccessKey
```
Untuk informasi selengkapnya, lihat Mengotorisasi akses ke Azure Event Hubs.

Buat namespace Bus Layanan dan antrean. Untuk informasi selengkapnya, lihat Menggunakan Azure CLI untuk membuat namespace Bus Layanan dan antrean.
Buat aturan otorisasi yang akan memberikan izin IoT Hub untuk mengirim data ke antrean. Untuk name, gunakan nilai unik untuk aturan otorisasi Anda.
```
az servicebus queue authorization-rule create --resource-group my-resource-group --namespace-name my-namespace --queue-name my-queue --name my-auth-rule --rights Listen
```
Untuk opsi aturan otorisasi lainnya, lihat az servicebus queue authorization-rule create.

Buat titik akhir

Semua rute IoT Hub menunjuk ke titik akhir, yang akan menerima perangkat dan data peristiwa yang dirutekan. Lebih dari satu rute dapat menunjuk ke titik akhir yang sama. Saat ini, IoT Hub mendukung titik akhir untuk Event hubs, Bus Layanan antrean atau topik, Storage, dan Cosmos DB. Instans layanan yang Anda gunakan untuk titik akhir anda harus ada di langganan Azure anda sebelum membuat titik akhir.

Catatan

Artikel ini menggunakan grup perintah az iot hub message-endpoint , yang diperkenalkan dalam versi 0.19.0 ekstensi azure-iot untuk Azure CLI. Versi ekstensi azure-iot sebelumnya menggunakan grup perintah titik akhir perutean hub az iot, yang serupa dan masih didukung tetapi tidak mendukung pembuatan titik akhir Cosmos DB.

Gunakan perintah berikut untuk memperbarui ke versi terbaru ekstensi azure-iot:

az extension update --name azure-iot

Untuk membuat titik akhir Azure Event Hubs, gunakan aturan otorisasi yang Anda buat di prasyarat.

Gunakan perintah az eventhubs eventhub authorization-rule keys list untuk mencantumkan aturan otorisasi Anda. Berikan nilai berikut untuk parameter tempat penampung:

parameter	value
eventhub_group	Grup sumber daya pusat aktivitas.
eventhub_namespace	Pilih namespace Azure Event Hubs Anda.
eventhub_name	Nama hub kejadian.
rule_name	Nama aturan otorisasi untuk pusat aktivitas. Jika Anda menyalin contoh dalam prasyarat, nama ini adalah `RootManageSharedAccessKey`.

az eventhubs eventhub authorization-rule keys list --resource-group {eventhub_group} --namespace-name {eventhub_namespace} --eventhub-name my-event-hubs --name {rule_name}

Salin string koneksi pusat aktivitas Anda dari output.

Gunakan perintah az iot hub message-endpoint create eventhub untuk membuat titik akhir kustom Anda. Berikan nilai berikut untuk parameter tempat penampung:

parameter	value
iothub_name	Nama hub IoT tempat titik akhir ini sedang dibuat.
endpoint_name	Nama unik untuk titik akhir baru.
eventhub_subscription	ID langganan hub peristiwa. Argumen ini dapat dibiarkan jika pusat aktivitas berada dalam langganan yang sama dengan hub IoT.
eventhub_group	Grup sumber daya pusat aktivitas. Argumen ini dapat dibiarkan jika pusat aktivitas berada dalam grup sumber daya yang sama dengan hub IoT.
eventhub_connection_string	string koneksi yang Anda salin dari aturan otorisasi pusat aktivitas.

az iot hub message-endpoint create eventhub --hub-name {iothub_name} --endpoint-name {endpoint_name}  --connection-string "{eventhub_connection_string}" --endpoint-subscription-id {eventhub_subscription} --endpoint-resource-group {eventhub_group}

Untuk membuat titik akhir antrean Bus Layanan, gunakan aturan otorisasi yang Anda buat di prasyarat.

Gunakan perintah az servicebus queue authorization-rule keys list untuk mendapatkan string koneksi antrean Bus Layanan Anda. Berikan nilai berikut untuk parameter tempat penampung:

parameter	value
queue_group	Grup sumber daya antrean Bus Layanan.
queue_namespace	Nama namespace antrean Bus Layanan.
queue_name	Nama antrean.
rule_name	Nama aturan otorisasi untuk antrean. Jika Anda menyalin contoh dalam prasyarat, nama ini adalah `my-auth-rule`.

az servicebus queue authorization-rule keys list --resource-group {queue_group} --namespace-name {queue_namespace} --queue-name {queue_name} --name {rule_name}

Salin string koneksi antrean Bus Layanan Anda dari output.

Gunakan perintah az iot hub message-endpoint create servicebus-queue untuk membuat titik akhir kustom Anda. Berikan nilai berikut untuk parameter tempat penampung:

parameter	value
iothub_name	Nama hub IoT tempat titik akhir ini sedang dibuat.
endpoint_name	Nama unik untuk titik akhir baru.
queue_connection_string	string koneksi yang Anda salin dari aturan otorisasi antrean Bus Layanan.
queue_subscription	ID langganan antrean Bus Layanan. Argumen ini dapat dibiarkan jika antrean berada dalam langganan yang sama dengan hub IoT.
queue_group	Grup sumber daya antrean Bus Layanan. Argumen ini dapat dibiarkan jika antrean berada dalam grup sumber daya yang sama dengan hub IoT.

az iot hub message-endpoint create servicebus-queue --hub-name {iothub_name} --endpoint-name {endpoint_name} --connection-string "Endpoint={queue_connection_string}" --endpoint-resource-group {queue_group} --endpoint-subscription-id {queue_subscription}

Gunakan daftar kunci aturan otorisasi topik az servicebus untuk mendapatkan string koneksi topik Bus Layanan Anda. Nama default aturan otorisasi Anda yang dilengkapi dengan namespace baru adalah RootManageSharedAccessKey. Berikan nilai berikut untuk parameter tempat penampung:

parameter value

topic_group Grup sumber daya topik Bus Layanan.

topic_namespace Nama namespace Bus Layanan topik.

topic_name Nama topik.
```
az servicebus topic authorization-rule keys list --resource-group {topic_group} --namespace-name {topic_namespace} --topic-name {topic_name} --name RootManageSharedAccessKey
```
Salin string koneksi topik Bus Layanan Anda dari output.

parameter	value
topic_group	Grup sumber daya topik Bus Layanan.
topic_namespace	Nama namespace Bus Layanan topik.
topic_name	Nama topik.

Gunakan perintah az iot hub message-endpoint create servicebus-topic untuk membuat titik akhir kustom Anda. Berikan nilai berikut untuk parameter tempat penampung:

parameter	value
iothub_name	Nama hub IoT tempat titik akhir ini sedang dibuat.
endpoint_name	Nama unik untuk titik akhir baru.
topic_connection_string	string koneksi yang Anda salin dari aturan otorisasi topik Bus Layanan.
topic_subscription	ID langganan topik Bus Layanan. Argumen ini dapat dibiarkan jika topik berada dalam langganan yang sama dengan hub IoT.
topic_group	Grup sumber daya topik Bus Layanan. Argumen ini dapat dibiarkan jika topik berada dalam grup sumber daya yang sama dengan hub IoT.

az iot hub message-endpoint create servicebus-topic --hub-name {iothub_name} --endpoint-name {endpoint_name} --connection-string "Endpoint={topic_connection_string};EntityPath=my-service-bus-topic --endpoint-resource-group {topic_group} --endpoint-subscription-id {topic_subscription}

Gunakan perintah az storage account show-connection-string untuk mendapatkan string koneksi dari sumber daya Azure Storage Anda untuk membuat titik akhir. Berikan nilai berikut untuk parameter tempat penampung:

parameter value

storage_group Grup sumber daya akun penyimpanan.

storage_name Nama akun penyimpanan.
```
az storage account show-connection-string --resource-group my-resource-group --name my-storage-account 
```
Salin string koneksi akun penyimpanan Anda dari output.

parameter	value
storage_group	Grup sumber daya akun penyimpanan.
storage_name	Nama akun penyimpanan.

Gunakan perintah az iot hub message-endpoint create storage-container untuk membuat titik akhir Azure Storage baru. Untuk semua parameter lainnya, gunakan nilai untuk skenario Anda. Berikan nilai berikut untuk parameter tempat penampung:

parameter	value
iothub_name	Nama hub IoT tempat titik akhir ini sedang dibuat.
endpoint_name	Nama unik untuk titik akhir baru.
storage_connection_string	string koneksi yang Anda salin dari perintah akun penyimpanan.
container_name	Nama kontainer di akun penyimpanan Anda tempat data akan dikirim.
storage_subscription	ID langganan penyimpanan Bus Layanan. Argumen ini dapat dibiarkan jika penyimpanan berada dalam langganan yang sama dengan hub IoT.
storage_group	Grup sumber daya penyimpanan Bus Layanan. Argumen ini dapat dibiarkan jika topik berada dalam grup sumber daya yang sama dengan hub IoT.

az iot hub message-endpoint create storage-container--hub-name {iothub_name} --endpoint-name {endpoint_name} --container {container_name} --endpoint-resource-group {storage_group} --connection-string "DefaultEndpointsProtocol={storage_connection_string}" --endpoint-subscription-id {storage_subscription} --resource-group {storage_group}

Gunakan perintah az cosmosdb keys list untuk mendapatkan string koneksi dari akun database Cosmos DB Anda.

az cosmosdb keys list --name my-cosmosdb-account --resource-group my-resource-group --type connection-strings

Salin string koneksi Cosmos DB Anda dari output.

Gunakan perintah az iot hub message-endpoint create cosmosdb-container untuk membuat titik akhir kustom Anda. Berikan nilai berikut untuk parameter tempat penampung:

parameter	value
iothub_name	Nama hub IoT tempat titik akhir ini sedang dibuat.
endpoint_name	Nama unik untuk titik akhir baru.
cosmosdb_connection_string	string koneksi yang Anda salin dari perintah akun Cosmos DB.
container_name	Nama kontainer di akun Cosmos DB Anda tempat data akan dikirim.
database_name	Nama database di akun Cosmos DB Anda tempat data akan dikirim.
cosmosdb_subscription	ID langganan akun database Cosmos DB. Argumen ini dapat dibiarkan jika database berada dalam langganan yang sama dengan hub IoT.
cosmosdb_group	Grup sumber daya akun database Cosmos DB. Argumen ini dapat dibiarkan jika database berada dalam grup sumber daya yang sama dengan hub IoT.

az iot hub message-endpoint create cosmosdb-container --hub-name {iothub_name} --endpoint-name {endpoint_name} --connection-string "{cosmosdb_connection_string}" --container {container_name} --database-name {database_name} --resource-group my-resource-group --endpoint-account my-cosmosdb-account --container my-cosmosdb-database-container

Catatan

Jika Anda menggunakan identitas terkelola alih-alih string koneksi, gunakan perintah az cosmosdb sql role assignment create untuk mengautentikasi identitas Anda ke akun Cosmos DB.

az cosmosdb sql role assignment create -a my-cosmosdb-account -g my-resource-group --scope '/' -n 'Cosmos DB Built-in Data Contributor' -p "IoT Hub System Assigned or User Assigned Identity"

Menghapus titik akhir

Jika Anda ingin menghapus titik akhir dari hub IoT Anda, gunakan perintah az iot hub message-endpoint delete . Dengan perintah ini, Anda dapat menghapus satu titik akhir, menghapus semua titik akhir dari satu jenis, atau menghapus semua titik akhir dari hub.

Misalnya, perintah berikut menghapus semua titik akhir di hub IoT yang menunjuk ke sumber daya Storage:

az iot hub message-endpoint delete --hub-name {iothub_name} --endpoint-type storage-container

Membuat rute IoT Hub

Di IoT Hub, Anda dapat membuat rute untuk mengirim pesan atau mengambil peristiwa. Setiap rute memiliki sumber data dan titik akhir. Sumber data adalah tempat asal pesan atau log peristiwa. Titik akhir adalah tempat pesan atau log peristiwa berakhir. Anda memilih lokasi untuk sumber data dan titik akhir saat membuat rute baru di hub IoT Anda. Secara opsional, Anda dapat Menambahkan kueri ke rute pesan untuk memfilter pesan atau peristiwa sebelum masuk ke titik akhir.

Catatan

Artikel ini menggunakan grup perintah rute pesan hub az iot, yang diperkenalkan dalam versi 0.19.0 ekstensi azure-iot untuk Azure CLI. Versi ekstensi azure-iot sebelumnya menggunakan grup perintah rute hub az iot, yang serupa dan masih didukung.

Gunakan perintah berikut untuk memperbarui ke versi terbaru ekstensi azure-iot:

az extension update --name azure-iot

Gunakan perintah az iot hub message-route create untuk membuat rute IoT Hub baru dengan menggunakan titik akhir tersebut. Berikan nilai berikut untuk parameter tempat penampung:

parameter	value
iothub_name	Nama hub IoT tempat rute ini sedang dibuat.
route_name	Nama unik untuk rute baru.
endpoint_name	Nama titik akhir tempat rute akan mengirim data.
data_source	Sumber rute. Nilai yang diterima adalah: `deviceconnectionstateevents`, , `devicelifecycleeventsdevicejoblifecycleevents`, `devicemessages`, `digitaltwinchangeevents`, `invalid`, atau `twinchangeevents`.

az iot hub message-route create --hub-name {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source {data_source}

Untuk mengonfirmasi bahwa rute baru berada di hub IoT Anda, gunakan perintah az iot hub message-route list untuk melihat semua rute di hub IoT Anda:

az iot hub message-route list --hub-name {iothub_name}

Anda akan melihat respons di Azure CLI yang mirip dengan contoh ini:

[
   {
     "condition": "true",
     "endpointNames": [
       "endpoint_name"
     ],
     "isEnabled": true,
     "name": "route_name",
     "source": "DeviceConnectionStateEvents"
   }
]

Memperbarui rute IoT Hub

Anda dapat memperbarui beberapa properti rute setelah dibuat. Anda dapat mengubah status sumber, titik akhir, kondisi, atau diaktifkan dari rute yang ada.

Gunakan perintah az iot hub message-route show untuk melihat detail rute.

az iot hub message-route show --hub-name {iothub_name} --route-name {route_name}

Gunakan perintah az iot hub message-route update untuk memperbarui properti rute. Misalnya, perintah berikut memperbarui sumber rute.

az iot hub message-route update --hub-name {iothub_name} --route-name {route_name} --source devicejoblifecycleevents

Menghapus rute IoT Hub

Gunakan perintah az iot hub message-route delete untuk menghapus rute dari hub IoT Anda.

Menghapus rute tidak menghapus titik akhirnya karena rute lain mungkin menunjuk ke titik akhir yang sama. Jika Anda ingin menghapus titik akhir, Anda dapat melakukannya secara terpisah dari menghapus rute.

az iot hub message-route delete --hub-name {iothub_name} --route-name {route_name}

Mengelola rute fallback

Rute fallback mengirim semua pesan dari devicemessages sumber yang tidak memenuhi kondisi kueri pada salah satu rute yang ada ke titik akhir bawaan.

Gunakan perintah az iot hub message-route fallback show untuk melihat status rute fallback di hub IoT Anda.

az iot hub message-route fallback show --hub-name {iothub_name}

Gunakan perintah az iot hub message-route fallback set untuk mengaktifkan atau menonaktifkan rute fallback di hub IoT Anda.

az iot hub message-route fallback set --hub-name {iothub_name} --enabled {true_false}

Langkah berikutnya

Dalam artikel panduan ini, Anda mempelajari cara membuat rute dan titik akhir untuk Azure Event Hubs, Bus Layanan antrean dan topik, dan Azure Storage.

Untuk mempelajari selengkapnya tentang perutean pesan, lihat Tutorial: Mengirim data perangkat ke Azure Storage dengan menggunakan perutean pesan IoT Hub. Dalam tutorial, Anda membuat rute penyimpanan dan mengujinya dengan perangkat di hub IoT Anda.

Bagikan melalui

Membuat dan menghapus rute dan titik akhir dengan menggunakan Azure CLI

Prasyarat

Azure CLI

IoT Hub

Layanan titik akhir

Buat titik akhir

Menghapus titik akhir

Membuat rute IoT Hub

Memperbarui rute IoT Hub

Menghapus rute IoT Hub

Mengelola rute fallback

Langkah berikutnya

Saran dan Komentar

Sumber Daya Tambahan: