Bagikan melalui

az iot hub configuration

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). Ekstensi akan secara otomatis menginstal pertama kali Anda menjalankan perintah konfigurasi hub az iot. Learn more about extensions.

Mengelola konfigurasi manajemen perangkat otomatis IoT dalam skala besar.

Perintah

Nama Deskripsi Jenis Status
az iot hub configuration create

Buat konfigurasi manajemen perangkat otomatis IoT di IoT Hub target.

 Extension GA
az iot hub configuration delete

Menghapus konfigurasi perangkat IoT.

 Extension GA
az iot hub configuration list

Mencantumkan konfigurasi manajemen perangkat otomatis IoT di IoT Hub.

 Extension GA
az iot hub configuration show

Dapatkan detail konfigurasi manajemen perangkat otomatis IoT.

 Extension GA
az iot hub configuration show-metric

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

 Extension GA
az iot hub configuration update

Memperbarui properti yang ditentukan dari konfigurasi manajemen perangkat otomatis IoT.

 Extension GA

az iot hub configuration create

Buat konfigurasi manajemen perangkat otomatis IoT di IoT Hub target.

Konten konfigurasi adalah json dan sedikit bervariasi berdasarkan niat perangkat atau modul.

Konfigurasi perangkat dalam bentuk {"deviceContent":{...}} or {"content":{"deviceContent":{...}}}

Konfigurasi modul dalam bentuk {"moduleContent":{...}} or {"content":{"moduleContent":{...}}}

Konfigurasi dapat ditentukan dengan metrik yang disediakan pengguna untuk evaluasi sesuai permintaan. Metrik pengguna adalah json dan dalam bentuk {"kueri":{...}} or {"metrics":{"queries":{...}}}.

Catatan: Kondisi target untuk modul harus dimulai dengan "from devices.modules where".

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--cl --custom-labels]
                                [--cmq --custom-metric-queries]
                                [--hub-name]
                                [--lab --labels]
                                [--login]
                                [--metrics]
                                [--pri --priority]
                                [--resource-group]
                                [--target-condition --tc]

Contoh

Buat konfigurasi perangkat dengan prioritas 3 yang berlaku pada kondisi saat perangkat ditandai dalam bangunan 9 dan lingkungannya adalah 'uji'.

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Buat konfigurasi perangkat dengan label dan berikan metrik pengguna sebaris (contoh sintaks bash).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9" --labels '{"key0":"value0", "key1":"value1"}' --priority 10 --metrics '{"metrics": {"queries": {"mymetric": "select deviceId from devices where tags.location='US'"}}}'

Membuat konfigurasi modul dengan label dan menyediakan metrik pengguna sebaris (contoh sintaks cmd)

az iot hub configuration create -c {config_name} -n {iothub_name} --content module_content.json --target-condition "from devices.modules where tags.building=9" --labels "{\"key0\":\"value0\", \"key1\":\"value1\"}" --metrics "{\"metrics\": {\"queries\": {\"mymetric\": \"select moduleId from devices.modules where tags.location='US'\"}}}"

Buat konfigurasi modul dengan konten dan metrik pengguna sebaris (contoh sintaks powershell).

az iot hub configuration create -c {config_name} -n {iothub_name} --content '{\"moduleContent\": {\"properties.desired.chillerWaterSettings\": {\"temperature\": 38, \"pressure\": 78}}}' --target-condition "from devices.modules where tags.building=9" --priority 1 --metrics '{\"metrics\": {\"queries\": {\"mymetric\":\"select moduleId from devices.modules where tags.location=''US''\"}}}'

Buat konfigurasi perangkat dengan gaya input label dan metrik alternatif (shell agnostic).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "from devices.modules where tags.building=9" --custom-labels key0="value0" key1="value1" --priority 10 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Parameter yang Diperlukan

--config-id -c

Nama konfigurasi perangkat target. Huruf kecil dan karakter khusus berikut diperbolehkan: [-+%_*!'].

--content -k

Konten konfigurasi perangkat. Berikan jalur file atau json mentah.

Parameter Opsional

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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}.

Properti Nilai
Parameter group: Access Control Arguments
Nilai default: key
Nilai yang diterima: key, login
--cl --custom-labels

Gaya input alternatif (pasangan kunci=nilai yang dipisahkan spasi) untuk --label dan dimaksudkan untuk menggantinya di masa mendatang. Contoh format: key1=value1 key2="this is my value".

--cmq --custom-metric-queries

Gaya input alternatif (pasangan kunci=nilai yang dipisahkan spasi) untuk --metrik dan dimaksudkan untuk menggantinya di masa mendatang. Contoh format: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--hub-name -n

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

Properti Nilai
Parameter group: IoT Hub Identifier Arguments
--lab --labels

Peta label yang akan diterapkan ke konfigurasi target. Menggunakan --custom-labels alih-alih --label disarankan. Contoh format: {"key0":"value0", "key1":"value1"}.

--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.

Properti Nilai
Parameter group: IoT Hub Identifier Arguments
--metrics -m

Definisi metrik konfigurasi perangkat. Berikan jalur file atau json mentah. Menggunakan --custom-metric-queries alih-alih --metrics disarankan.

--pri --priority

Bobot konfigurasi perangkat jika ada aturan yang bersaing (kemenangan tertinggi).

Properti Nilai
Nilai default: 0
--resource-group -g

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

--target-condition --tc -t

Kondisi target tempat konfigurasi perangkat atau modul berlaku. Konfigurasi tanpa kondisi target tidak akan menargetkan perangkat atau modul. Gunakan format berikut: "tags.environment='test'".

Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Output format.

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

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False

