az iot hub job

  • 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 pekerjaan az iot hub. Pelajari lebih lanjut tentang ekstensi.

Mengelola pekerjaan IoT Hub (v2).

Perintah

Nama Deskripsi Jenis Status
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 job cancel

Membatalkan pekerjaan IoT Hub.

az iot hub job cancel --job-id
                      [--auth-type {key, login}]
                      [--hub-name]
                      [--login]
                      [--resource-group]

Contoh

Membatalkan pekerjaan IoT Hub.

az iot hub job cancel --hub-name {iothub_name} --job-id {job_id}

Parameter yang Diperlukan

--job-id

Id pekerjaan IoT Hub.

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 hub job create

Membuat dan menjadwalkan pekerjaan IoT Hub untuk eksekusi.

Saat menjadwalkan pekerjaan pembaruan kembar, patch kembar adalah argumen yang diperlukan. Saat menjadwalkan pekerjaan metode perangkat, nama metode dan payload diperlukan argumen. HARAP DICATAT: Menggunakan waktu mulai kustom yang ada di masa lalu dapat menyebabkan operasi gagal.

az iot hub job create --job-id
                      --job-type {scheduleDeviceMethod, scheduleUpdateTwin}
                      [--auth-type {key, login}]
                      [--duration]
                      [--hub-name]
                      [--interval]
                      [--login]
                      [--mct]
                      [--method-name]
                      [--method-payload]
                      [--method-response-timeout]
                      [--patch]
                      [--query-condition]
                      [--resource-group]
                      [--start]
                      [--ttl]
                      [--wait {false, true}]

Contoh

Buat dan jadwalkan pekerjaan untuk memperbarui tag kembar dari semua perangkat.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}'

Jadwalkan pekerjaan dan blokir hasil "selesai", "gagal" atau "dibatalkan". Tentukan interval polling dalam hitungan detik.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}' --wait --poll-interval 30

Buat pekerjaan untuk memperbarui properti kembar yang diinginkan pada subset perangkat, yang dijadwalkan berjalan pada waktu mendatang yang segan.

az iot hub job create --job-id {job_name} --job-type scheduleUpdateTwin -n {iothub_name} --twin-patch '{"properties":{"desired": {"temperatureF": 65}}}' --start-time "2050-01-08T12:19:56.868Z" --query-condition "deviceId IN ['MyDevice1', 'MyDevice2', 'MyDevice3']"

Membuat dan menjadwalkan pekerjaan untuk memanggil metode perangkat untuk sekumpulan perangkat yang memenuhi kondisi kueri.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -n {iothub_name} --method-name setSyncIntervalSec --method-payload 30 --query-condition "properties.reported.settings.syncIntervalSec != 30"

Membuat dan menjadwalkan pekerjaan untuk memanggil metode perangkat untuk semua perangkat.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -q "*" -n {iothub_name} --method-name setSyncIntervalSec --method-payload '{"version":"1.0"}'

Parameter yang Diperlukan

--job-id

Id pekerjaan IoT Hub.

--job-type --jt

Jenis pekerjaan terjadwal.

nilai yang diterima: scheduleDeviceMethod, scheduleUpdateTwin

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
--duration --poll-duration

Total durasi dalam detik di mana status pekerjaan akan diperiksa jika --bendera tunggu diteruskan.

nilai default: 600
--hub-name -n

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

--interval --poll-interval

Interval dalam detik status pekerjaan akan diperiksa apakah --bendera tunggu diteruskan.

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

--mct --method-connect-timeout

Jumlah detik maksimum untuk menunggu koneksi perangkat.

nilai default: 30
--method-name --mn

Metode target untuk pemanggilan.

--method-payload --mp

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

--method-response-timeout --mrt

Jumlah detik maksimum untuk menunggu hasil metode perangkat.

nilai default: 30
--patch --twin-patch

Patch kembar yang diinginkan. Berikan jalur file atau json mentah.

--query-condition -q

Kondisi untuk kueri perangkat agar perangkat dapat menjalankan pekerjaan. Diperlukan jika jenis pekerjaan adalah scheduleDeviceMethod atau scheduleUpdateTwin. Catatan: Layanan akan mengawali "SELECT * FROM devices WHERE " ke input.

--resource-group -g

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

--start --start-time

Awal pekerjaan yang dijadwalkan dalam format waktu tanggal ISO 8601. Jika tidak ada waktu mulai yang disediakan, pekerjaan diantrekan untuk eksekusi asap. Menggunakan waktu mulai kustom yang ada di masa lalu dapat menyebabkan operasi gagal.

--ttl

Waktu eksekusi maksimum dalam detik, sebelum pekerjaan dihentikan.

nilai default: 3600
--wait -w

Blokir hingga pekerjaan yang dibuat dalam status selesai, gagal, atau dibatalkan. Akan secara teratur melakukan polling pada interval yang ditentukan oleh --poll-interval.

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 job list

Mencantumkan pekerjaan historis IoT Hub.

az iot hub job list [--auth-type {key, login}]
                    [--hub-name]
                    [--job-status {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
                    [--job-type {export, import, scheduleDeviceMethod, scheduleUpdateTwin}]
                    [--login]
                    [--resource-group]
                    [--top]

Contoh

Cantumkan semua pekerjaan yang diarsipkan dalam periode retensi (maksimal 30 hari).

az iot hub job list --hub-name {iothub_name}

Mencantumkan semua pekerjaan yang diarsipkan yang memproyeksikan properti tertentu

az iot hub job list --hub-name {iothub_name} --query "[*].[jobId,type,status,startTime,endTime]"

Mencantumkan hanya memperbarui pekerjaan jenis kembar

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod

Mencantumkan pekerjaan metode perangkat yang memiliki status "terjadwal"

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod --job-status scheduled

Mencantumkan pekerjaan ekspor perangkat yang memiliki status "selesai"

az iot hub job list --hub-name {iothub_name} --job-type export --job-status completed

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.

--job-status --js

Status pekerjaan terjadwal.

nilai yang diterima: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown
--job-type --jt

Jenis pekerjaan terjadwal.

nilai yang diterima: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--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. Gunakan -1 untuk tidak terbatas.

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 job show

Menampilkan detail pekerjaan IoT Hub yang sudah ada.

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

Contoh

Menampilkan detail pekerjaan yang dibuat.

az iot hub job show --hub-name {iothub_name} --job-id {job_id}

Parameter yang Diperlukan

--job-id

Id pekerjaan IoT Hub.

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.