az iot edge deployment

  • Referensi

Catatan

Referensi ini adalah bagian dari ekstensi azure-iot untuk Azure CLI (versi 2.37.0 atau yang lebih tinggi). Ekstensi akan secara otomatis menginstal pertama kali Anda menjalankan perintah penyebaran az iot edge. Pelajari lebih lanjut tentang ekstensi.

Mengelola penyebaran IoT Edge dalam skala besar.

Perintah

Nama Deskripsi Jenis Status
az iot edge deployment create

Buat penyebaran IoT Edge di IoT Hub target.

 Ekstensi GA
az iot edge deployment delete

Menghapus penyebaran IoT Edge.

 Ekstensi GA
az iot edge deployment list

Mencantumkan penyebaran IoT Edge di IoT Hub.

 Ekstensi GA
az iot edge deployment show

Dapatkan detail penyebaran IoT Edge.

 Ekstensi GA
az iot edge deployment show-metric

Mengevaluasi metrik sistem target yang ditentukan dalam penyebaran IoT Edge.

 Ekstensi GA
az iot edge deployment update

Memperbarui properti penyebaran IoT Edge yang ditentukan.

 Ekstensi GA

az iot edge deployment create

Buat penyebaran IoT Edge di IoT Hub target.

Konten penyebaran adalah json dan dalam bentuk {"modulesContent":{...}} atau {"content":{"modulesContent":{...}}}.

Secara default properti modul sistem $edgeAgent dan $edgeHub divalidasi terhadap skema yang diinstal dengan ekstensi IoT. Validasi ini ditujukan untuk penyebaran dasar. Jika skema yang sesuai tidak tersedia atau format penyebaran dasar tidak terdeteksi, langkah ini akan dilewati. Validasi skema dapat dinonaktifkan dengan menggunakan sakelar --no-validation.

Penyebaran tepi diklasifikasikan sebagai berlapis jika modul memiliki properties.desired.* yang ditentukan. Perangkat edge apa pun yang ditargetkan oleh penyebaran berlapis, pertama-tama perlu penyebaran dasar yang diterapkan padanya.

Setiap penyebaran berlapis yang menargetkan perangkat harus memiliki prioritas yang lebih tinggi daripada penyebaran dasar untuk perangkat tersebut.

Catatan: Jika bidang properties.desired dari kembar modul diatur dalam penyebaran berlapis, properties.desired akan menimpa properti yang diinginkan untuk modul tersebut dalam penyebaran prioritas yang lebih rendah.

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--cl]
                              [--cmq]
                              [--hub-name]
                              [--lab]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri]
                              [--resource-group]
                              [--target-condition]

Contoh

Buat penyebaran dengan label (contoh sintaks bash) yang berlaku untuk perangkat di 'building 9' dan lingkungannya adalah 'test'.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels '{"key0":"value0", "key1":"value1"}' --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Buat penyebaran dengan label (contoh sintaks powershell) yang berlaku untuk perangkat yang ditandai dengan lingkungan 'dev'.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels "{'key':'value'}" --target-condition "tags.environment='dev'"

Buat penyebaran berlapis yang berlaku untuk perangkat yang ditandai dengan lingkungan 'dev'. Metrik pengguna dan konten modul yang ditentukan sebaris (contoh sintaks powershell). Perhatikan bahwa ini dalam format penyebaran berlapis sebagai properties.desired.* telah ditentukan.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content "{'modulesContent':{'`$edgeAgent':{
  'properties.desired.modules.mymodule0':{ }},'`$edgeHub':{'properties.desired.routes.myroute0':'FROM /messages/* INTO `$upstream'}}}"
--target-condition "tags.environment='dev'" --priority 10 --metrics "{'queries':{'mymetrik':'SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200'}}"

Buat penyebaran berlapis yang berlaku untuk perangkat di 'building 9' dan environment 'test'. Konten metrik dan modul pengguna yang ditentukan sebaris (contoh sintaks bash). Perhatikan bahwa ini dalam format penyebaran berlapis sebagai properties.desired.* telah ditentukan.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content '{"modulesContent":{"$edgeAgent":{"properties.desired.modules.mymodule0":{ }},"$edgeHub":{"properties.desired.routes.myroute0":"FROM /messages/* INTO $upstream"}}}' --target-condition "tags.building=9 and tags.environment='test'" --metrics '{"queries":{"mymetrik":"SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200"}}'

Buat penyebaran yang berlaku untuk perangkat di 'build 9' dan lingkungan 'uji'. Metrik pengguna dan konten modul yang ditentukan dari file.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics ./metrics_content.json

Buat penyebaran yang definisinya berasal dari file dengan input label dan metrik shell-agnostik.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --custom-labels key0=value0 key1=value1 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Parameter yang Diperlukan

--content -k

Konten penyebaran IoT Edge. Berikan jalur file atau json mentah.

--deployment-id -d

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

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

--lab --labels

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

--layered

Penyebaran berlapis memungkinkan Anda menentukan properti yang diinginkan dalam modul $edgeAgent, $edgeHub, dan pengguna yang akan melapisi di atas penyebaran dasar. Properti yang ditentukan dalam penyebaran berlapis akan bergabung dengan properti penyebaran dasar. Properti dengan jalur yang sama akan ditimpa berdasarkan prioritas penyebaran. Opsi ini adalah alias untuk --no-validation.

nilai yang diterima: false, true
nilai default: False
--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.

--metrics -m

Definisi metrik pengguna penyebaran IoT Edge. Berikan jalur file atau json mentah. Metrik pengguna dalam bentuk {"kueri":{...}} atau {"metrics":{"queries":{...}}}. Menggunakan --custom-metric-queries alih-alih --metrics disarankan.

--no-validation

Menonaktifkan validasi skema sisi klien untuk pembuatan penyebaran tepi.

nilai yang diterima: false, true
nilai default: False
--pri --priority

Berat penyebaran jika terjadi aturan yang bersaing (kemenangan tertinggi).

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 penyebaran tepi berlaku. Penyebaran tanpa kondisi target tidak akan menargetkan perangkat. Gunakan format berikut: "tags.environment='test'".

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 edge deployment delete

Menghapus penyebaran IoT Edge.

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

Parameter yang Diperlukan

--deployment-id -d

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

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

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

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 edge deployment list

Mencantumkan penyebaran IoT Edge di IoT Hub.

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

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 penyebaran yang akan dikembalikan. Secara default semua penyebaran dikembalikan.

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 edge deployment show

Dapatkan detail penyebaran IoT Edge.

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

Parameter yang Diperlukan

--deployment-id -d

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

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

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 edge deployment show-metric

Mengevaluasi metrik sistem target yang ditentukan dalam penyebaran IoT Edge.

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

Contoh

Mengevaluasi metrik sistem 'appliedCount'

az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system

Mengevaluasi metrik pengguna 'myCustomMetric'

az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}

Parameter yang Diperlukan

--deployment-id -d

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

--metric-id -m

Metrik target untuk evaluasi.

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.

--metric-type --mt

Menunjukkan kumpulan metrik mana yang harus digunakan untuk mencari metrik.

nilai yang diterima: system, user
nilai default: user
--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 edge deployment update

Memperbarui properti penyebaran IoT Edge yang ditentukan.

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

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

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

Contoh

Mengubah label dan kondisi target penyebaran tepi yang ada

az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'

Parameter yang Diperlukan

--deployment-id -d

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

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: []
--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
--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.

nilai default: False
--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.

--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: []
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.