az iot hub

Catatan

Grup perintah ini memiliki perintah yang ditentukan di Azure CLI dan setidaknya satu ekstensi. Instal setiap ekstensi untuk mendapatkan manfaat dari kemampuannya yang diperluas. Pelajari lebih lanjut tentang ekstensi.

Mengelola hub Azure IoT.

Perintah

Nama Deskripsi Jenis Status
az iot hub certificate

Kelola sertifikat IoT Hub.

Inti dan Ekstensi GA
az iot hub certificate create

Membuat/mengunggah sertifikat Azure IoT Hub.

Inti GA
az iot hub certificate delete

Menghapus sertifikat Azure IoT Hub.

Inti GA
az iot hub certificate generate-verification-code

Menghasilkan kode verifikasi untuk sertifikat Azure IoT Hub.

Inti GA
az iot hub certificate list

Mencantumkan semua sertifikat yang terkandung dalam Azure IoT Hub.

Inti GA
az iot hub certificate root-authority

Mengelola otoritas akar sertifikat untuk instans IoT Hub.

Ekstensi Tidak digunakan lagi
az iot hub certificate root-authority set

Atur otoritas akar sertifikat untuk instans IoT Hub ke versi tertentu.

Ekstensi Tidak digunakan lagi
az iot hub certificate root-authority show

Tampilkan otoritas akar sertifikat saat ini untuk instans IoT Hub.

Ekstensi Tidak digunakan lagi
az iot hub certificate show

Memperlihatkan informasi tentang sertifikat Azure IoT Hub tertentu.

Inti GA
az iot hub certificate update

Memperbarui sertifikat Azure IoT Hub.

Inti GA
az iot hub certificate verify

Memverifikasi sertifikat Azure IoT Hub.

Inti GA
az iot hub configuration

Mengelola konfigurasi manajemen perangkat otomatis IoT dalam skala besar.

Ekstensi GA
az iot hub configuration create

Buat konfigurasi manajemen perangkat otomatis IoT di IoT Hub target.

Ekstensi GA
az iot hub configuration delete

Menghapus konfigurasi perangkat IoT.

Ekstensi GA
az iot hub configuration list

Mencantumkan konfigurasi manajemen perangkat otomatis IoT di IoT Hub.

Ekstensi GA
az iot hub configuration show

Dapatkan detail konfigurasi manajemen perangkat otomatis IoT.

Ekstensi GA
az iot hub configuration show-metric

Mengevaluasi pengguna target atau metrik sistem yang ditentukan dalam konfigurasi perangkat IoT.

Ekstensi GA
az iot hub configuration update

Memperbarui properti yang ditentukan dari konfigurasi manajemen perangkat otomatis IoT.

Ekstensi GA
az iot hub connection-string

Mengelola string koneksi IoT Hub.

Ekstensi GA
az iot hub connection-string show

Tampilkan string koneksi untuk IoT Hub yang ditentukan menggunakan nama dan kunci kebijakan yang diberikan.

Ekstensi GA
az iot hub consumer-group

Mengelola grup konsumen pusat aktivitas dari hub IoT.

Inti GA
az iot hub consumer-group create

Membuat grup konsumen pusat aktivitas.

Inti GA
az iot hub consumer-group delete

Menghapus grup konsumen pusat aktivitas.

Inti GA
az iot hub consumer-group list

Mencantumkan grup konsumen pusat aktivitas.

Inti GA
az iot hub consumer-group show

Dapatkan detail untuk grup konsumen pusat aktivitas.

Inti GA
az iot hub create

Buat hub Azure IoT.

Inti GA
az iot hub delete

Menghapus hub IoT.

Inti GA
az iot hub device-identity

Mengelola perangkat IoT.

Ekstensi GA
az iot hub device-identity children

Mengelola hubungan perangkat anak-anak untuk perangkat edge IoT.

Ekstensi GA
az iot hub device-identity children add

Tambahkan perangkat sebagai turunan ke perangkat edge target.

Ekstensi GA
az iot hub device-identity children list

Menghasilkan kumpulan perangkat anak yang ditetapkan.

Ekstensi GA
az iot hub device-identity children remove

Hapus perangkat anak dari perangkat edge target.

Ekstensi GA
az iot hub device-identity connection-string

Mengelola string koneksi perangkat IoT.

Ekstensi GA
az iot hub device-identity connection-string show

Tampilkan string koneksi perangkat IoT Hub tertentu.

Ekstensi GA
az iot hub device-identity create

Membuat perangkat di IoT Hub.

Ekstensi GA
az iot hub device-identity delete

Menghapus perangkat IoT Hub.

Ekstensi GA
az iot hub device-identity export

Ekspor semua identitas perangkat dari IoT Hub ke kontainer blob Azure Storage.

Ekstensi GA
az iot hub device-identity import

Impor identitas perangkat ke IoT Hub dari blob kontainer penyimpanan.

Ekstensi GA
az iot hub device-identity list

Mencantumkan perangkat di IoT Hub.

Ekstensi GA
az iot hub device-identity parent

Mengelola hubungan perangkat induk untuk perangkat IoT.

Ekstensi GA
az iot hub device-identity parent set

Atur perangkat induk perangkat target.

Ekstensi GA
az iot hub device-identity parent show

Dapatkan perangkat induk perangkat target.

Ekstensi GA
az iot hub device-identity renew-key

Memperbarui kunci target perangkat IoT Hub dengan autentikasi sas.

Ekstensi GA
az iot hub device-identity show

Dapatkan detail perangkat IoT Hub.

Ekstensi GA
az iot hub device-identity update

Memperbarui perangkat IoT Hub.

Ekstensi GA
az iot hub device-twin

Mengelola konfigurasi device twin IoT.

Ekstensi GA
az iot hub device-twin list

Mencantumkan kembar perangkat di IoT Hub.

Ekstensi GA
az iot hub device-twin replace

Ganti definisi kembar perangkat dengan target json.

Ekstensi GA
az iot hub device-twin show

Dapatkan definisi kembar perangkat.

Ekstensi GA
az iot hub device-twin update

Perbarui properti dan tag yang diinginkan kembar perangkat.

Ekstensi GA
az iot hub devicestream

Mengelola aliran perangkat dari hub IoT.

Inti Pratinjau
az iot hub devicestream show

