Bagikan melalui

az iot edge devices

  • Referensi

Catatan

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

Perintah untuk mengelola perangkat IoT Edge.

Perintah

Nama Deskripsi Jenis Status
az iot edge devices create

Membuat dan mengonfigurasi beberapa perangkat edge di IoT Hub.

 Ekstensi Eksperimental

az iot edge devices create

Eksperimental

Perintah ini bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Membuat dan mengonfigurasi beberapa perangkat edge di IoT Hub.

Operasi ini menerima argumen perangkat sebaris atau file konfigurasi perangkat edge dalam format YAML atau JSON. Arg perintah sebaris (seperti '--device-auth') akan diutamakan dan mengambil alih properti file konfigurasi jika disediakan. File konfigurasi sampel dapat ditemukan di sini: https://aka.ms/aziotcli-edge-devices-config Tinjau contoh dan deskripsi parameter untuk detail tentang cara sepenuhnya menggunakan operasi ini.

az iot edge devices create [--auth-type {key, login}]
                           [--cfg]
                           [--clean {false, true}]
                           [--dct]
                           [--dea]
                           [--device]
                           [--device-auth {shared_private_key, x509_thumbprint}]
                           [--hub-name]
                           [--login]
                           [--out]
                           [--rc]
                           [--resource-group]
                           [--rk]
                           [--root-pass]
                           [--vis {false, true}]
                           [--yes {false, true}]

Contoh

Membuat beberapa perangkat edge menggunakan autentikasi kunci konten (default)

az iot edge devices create -n {hub_name} --device id=device_1 --device id=device_2

Buat daftar datar perangkat edge menggunakan autentikasi sertifikat yang ditandatangani sendiri dengan berbagai konfigurasi properti edge, menggunakan argumen sebaris.

az iot edge devices create -n {hub_name} --device-auth x509_thumbprint --default-edge-agent "mcr.microsoft.com/azureiotedge-agent:1.4"
--device id=device_1 hostname={FQDN}
--device id=device_2 edge_agent={agent_image}
--device id=parent hostname={FQDN} edge_agent={agent_image} container_auth={path_or_json_string}

Hapus semua identitas perangkat yang ada di hub dan buat perangkat baru berdasarkan file konfigurasi (dengan bilah kemajuan dan output visualisasi).

az iot edge devices create -n {hub_name} --cfg path/to/config_yml_or_json -c -v

Buat sekelompok perangkat edge berlapis dengan penyebaran modul kustom - berisi 2 perangkat induk dengan masing-masing 1 perangkat anak, menggunakan argumen sebaris. Juga menentukan jalur output untuk bundel sertifikat perangkat.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--device id=parent_1 deployment=/path/to/parentDeployment_1.json
--device id=child_1 parent=parent_1 deployment=/path/to/child_deployment_1.json
--device id=parent_2 deployment=/path/to/parentDeployment_2.json
--device id=child_2 parent=parent_2 deployment=/path/to/child_deployment_2.json

Buat konfigurasi perangkat edge berlapis sederhana dengan CA akar yang ada, menggunakan autentikasi x509, dan tentukan jalur output bundel perangkat kustom.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--root-cert "root_cert.pem" --root-key "root_key.pem" --device-auth x509_thumbprint
--device id=parent1
--device id=child1 parent=parent1

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
--cfg --config --config-file

Jalur ke file konfigurasi perangkat. Contoh file konfigurasi: https://aka.ms/aziotcli-edge-devices-config.

--clean -c

Menghapus semua perangkat di hub target sebelum membuat perangkat baru.

Nilai yang diterima: false, true
Nilai default: False
--dct --device-config-template

Jalur ke file IoT Edge config.toml untuk digunakan sebagai dasar konfigurasi perangkat edge.

--dea --default-agent --default-edge-agent

Agen tepi default untuk perangkat Edge yang dibuat jika tidak ditentukan satu per satu.

--device -d

Pasangan kunci=nilai yang dipisahkan spasi yang sesuai dengan properti perangkat edge yang akan dibuat. Nilai kunci berikut didukung: id (device_id), deployment (json sebaris atau jalur ke file), hostname, parent (device_id), edge_agent (URL gambar), dan container_auth (json sebaris atau jalur ke file). --device dapat digunakan 1 kali atau lebih. Tinjau contoh bantuan untuk penggunaan parameter lengkap - parameter ini juga merujuk ke nilai yang sesuai dalam file konfigurasi sampel kami: https://aka.ms/aziotcli-edge-devices-config.

--device-auth --device-auth-type

Mekanisme otorisasi perangkat ke hub.

Nilai yang diterima: shared_private_key, x509_thumbprint
--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.

--out --output-path

Jalur direktori ke bundel konfigurasi perangkat output. Jika nilai ini tidak ditentukan, tidak ada output file yang akan dibuat.

--rc --root-cert

Jalur ke sertifikat kunci publik root untuk menandatangani sertifikat perangkat edge berlapis.

--resource-group -g

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

--rk --root-key

Jalur ke akar kunci privat untuk menandatangani sertifikat perangkat edge berlapis.

--root-pass --rp

Kata sandi kunci akar.

--vis --visualize -v

Menampilkan visualisasi perangkat dan kemajuan berbagai tugas (pembuatan perangkat, mengatur orang tua, memperbarui konfigurasi, dll).

Nilai yang diterima: false, true
Nilai default: False
--yes -y

Jangan meminta konfirmasi ketika --clean switch digunakan untuk menghapus perangkat hub yang ada.

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.