az iot hub configuration delete

Menghapus konfigurasi perangkat IoT.

az iot hub configuration delete --config-id
                                [--auth-type {key, login}]
                                [--etag]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parameter yang Diperlukan

--config-id -c

Nama konfigurasi perangkat target. Huruf kecil dan karakter khusus berikut diperbolehkan: [-+%_*!'].

Parameter Opsional

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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}.

Properti Nilai
Parameter group: Access Control Arguments
Nilai default: key
Nilai yang diterima: key, login
--etag -e

Tag Etag atau entitas yang sesuai dengan status terakhir sumber daya. Jika tidak ada etag yang disediakan, nilai '*' digunakan.

--hub-name -n

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

Properti Nilai
Parameter group: IoT Hub Identifier Arguments
--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.

Properti Nilai
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

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

Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Output format.

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

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False

az iot hub configuration list

Mencantumkan konfigurasi manajemen perangkat otomatis IoT di IoT Hub.

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

Parameter Opsional

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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}.

Properti Nilai
Parameter group: Access Control Arguments
Nilai default: key
Nilai yang diterima: key, login
--hub-name -n

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

Properti Nilai
Parameter group: IoT Hub Identifier Arguments
--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.

Properti Nilai
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

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

--top

Jumlah maksimum konfigurasi yang akan dikembalikan. Secara default semua konfigurasi dikembalikan.

Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Output format.

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

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False

az iot hub configuration show

Dapatkan detail konfigurasi manajemen perangkat otomatis IoT.

az iot hub configuration show --config-id
                              [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]

Parameter yang Diperlukan

--config-id -c

Nama konfigurasi perangkat target. Huruf kecil dan karakter khusus berikut diperbolehkan: [-+%_*!'].

Parameter Opsional

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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}.

Properti Nilai
Parameter group: Access Control Arguments
Nilai default: key
Nilai yang diterima: key, login
--hub-name -n

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

Properti Nilai
Parameter group: IoT Hub Identifier Arguments
--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.

Properti Nilai
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

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

Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Output format.

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

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False

az iot hub configuration show-metric

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

az iot hub configuration show-metric --config-id
                                     --metric-id
                                     [--auth-type {key, login}]
                                     [--hub-name]
                                     [--login]
                                     [--metric-type --mt {system, user}]
                                     [--resource-group]

Contoh

Mengevaluasi metrik 'warningLimit' yang ditentukan pengguna

az iot hub configuration show-metric -m warningLimit -c {configuration_name} -n {iothub_name}

Mengevaluasi metrik sistem 'appliedCount'

az iot hub configuration show-metric --metric-id appliedCount -c {configuration_name} -n {iothub_name} --metric-type system

Parameter yang Diperlukan

--config-id -c

Nama konfigurasi perangkat target. Huruf kecil dan karakter khusus berikut diperbolehkan: [-+%_*!'].

--metric-id -m

Metrik target untuk evaluasi.

Parameter Opsional

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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}.

Properti Nilai
Parameter group: Access Control Arguments
Nilai default: key
Nilai yang diterima: key, login
--hub-name -n

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

Properti Nilai
Parameter group: IoT Hub Identifier Arguments
--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.

Properti Nilai
Parameter group: IoT Hub Identifier Arguments
--metric-type --mt

Menunjukkan kumpulan metrik mana yang harus digunakan untuk mencari metrik.

Properti Nilai
Nilai default: user
Nilai yang diterima: system, user
--resource-group -g

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

Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Output format.

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

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False

az iot hub configuration update

Memperbarui properti yang ditentukan dari konfigurasi manajemen perangkat otomatis IoT.

Gunakan --set diikuti oleh penetapan properti untuk memperbarui konfigurasi.

Catatan: Konten konfigurasi tidak dapat diubah. Properti konfigurasi yang dapat diperbarui adalah 'label', 'metrik', 'prioritas' dan 'targetCondition'.

az iot hub configuration update --config-id
                                [--add]
                                [--auth-type {key, login}]
                                [--etag]
                                [--force-string]
                                [--hub-name]
                                [--login]
                                [--remove]
                                [--resource-group]
                                [--set]

Contoh

Mengubah prioritas konfigurasi perangkat dan memperbarui kondisi targetnya

az iot hub configuration update -c {configuration_name} -n {iothub_name} --set priority=10 targetCondition="tags.building=43 and tags.environment='dev'"

Parameter yang Diperlukan

--config-id -c

Nama konfigurasi perangkat target. Huruf kecil dan karakter khusus berikut diperbolehkan: [-+%_*!'].

Parameter Opsional

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

Properti Nilai
Parameter group: Generic Update Arguments
Nilai default: []
--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}.

Properti Nilai
Parameter group: Access Control Arguments
Nilai default: key
Nilai yang diterima: key, login
--etag -e

Tag Etag atau entitas yang sesuai dengan status terakhir sumber daya. Jika tidak ada etag yang disediakan, nilai '*' digunakan.

--force-string

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

Properti Nilai
Parameter group: Generic Update Arguments
Nilai default: False
--hub-name -n

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

Properti Nilai
Parameter group: IoT Hub Identifier Arguments
--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.

Properti Nilai
Parameter group: IoT Hub Identifier Arguments
--remove

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

Properti Nilai
Parameter group: Generic Update Arguments
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>.

Properti Nilai
Parameter group: Generic Update Arguments
Nilai default: []
Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Output format.

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

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False