Dapatkan titik akhir aliran perangkat IoT Hub.

Inti Pratinjau
az iot hub digital-twin

Memanipulasi dan berinteraksi dengan kembar digital perangkat IoT Hub.

Ekstensi GA
az iot hub digital-twin invoke-command

Panggil perintah tingkat akar atau komponen dari perangkat kembar digital.

Ekstensi GA
az iot hub digital-twin show

Tampilkan kembar digital perangkat IoT Hub.

Ekstensi GA
az iot hub digital-twin update

Perbarui properti baca-tulis perangkat kembar digital melalui spesifikasi patch JSON.

Ekstensi GA
az iot hub distributed-tracing

Mengelola pengaturan terdistribusi per perangkat.

Ekstensi Pratinjau
az iot hub distributed-tracing show

Dapatkan pengaturan pelacakan terdistribusi untuk perangkat.

Ekstensi Pratinjau
az iot hub distributed-tracing update

Perbarui opsi pelacakan terdistribusi untuk perangkat.

Ekstensi Pratinjau
az iot hub generate-sas-token

Buat token SAS untuk IoT Hub target, perangkat, atau modul.

Ekstensi GA
az iot hub identity

Mengelola identitas hub Azure IoT.

Inti GA
az iot hub identity assign

Tetapkan identitas terkelola ke IoT Hub.

Inti GA
az iot hub identity remove

Menghapus identitas terkelola dari IoT Hub.

Inti GA
az iot hub identity show

Tampilkan properti identitas IoT Hub.

Inti GA
az iot hub invoke-device-method

Memanggil metode perangkat.

Ekstensi GA
az iot hub invoke-module-method

Panggil metode modul.

Ekstensi GA
az iot hub job

Mengelola pekerjaan IoT Hub (v2).

Ekstensi GA
az iot hub job cancel

Membatalkan pekerjaan IoT Hub.

Ekstensi GA
az iot hub job create

Membuat dan menjadwalkan pekerjaan IoT Hub untuk eksekusi.

Ekstensi GA
az iot hub job list

Mencantumkan pekerjaan historis IoT Hub.

Ekstensi GA
az iot hub job show

Menampilkan detail pekerjaan IoT Hub yang sudah ada.

Ekstensi GA
az iot hub list

Mencantumkan hub IoT.

Inti GA
az iot hub list-skus

Mencantumkan tingkat harga yang tersedia.

Inti GA
az iot hub manual-failover

Memulai failover manual untuk IoT Hub ke wilayah pemulihan bencana yang dipasangkan secara geografis.

Inti GA
az iot hub message-endpoint

Mengelola titik akhir kustom dari hub IoT.

Ekstensi Pratinjau
az iot hub message-endpoint create

Tambahkan titik akhir ke IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint create cosmosdb-container

Tambahkan titik akhir Kontainer Cosmos DB untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint create eventhub

Tambahkan titik akhir Pusat Aktivitas untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint create servicebus-queue

Tambahkan titik akhir antrean Bus Layanan untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint create servicebus-topic

Tambahkan titik akhir Topik Bus Layanan untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint create storage-container

Tambahkan titik akhir Kontainer Penyimpanan untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint delete

Hapus semua atau titik akhir tertentu untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint list

Dapatkan informasi tentang semua titik akhir untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint show

Dapatkan informasi tentang titik akhir yang disebutkan untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint update

Perbarui properti titik akhir yang ada untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint update cosmosdb-container

Perbarui properti titik akhir Kontainer Cosmos DB yang ada untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint update eventhub

Perbarui properti titik akhir Pusat Aktivitas yang ada untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint update servicebus-queue

Perbarui properti titik akhir antrean Bus Layanan yang ada untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint update servicebus-topic

Perbarui properti titik akhir Topik Bus Layanan yang sudah ada untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-endpoint update storage-container

Perbarui properti titik akhir Kontainer Penyimpanan yang ada untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-enrichment

Mengelola pengayaan pesan untuk titik akhir IoT Hub.

Inti GA
az iot hub message-enrichment create

Buat pengayaan pesan untuk titik akhir yang dipilih di IoT Hub Anda.

Inti GA
az iot hub message-enrichment delete

Hapus pengayaan pesan di hub IoT Anda (berdasarkan kunci).

Inti GA
az iot hub message-enrichment list

Dapatkan informasi tentang semua pengayaan pesan untuk IoT Hub Anda.

Inti GA
az iot hub message-enrichment update

Perbarui pengayaan pesan di hub IoT Anda (berdasarkan kunci).

Inti GA
az iot hub message-route

Mengelola rute hub IoT.

Ekstensi Pratinjau
az iot hub message-route create

Tambahkan rute untuk IoT Hub.

Ekstensi Pratinjau
az iot hub message-route delete

Hapus semua rute atau rute yang disebutkan di IoT Hub.

Ekstensi Pratinjau
az iot hub message-route fallback

Mengelola rute fallback hub IoT.

Ekstensi Pratinjau
az iot hub message-route fallback set

Mengaktifkan atau menonaktifkan rute fallback di IoT Hub.

Ekstensi Pratinjau
az iot hub message-route fallback show

Tampilkan rute fallback IoT Hub.

Ekstensi Pratinjau
az iot hub message-route list

Dapatkan semua rute di IoT Hub.

Ekstensi Pratinjau
az iot hub message-route show

Dapatkan informasi tentang rute di IoT Hub.

Ekstensi Pratinjau
az iot hub message-route test

Uji semua rute atau rute yang disebutkan di IoT Hub.

Ekstensi Pratinjau
az iot hub message-route update

Memperbarui rute untuk IoT Hub.

Ekstensi Pratinjau
az iot hub module-identity

Mengelola modul perangkat IoT.

Ekstensi GA
az iot hub module-identity connection-string

Mengelola string koneksi modul perangkat IoT.

Ekstensi GA
az iot hub module-identity connection-string show

Tampilkan modul perangkat IoT target string koneksi.

Ekstensi GA
az iot hub module-identity create

Buat modul pada perangkat IoT target di IoT Hub.

Ekstensi GA
az iot hub module-identity delete

Menghapus perangkat di IoT Hub.

Ekstensi GA
az iot hub module-identity list

Mencantumkan modul yang terletak di perangkat IoT di IoT Hub.

Ekstensi GA
az iot hub module-identity renew-key

Memperbarui kunci target modul perangkat IoT Hub dengan autentikasi sas.

Ekstensi GA
az iot hub module-identity show

Dapatkan detail modul perangkat IoT di IoT Hub.

Ekstensi GA
az iot hub module-identity update

Perbarui modul perangkat IoT Hub.

Ekstensi GA
az iot hub module-twin

Mengelola konfigurasi twin modul perangkat IoT.

Ekstensi GA
az iot hub module-twin replace

Ganti definisi kembar modul dengan json target.

Ekstensi GA
az iot hub module-twin show

Tampilkan definisi kembar modul.

Ekstensi GA
az iot hub module-twin update

Perbarui properti dan tag yang diinginkan kembar modul.

Ekstensi GA
az iot hub monitor-events

Pantau telemetri perangkat & pesan yang dikirim ke IoT Hub.

Ekstensi GA
az iot hub monitor-feedback

Memantau umpan balik yang dikirim oleh perangkat untuk menyetujui pesan cloud-to-device (C2D).

Ekstensi GA
az iot hub policy

Mengelola kebijakan akses bersama dari hub IoT.

Inti GA
az iot hub policy create

Buat kebijakan akses bersama baru di hub IoT.

Inti GA
az iot hub policy delete

Menghapus kebijakan akses bersama dari hub IoT.

Inti GA
az iot hub policy list

Mencantumkan kebijakan akses bersama hub IoT.

Inti GA
az iot hub policy renew-key

Meregenerasi kunci kebijakan akses bersama hub IoT.

Inti GA
az iot hub policy show

Dapatkan detail kebijakan akses bersama IoT hub.

Inti GA
az iot hub query

Buat kueri IoT Hub menggunakan bahasa seperti SQL yang kuat.

Ekstensi GA
az iot hub route

Mengelola rute hub IoT.

Inti Tidak digunakan lagi
az iot hub route create

Buat rute di IoT Hub.

Inti Tidak digunakan lagi
az iot hub route delete

Hapus semua atau rute yang disebutkan untuk IoT Hub Anda.

Inti Tidak digunakan lagi
az iot hub route list

Dapatkan semua rute di IoT Hub.

Inti Tidak digunakan lagi
az iot hub route show

Dapatkan informasi tentang rute di IoT Hub.

Inti Tidak digunakan lagi
az iot hub route test

Uji semua rute atau rute yang disebutkan di IoT Hub.

Inti Tidak digunakan lagi
az iot hub route update

Memperbarui rute di IoT Hub.

Inti Tidak digunakan lagi
az iot hub routing-endpoint

Mengelola titik akhir kustom dari hub IoT.

Inti Tidak digunakan lagi
az iot hub routing-endpoint create

Tambahkan titik akhir ke IoT Hub Anda.

Inti Tidak digunakan lagi
az iot hub routing-endpoint delete

Hapus semua atau titik akhir yang disebutkan untuk IoT Hub Anda.

Inti Tidak digunakan lagi
az iot hub routing-endpoint list

Dapatkan informasi tentang semua titik akhir untuk IoT Hub Anda.

Inti Tidak digunakan lagi
az iot hub routing-endpoint show

Dapatkan informasi tentang titik akhir yang disebutkan untuk IoT Hub Anda.

Inti Tidak digunakan lagi
az iot hub show

Dapatkan detail hub IoT.

Inti GA
az iot hub show-connection-string

Tampilkan string koneksi untuk hub IoT.

Inti Tidak digunakan lagi
az iot hub show-quota-metrics

Dapatkan metrik kuota untuk hub IoT.

Inti GA
az iot hub show-stats

Dapatkan statistik untuk hub IoT.

Inti GA
az iot hub state

Mengelola status IoT Hub.

Ekstensi Eksperimental
az iot hub state export

Ekspor status IoT Hub ke file.

Ekstensi Eksperimental
az iot hub state import

Impor status Hub dari file ke IoT Hub.

Ekstensi Eksperimental
az iot hub state migrate

Migrasikan status satu hub ke hub lain tanpa menyimpan ke file.

Ekstensi Eksperimental
az iot hub update

Memperbarui metadata untuk hub IoT.

Inti GA
az iot hub wait

Tunggu hingga operasi pada instans IoT Hub selesai.

Inti GA

az iot hub create

Buat hub Azure IoT.

Untuk pengenalan Azure IoT Hub, lihat https://docs.microsoft.com/azure/iot-hub/.

az iot hub create --name
                  --resource-group
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--dds {false, true}]
                  [--disable-local-auth {false, true}]
                  [--disable-module-sas {false, true}]
                  [--edr {false, true}]
                  [--fc]
                  [--fcs]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-lock-duration]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type {identityBased, keyBased}]
                  [--fileupload-storage-identity]
                  [--location]
                  [--mi-system-assigned {false, true}]
                  [--mi-user-assigned]
                  [--min-tls-version]
                  [--no-wait]
                  [--partition-count]
                  [--rd]
                  [--role]
                  [--scopes]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--tags]
                  [--unit]

Contoh

Buat IoT Hub dengan tingkat harga gratis F1, di wilayah grup sumber daya.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --sku F1 --partition-count 2

Buat IoT Hub dengan partisi S1 dan 4 tingkat harga standar, di wilayah 'westus', dengan tag.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --tags a=b c=d

Buat IoT Hub dengan identitas terkelola yang ditetapkan sistem, dan tetapkan peran dan cakupan ke akun penyimpanan untuk identitas yang dibuat.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --mi-system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

Membuat IoT Hub dengan autentikasi lokal, kunci SAS perangkat, dan kunci SAS modul semuanya dinonaktifkan

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --disable-local-auth --disable-device-sas --disable-module-sas

Buat IoT Hub dengan residensi data yang diberlakukan. Ini akan menonaktifkan pemulihan bencana lintas wilayah.

az iot hub create --resource-group MyResourceGroup --name MyIoTHub --edr

Parameter yang Diperlukan

--name -n

Nama IoT Hub.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Opsional

--c2d-max-delivery-count --cdd

Frekuensi hub IoT akan mencoba mengirimkan pesan cloud-ke-perangkat ke perangkat, antara 1 dan 100.

nilai default: 10
--c2d-ttl --ct

Jumlah waktu pesan tersedia untuk dikonsumsi perangkat sebelum kedaluwarsa oleh IoT Hub, antara 1 dan 48 jam.

nilai default: 1
--dds --disable-device-sas

Boolean yang menunjukkan apakah akan menonaktifkan semua perangkat (termasuk perangkat Edge atau tidak, tetapi tidak termasuk modul) yang mencakup kunci SAS untuk autentikasi.

nilai yang diterima: false, true
--disable-local-auth --dla

Boolean yang menunjukkan apakah akan menonaktifkan kunci SAS tercakup hub IoT untuk autentikasi atau tidak.

nilai yang diterima: false, true
--disable-module-sas --dms

Boolean yang menunjukkan apakah akan menonaktifkan kunci SAS cakupan modul untuk autentikasi atau tidak.

nilai yang diterima: false, true
--edr --enforce-data-residency

Terapkan residensi data untuk IoT Hub ini dengan menonaktifkan pemulihan bencana lintas wilayah. Properti ini tidak dapat diubah setelah diatur pada sumber daya. Hanya tersedia di wilayah tertentu. Pelajari lebih lanjut di https://aka.ms/iothubdisabledr.

nilai yang diterima: false, true
--fc --fileupload-storage-container-name

Nama kontainer akar tempat Anda mengunggah file. Kontainer tidak perlu ada tetapi harus dapat dikremasi menggunakan connectionString yang ditentukan.

--fcs --fileupload-storage-connectionstring

string koneksi untuk akun Azure Storage tempat file diunggah.

--fd --feedback-max-delivery-count

Frekuensi hub IoT mencoba mengirimkan pesan pada antrean umpan balik, antara 1 dan 100.

nilai default: 10
--feedback-lock-duration --fld

Durasi kunci untuk antrean umpan balik, antara 5 dan 300 detik.

nilai default: 5
--feedback-ttl --ft

Periode waktu di mana hub IoT akan mempertahankan umpan balik untuk kedaluwarsa atau pengiriman pesan cloud-ke-perangkat, antara 1 dan 48 jam.

nilai default: 1
--fileupload-notification-lock-duration --fnld

Durasi kunci untuk antrean pemberitahuan unggahan file, antara 5 dan 300 detik.

nilai default: 5
--fileupload-notification-max-delivery-count --fnd

Berapa kali hub IoT akan mencoba mengirimkan pesan pemberitahuan file, antara 1 dan 100.

nilai default: 10
--fileupload-notification-ttl --fnt

Jumlah waktu pemberitahuan pengunggahan file tersedia untuk digunakan layanan sebelum kedaluwarsa oleh IoT Hub, antara 1 dan 48 jam.

nilai default: 1
--fileupload-notifications --fn

Boolean yang menunjukkan apakah akan mencatat informasi tentang file yang diunggah ke titik akhir IoT Hub pesan/servicebound/filenotifications.

nilai yang diterima: false, true
nilai default: False
--fileupload-sas-ttl --fst

Jumlah waktu URI SAS yang dihasilkan oleh IoT Hub berlaku sebelum kedaluwarsa, antara 1 dan 24 jam.

nilai default: 1
--fileupload-storage-auth-type --fsa

Jenis autentikasi untuk akun Azure Storage tempat file diunggah.

nilai yang diterima: identityBased, keyBased
--fileupload-storage-identity --fsi

Identitas terkelola yang digunakan untuk autentikasi unggahan file. Gunakan '[system]' untuk merujuk ke identitas terkelola yang ditetapkan sistem atau ID sumber daya untuk merujuk ke identitas terkelola yang ditetapkan pengguna.

--location -l

Lokasi IoT Hub Anda. Default adalah lokasi grup sumber daya target.

--mi-system-assigned

Aktifkan identitas terkelola yang ditetapkan sistem untuk hub ini.

nilai yang diterima: false, true
--mi-user-assigned

Aktifkan identitas terkelola yang ditetapkan pengguna untuk hub ini. Terima daftar ID sumber daya identitas yang dipisahkan ruang.

--min-tls-version --mintls

Tentukan versi TLS minimum yang akan didukung untuk hub ini. Dapat diatur ke "1.2" agar klien yang menggunakan versi TLS di bawah 1.2 untuk ditolak.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False
--partition-count

Jumlah partisi Pusat Aktivitas dukungan untuk pesan perangkat-ke-cloud.

nilai default: 4
--rd --retention-day

Menentukan berapa lama hub IoT ini akan mempertahankan peristiwa perangkat ke cloud, antara 1 dan 7 hari.

nilai default: 1
--role

Peran untuk ditetapkan ke identitas terkelola yang ditetapkan sistem hub.

--scopes

Daftar ruang lingkup yang dipisahkan untuk menetapkan peran (--peran) untuk identitas terkelola yang ditetapkan sistem.

--sku

Tingkat harga untuk Azure IoT Hub. Perhatikan bahwa hanya satu instans hub IoT gratis (F1) yang diizinkan di setiap langganan. Pengecualian akan dilemparkan jika instans gratis melebihi satu instans.

nilai yang diterima: B1, B2, B3, F1, S1, S2, S3
nilai default: S1
--tags

Tag yang dipisahkan spasi: key[=value] [key[=value] ...]. Gunakan "" untuk menghapus tag yang ada.

--unit

Unit di IoT Hub Anda.

nilai default: 1
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub delete

Menghapus hub IoT.

az iot hub delete [--ids]
                  [--name]
                  [--no-wait]
                  [--resource-group]
                  [--subscription]

Contoh

Menghapus hub IoT. (dibuat otomatis)

az iot hub delete --name MyIoTHub --resource-group MyResourceGroup

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama IoT Hub.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub generate-sas-token

Buat token SAS untuk IoT Hub target, perangkat, atau modul.

Untuk token SAS perangkat, parameter kebijakan digunakan untuk mengakses registri perangkat saja. Oleh karena itu kebijakan harus memiliki akses baca ke registri. Untuk token IoT Hub, kebijakan adalah bagian dari SAS.

az iot hub generate-sas-token [--auth-type {key, login}]
                              [--connection-string]
                              [--device-id]
                              [--du]
                              [--hub-name]
                              [--key-type {primary, secondary}]
                              [--login]
                              [--module-id]
                              [--pn]
                              [--resource-group]

Contoh

Hasilkan token SAS IoT Hub menggunakan kebijakan iothubowner dan kunci primer.

az iot hub generate-sas-token -n {iothub_name}

Hasilkan token SAS IoT Hub menggunakan kebijakan registriRead dan kunci sekunder.

az iot hub generate-sas-token -n {iothub_name} --policy registryRead --key-type secondary

Buat token SAS perangkat menggunakan kebijakan iothubowner untuk mengakses registri perangkat {iothub_name}.

az iot hub generate-sas-token -d {device_id} -n {iothub_name}

Membuat token SAS perangkat menggunakan string koneksi IoT Hub (dengan akses registri)

az iot hub generate-sas-token -d {device_id} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Membuat token SAS Iot Hub menggunakan IoT Hub string koneksi

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Membuat token SAS Perangkat menggunakan string koneksi Perangkat

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Membuat token MODUL SAS menggunakan Modul string koneksi

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;ModuleId=mymodule;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Parameter Opsional

--auth-type

Menunjukkan apakah operasi harus memperoleh kunci kebijakan secara otomatis atau menggunakan sesi Azure ACTIVE Directory saat ini. Jika jenis autentikasi masuk dan nama host sumber daya disediakan, pencarian sumber daya akan dilewati kecuali diperlukan. Anda dapat mengonfigurasi default menggunakan az configure --defaults iothub-data-auth-type=<auth-type-value>.

nilai yang diterima: key, login
nilai default: key
--connection-string --cs

Target string koneksi. Ini melewati registri IoT Hub dan menghasilkan token SAS langsung dari kunci konten yang disediakan tanpa validasi lebih lanjut. Semua parameter perintah lainnya selain durasi akan diabaikan. Jenis string koneksi yang didukung: Iot Hub, Perangkat, Modul.

--device-id -d

Id Perangkat Target.

--du --duration

Durasi token yang valid dalam detik.

nilai default: 3600
--hub-name -n

Nama IoT Hub atau nama host. Diperlukan jika --login tidak disediakan.

--key-type --kt

Jenis kunci kebijakan akses bersama untuk autentikasi.

nilai yang diterima: primary, secondary
nilai default: primary
--login -l

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --hub-name tidak disediakan.

--module-id -m

Id Modul Target.

--pn --policy-name

Kebijakan akses bersama dengan izin operasi untuk entitas IoT Hub target.

nilai default: iothubowner
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub invoke-device-method

Memanggil metode perangkat.

az iot hub invoke-device-method --device-id
                                --method-name
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

Contoh

Panggil metode langsung pada perangkat.

az iot hub invoke-device-method --hub-name {iothub_name} --device-id {device_id} --method-name Reboot --method-payload '{"version":"1.0"}'

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

--method-name --mn

Metode target untuk pemanggilan.

Parameter Opsional

--auth-type

Menunjukkan apakah operasi harus memperoleh kunci kebijakan secara otomatis atau menggunakan sesi Azure ACTIVE Directory saat ini. Jika jenis autentikasi masuk dan nama host sumber daya disediakan, pencarian sumber daya akan dilewati kecuali diperlukan. Anda dapat mengonfigurasi default menggunakan az configure --defaults iothub-data-auth-type=<auth-type-value>.

nilai yang diterima: key, login
nilai default: key
--hub-name -n

Nama IoT Hub atau nama host. Diperlukan jika --login tidak disediakan.

--login -l

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --hub-name tidak disediakan.

--method-payload --mp

Payload Json yang akan diteruskan ke metode . Harus berupa jalur file atau json mentah.

nilai default: {}
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--timeout --to

Jumlah detik maksimum untuk menunggu hasil metode perangkat.

nilai default: 30
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub invoke-module-method

Panggil metode modul.

Perintah ini mendukung modul perangkat edge dan non-edge.

az iot hub invoke-module-method --device-id
                                --method-name
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

Contoh

Panggil metode langsung pada modul perangkat edge.

az iot hub invoke-module-method -n {iothub_name} -d {device_id} -m '$edgeAgent' --method-name 'RestartModule' --method-payload '{"schemaVersion": "1.0"}'

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

--method-name --mn

Metode target untuk pemanggilan.

--module-id -m

Id Modul Target.

Parameter Opsional

--auth-type

Menunjukkan apakah operasi harus memperoleh kunci kebijakan secara otomatis atau menggunakan sesi Azure ACTIVE Directory saat ini. Jika jenis autentikasi masuk dan nama host sumber daya disediakan, pencarian sumber daya akan dilewati kecuali diperlukan. Anda dapat mengonfigurasi default menggunakan az configure --defaults iothub-data-auth-type=<auth-type-value>.

nilai yang diterima: key, login
nilai default: key
--hub-name -n

Nama IoT Hub atau nama host. Diperlukan jika --login tidak disediakan.

--login -l

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --hub-name tidak disediakan.

--method-payload --mp

Payload Json yang akan diteruskan ke metode . Harus berupa jalur file atau json mentah.

nilai default: {}
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--timeout --to

Jumlah detik maksimum untuk menunggu hasil metode modul.

nilai default: 30
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub list

Mencantumkan hub IoT.

az iot hub list [--resource-group]

Contoh

Mencantumkan semua hub IoT dalam langganan.

az iot hub list

Mencantumkan semua hub IoT di grup sumber daya 'MyGroup'

az iot hub list --resource-group MyGroup

Parameter Opsional

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub list-skus

Mencantumkan tingkat harga yang tersedia.

az iot hub list-skus [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

Contoh

Mencantumkan tingkat harga yang tersedia. (dibuat otomatis)

az iot hub list-skus --name MyIoTHub

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama IoT Hub.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub manual-failover

Memulai failover manual untuk IoT Hub ke wilayah pemulihan bencana yang dipasangkan secara geografis.

az iot hub manual-failover [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]

Contoh

Mulai failover "myhub" dari wilayah primer ke sekunder.

az iot hub manual-failover -n myhub

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama IoT Hub.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub monitor-events

Pantau telemetri perangkat & pesan yang dikirim ke IoT Hub.

Perintah ini mengandalkan dan dapat menginstal paket Cython dependen (uamqp) setelah eksekusi pertama. https://github.com/Azure/azure-uamqp-python

Catatan: Peristiwa akan ditampilkan meskipun isi pesan tidak dapat didekodekan unicode, dalam hal ini bagian payload peristiwa akan ditampilkan sebagai {{non-decodable payload}} dengan properti peristiwa lainnya yang tersedia.

az iot hub monitor-events [--cg]
                          [--content-type]
                          [--device-id]
                          [--device-query]
                          [--enqueued-time]
                          [--hub-name]
                          [--interface]
                          [--login]
                          [--mc]
                          [--module-id]
                          [--properties {all, anno, app, sys}]
                          [--repair {false, true}]
                          [--resource-group]
                          [--timeout]
                          [--yes {false, true}]

Contoh

Penggunaan dasar

az iot hub monitor-events -n {iothub_name}

Penggunaan dasar dengan string koneksi IoT Hub

az iot hub monitor-events -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Penggunaan dasar saat memfilter pada perangkat target

az iot hub monitor-events -n {iothub_name} -d {device_id}

Penggunaan dasar saat memfilter perangkat yang ditargetkan dengan kartubebas dalam ID

az iot hub monitor-events -n {iothub_name} -d Device*

Memfilter perangkat menggunakan bahasa kueri IoT Hub

az iot hub monitor-events -n {iothub_name} -q "select * from devices where tags.location.region = 'US'"

Filter perangkat dan tentukan grup konsumen Event Hub yang akan diikat.

az iot hub monitor-events -n {iothub_name} -d {device_id} --cg {consumer_group_name}

Menerima anotasi pesan (header pesan)

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno

Menerima anotasi pesan + properti sistem. Jangan pernah kehabisan waktu.

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno sys --timeout 0

Menerima semua atribut pesan dari semua pesan perangkat

az iot hub monitor-events -n {iothub_name} --props all

Menerima semua pesan dan mengurai payload pesan sebagai JSON

az iot hub monitor-events -n {iothub_name} --content-type application/json

Terima jumlah pesan yang ditentukan dari hub lalu matikan.

az iot hub monitor-events -n {iothub_name} --message-count {message_count}

Parameter Opsional

--cg --consumer-group -c

Tentukan grup konsumen yang akan digunakan saat menyambungkan ke titik akhir pusat aktivitas.

nilai default: $Default
--content-type --ct

Tentukan Tipe Konten payload pesan untuk memformat output secara otomatis ke jenis tersebut.

--device-id -d

Id Perangkat Target.

--device-query -q

Tentukan kueri kustom untuk memfilter perangkat.

--enqueued-time --et -e

Menunjukkan waktu yang harus digunakan sebagai titik awal untuk membaca pesan dari partisi. Unit adalah milidetik sejak zaman unix. Jika tidak ada waktu yang ditunjukkan "sekarang" digunakan.

--hub-name -n

Nama IoT Hub atau nama host. Diperlukan jika --login tidak disediakan.

--interface -i

Pengidentifikasi antarmuka target untuk difilter. Misalnya: dtmi:com:example:TemperatureController;1.

--login -l

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --hub-name tidak disediakan.

--mc --message-count

Jumlah pesan telemetri yang akan diambil sebelum monitor dihentikan. Jika tidak ditentukan, pantau terus berjalan hingga memenuhi ambang batas waktu tidak menerima pesan dari hub.

--module-id -m

Id Modul Target.

--properties --props -p

Menunjukkan properti pesan kunci ke output. sys = properti sistem, aplikasi = properti aplikasi, ano = anotasi.

nilai yang diterima: all, anno, app, sys
--repair -r

Instal ulang dependensi uamqp yang kompatibel dengan versi ekstensi. Default: false.

nilai yang diterima: false, true
nilai default: False
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--timeout --to -t

Detik maksimum untuk mempertahankan koneksi tanpa menerima pesan. Gunakan 0 untuk tak terbatas.

nilai default: 300
--yes -y

Lewati permintaan pengguna. Menunjukkan penerimaan tindakan. Digunakan terutama untuk skenario otomatisasi. Default: false.

nilai yang diterima: false, true
nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub monitor-feedback

Memantau umpan balik yang dikirim oleh perangkat untuk menyetujui pesan cloud-to-device (C2D).

Perintah ini mengandalkan dan dapat menginstal paket Cython dependen (uamqp) setelah eksekusi pertama. https://github.com/Azure/azure-uamqp-python.

az iot hub monitor-feedback [--auth-type {key, login}]
                            [--device-id]
                            [--hub-name]
                            [--login]
                            [--repair {false, true}]
                            [--resource-group]
                            [--wait-on-msg]
                            [--yes {false, true}]

Contoh

Penggunaan dasar

az iot hub monitor-feedback -n {iothub_name}

Penggunaan dasar dengan string koneksi IoT Hub

az iot hub monitor-feedback -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Penggunaan dasar saat memfilter pada perangkat target

az iot hub monitor-feedback -n {iothub_name} -d {device_id}

Keluar dari monitor umpan balik saat menerima pesan dengan id tertentu (uuid)

az iot hub monitor-feedback -n {iothub_name} -d {device_id} -w {message_id}

Parameter Opsional

--auth-type

Menunjukkan apakah operasi harus memperoleh kunci kebijakan secara otomatis atau menggunakan sesi Azure ACTIVE Directory saat ini. Jika jenis autentikasi masuk dan nama host sumber daya disediakan, pencarian sumber daya akan dilewati kecuali diperlukan. Anda dapat mengonfigurasi default menggunakan az configure --defaults iothub-data-auth-type=<auth-type-value>.

nilai yang diterima: key, login
nilai default: key
--device-id -d

Id Perangkat Target.

--hub-name -n

Nama IoT Hub atau nama host. Diperlukan jika --login tidak disediakan.

--login -l

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --hub-name tidak disediakan.

--repair -r

Instal ulang dependensi uamqp yang kompatibel dengan versi ekstensi. Default: false.

nilai yang diterima: false, true
nilai default: False
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--wait-on-msg -w

Monitor umpan balik akan memblokir hingga pesan dengan id tertentu (uuid) diterima.

--yes -y

Lewati permintaan pengguna. Menunjukkan penerimaan tindakan. Digunakan terutama untuk skenario otomatisasi. Default: false.

nilai yang diterima: false, true
nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub query

Buat kueri IoT Hub menggunakan bahasa seperti SQL yang kuat.

Ambil informasi mengenai perangkat dan modul kembar, pekerjaan, dan perutean pesan. Lihat https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language untuk informasi lebih lanjut.

az iot hub query --query-command
                 [--auth-type {key, login}]
                 [--hub-name]
                 [--login]
                 [--resource-group]
                 [--top]

Contoh

Mengkueri semua data kembar perangkat di Azure IoT Hub.

az iot hub query -n {iothub_name} -q "select * from devices"

Kueri semua data kembar modul pada perangkat target.

az iot hub query -n {iothub_name} -q "select * from devices.modules where devices.deviceId = '{device_id}'"

Parameter yang Diperlukan

--query-command -q

Kueri pengguna yang akan dijalankan.

Parameter Opsional

--auth-type

Menunjukkan apakah operasi harus memperoleh kunci kebijakan secara otomatis atau menggunakan sesi Azure ACTIVE Directory saat ini. Jika jenis autentikasi masuk dan nama host sumber daya disediakan, pencarian sumber daya akan dilewati kecuali diperlukan. Anda dapat mengonfigurasi default menggunakan az configure --defaults iothub-data-auth-type=<auth-type-value>.

nilai yang diterima: key, login
nilai default: key
--hub-name -n

Nama IoT Hub atau nama host. Diperlukan jika --login tidak disediakan.

--login -l

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --hub-name tidak disediakan.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--top

Jumlah maksimum elemen yang akan dikembalikan. Secara default kueri tidak memiliki batas.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub show

Dapatkan detail hub IoT.

az iot hub show [--ids]
                [--name]
                [--resource-group]
                [--subscription]

Contoh

Dapatkan detail hub IoT. (dibuat otomatis)

az iot hub show --name MyIoTHub

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama IoT Hub.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub show-connection-string

Tidak digunakan lagi

Perintah ini tidak digunakan lagi dan akan dihapus dalam rilis mendatang. Gunakan perintah string koneksi 'IoT Extension (azure-iot) (az iot hub connection-string show)' sebagai gantinya.

Tampilkan string koneksi untuk hub IoT.

az iot hub show-connection-string [--all]
                                  [--hub-name]
                                  [--ids]
                                  [--key {primary, secondary}]
                                  [--policy-name]
                                  [--resource-group]
                                  [--subscription]

Contoh

Tampilkan string koneksi hub IoT menggunakan kebijakan default dan kunci primer.

az iot hub show-connection-string --name MyIotHub

Tampilkan string koneksi IoT Hub menggunakan kebijakan 'layanan' dan kunci sekunder.

az iot hub show-connection-string --name MyIotHub --policy-name service --key secondary

Tampilkan string koneksi untuk semua hub IoT dalam grup sumber daya.

az iot hub show-connection-string --resource-group MyResourceGroup

Tampilkan string koneksi untuk semua hub IoT dalam langganan.

az iot hub show-connection-string

Tampilkan string koneksi untuk hub IoT. (dibuat otomatis)

az iot hub show-connection-string --key primary --policy-name MyPolicy

Parameter Opsional

--all

Izinkan untuk menampilkan semua kebijakan akses bersama.

nilai default: False
--hub-name --name -n

Nama IoT Hub.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--key

Kunci yang akan digunakan.

nilai yang diterima: primary, secondary
nilai default: primary
--policy-name

Kebijakan akses bersama untuk digunakan.

nilai default: iothubowner
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub show-quota-metrics

Dapatkan metrik kuota untuk hub IoT.

az iot hub show-quota-metrics [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

Contoh

Dapatkan metrik kuota untuk hub IoT. (dibuat otomatis)

az iot hub show-quota-metrics --ids {ids}

Dapatkan metrik kuota untuk hub IoT. (dibuat otomatis)

az iot hub show-quota-metrics --name MyIoTHub

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama IoT Hub.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub show-stats

Dapatkan statistik untuk hub IoT.

az iot hub show-stats [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

Contoh

Dapatkan statistik untuk hub IoT. (dibuat otomatis)

az iot hub show-stats --name MyIoTHub

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama IoT Hub.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub update

Memperbarui metadata untuk hub IoT.

az iot hub update [--add]
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--dds {false, true}]
                  [--disable-local-auth {false, true}]
                  [--disable-module-sas {false, true}]
                  [--fc]
                  [--fcs]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-lock-duration]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type {identityBased, keyBased}]
                  [--fileupload-storage-identity]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--rd]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--subscription]
                  [--tags]
                  [--unit]

Contoh

Menambahkan pengaturan kontainer penyimpanan ke unggahan file

az iot hub update --name MyIotHub --fileupload-storage-connectionstring "connection-string" \ --fileupload-storage-container-name "container_name"

Tambahkan aturan filter firewall untuk menerima lalu lintas dari masker IP 127.0.0.0/31.

az iot hub update --name MyIotHub --add properties.ipFilterRules filter_name=test-rule action=Accept ip_mask=127.0.0.0/31

Memperbarui metadata untuk hub IoT. (dibuat otomatis)

az iot hub update --name MyIotHub --set properties.allocationPolicy="GeoLatency"

Memperbarui unit IoT Hub ke 2 dan menambahkan tag

az iot hub update -n MyIotHub --unit 2 --tags a=b c=d

Memperbarui tingkat harga untuk IoT Hub sebagai S2

az iot hub update -n MyIotHub --sku S2

Memperbarui hari retensi peristiwa perangkat-ke-cloud IoT Hub sebagai 3 hari

az iot hub update -n MyIotHub --retention-day 3

Memperbarui pengaturan olahpesan cloud-ke-perangkat IoT Hub

az iot hub update --name MyIotHub --c2d-max-delivery-count 30 --c2d-ttl 5

Memperbarui pengaturan antrean umpan balik IoT Hub

az iot hub update --name MyIoTHub --feedback-max-delivery-count 20 --feedback-lock-duration 100 --feedback-ttl 4

Perbarui pengaturan unggahan file IoT Hub, dan tetapkan identitas terkelola kepada pengguna untuk unggahan file

az iot hub update -n MyIoTHub --fileupload-sas-ttl 5 --fileupload-storage-auth-type identityBased --fileupload-storage-identity [system]

Memperbarui pengaturan pemberitahuan unggahan file IoT Hub dan durasi kunci antrean

az iot hub update -n MyIoTHub --fileupload-notification-max-delivery-count 50 --fileupload-notification-ttl 48 --fileupload-notifications --fileupload-notification-lock-duration 10

Memperbarui pengaturan SAS autentikasi lokal IoT Hub, SAS perangkat, dan modul

az iot hub update -n MyIoTHub --disable-local-auth --disable-device-sas false --disable-module-sas true

Parameter Opsional

--add

Tambahkan objek ke daftar objek dengan menentukan jalur dan pasangan nilai kunci. Contoh: --add property.listProperty <key=value, string or JSON string>.

nilai default: []
--c2d-max-delivery-count --cdd

Frekuensi hub IoT akan mencoba mengirimkan pesan cloud-ke-perangkat ke perangkat, antara 1 dan 100.

--c2d-ttl --ct

Jumlah waktu pesan tersedia untuk dikonsumsi perangkat sebelum kedaluwarsa oleh IoT Hub, antara 1 dan 48 jam.

--dds --disable-device-sas

Boolean yang menunjukkan apakah akan menonaktifkan semua perangkat (termasuk perangkat Edge atau tidak, tetapi tidak termasuk modul) yang mencakup kunci SAS untuk autentikasi.

nilai yang diterima: false, true
--disable-local-auth --dla

Boolean yang menunjukkan apakah akan menonaktifkan kunci SAS tercakup hub IoT untuk autentikasi atau tidak.

nilai yang diterima: false, true
--disable-module-sas --dms

Boolean yang menunjukkan apakah akan menonaktifkan kunci SAS cakupan modul untuk autentikasi atau tidak.

nilai yang diterima: false, true
--fc --fileupload-storage-container-name

Nama kontainer akar tempat Anda mengunggah file. Kontainer tidak perlu ada tetapi harus dapat dikremasi menggunakan connectionString yang ditentukan.

--fcs --fileupload-storage-connectionstring

string koneksi untuk akun Azure Storage tempat file diunggah.

--fd --feedback-max-delivery-count

Frekuensi hub IoT mencoba mengirimkan pesan pada antrean umpan balik, antara 1 dan 100.

--feedback-lock-duration --fld

Durasi kunci untuk antrean umpan balik, antara 5 dan 300 detik.

--feedback-ttl --ft

Periode waktu di mana hub IoT akan mempertahankan umpan balik untuk kedaluwarsa atau pengiriman pesan cloud-ke-perangkat, antara 1 dan 48 jam.

--fileupload-notification-lock-duration --fnld

Durasi kunci untuk antrean pemberitahuan unggahan file, antara 5 dan 300 detik.

--fileupload-notification-max-delivery-count --fnd

Berapa kali hub IoT akan mencoba mengirimkan pesan pemberitahuan file, antara 1 dan 100.

--fileupload-notification-ttl --fnt

Jumlah waktu pemberitahuan pengunggahan file tersedia untuk digunakan layanan sebelum kedaluwarsa oleh IoT Hub, antara 1 dan 48 jam.

--fileupload-notifications --fn

Boolean yang menunjukkan apakah akan mencatat informasi tentang file yang diunggah ke titik akhir IoT Hub pesan/servicebound/filenotifications.

nilai yang diterima: false, true
--fileupload-sas-ttl --fst

Jumlah waktu URI SAS yang dihasilkan oleh IoT Hub berlaku sebelum kedaluwarsa, antara 1 dan 24 jam.

--fileupload-storage-auth-type --fsa

Jenis autentikasi untuk akun Azure Storage tempat file diunggah.

nilai yang diterima: identityBased, keyBased
--fileupload-storage-identity --fsi

Identitas terkelola yang digunakan untuk autentikasi unggahan file. Gunakan '[system]' untuk merujuk ke identitas terkelola yang ditetapkan sistem atau ID sumber daya untuk merujuk ke identitas terkelola yang ditetapkan pengguna.

--force-string

Saat menggunakan 'set' atau 'add', pertahankan literal string alih-alih mencoba mengonversi ke JSON.

nilai default: False
--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama IoT Hub.

--rd --retention-day

Menentukan berapa lama hub IoT ini akan mempertahankan peristiwa perangkat ke cloud, antara 1 dan 7 hari.

--remove

Menghapus properti atau elemen dari daftar. Contoh: --remove property.list <indexToRemove> ATAU --remove propertyToRemove.

nilai default: []
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--set

Perbarui objek dengan menentukan jalur properti dan nilai yang akan diatur. Contoh: --set property1.property2=<value>.

nilai default: []
--sku

Tingkat harga untuk Azure IoT Hub. Perhatikan bahwa hanya satu instans hub IoT gratis (F1) yang diizinkan di setiap langganan. Pengecualian akan dilemparkan jika instans gratis melebihi satu instans.

nilai yang diterima: B1, B2, B3, F1, S1, S2, S3
--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--tags

Tag yang dipisahkan spasi: key[=value] [key[=value] ...]. Gunakan "" untuk menghapus tag yang ada.

--unit

Unit di IoT Hub Anda.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot hub wait

Tunggu hingga operasi pada instans IoT Hub selesai.

az iot hub wait [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--ids]
                [--interval]
                [--name]
                [--resource-group]
                [--subscription]
                [--timeout]
                [--updated]

Contoh

Tunggu hingga instans IoT Hub yang ada dibuat

az iot hub wait -n MyIoTHub --created

Tunggu hingga instans IoT Hub dihapus

az iot hub wait -n MyIoTHub --deleted

Tunggu hingga instans IoT Hub yang ada memiliki status Aktif

az iot hub wait -n MyIoTHub --custom "properties.state=='Active'"

Parameter Opsional

--created

Tunggu hingga dibuat dengan 'provisioningState' di 'Berhasil'.

nilai default: False
--custom

Tunggu hingga kondisi memenuhi kueri JMESPath kustom. Misalnya provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Tunggu hingga dihapus.

nilai default: False
--exists

Tunggu hingga sumber daya ada.

nilai default: False
--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--interval

Interval polling dalam hitungan detik.

nilai default: 30
--name -n

Nama IoT Hub.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--timeout

Tunggu maksimum dalam detik.

nilai default: 3600
--updated

Tunggu hingga diperbarui dengan provisioningState di 'Berhasil'.

nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.