Aracılığıyla paylaş

az iot hub job

  • Başvuru

Not

Bu başvuru, Azure CLI (sürüm 2.46.0 veya üzeri) için azure-iot uzantısının bir parçasıdır. Uzantı, bir az iot hub job komutunu ilk kez çalıştırdığınızda otomatik olarak yüklenir. Uzantılar hakkında daha fazla bilgi edinin.

IoT Hub işlerini (v2) yönetin.

Komutlar

Name Description Tür Durum
az iot hub job cancel

IoT Hub işini iptal etme.

 Dahili GA
az iot hub job create

Yürütme için bir IoT Hub işi oluşturun ve zamanlayın.

 Dahili GA
az iot hub job list

IoT Hub'ın geçmiş işlerini listeleme.

 Dahili GA
az iot hub job show

Mevcut bir IoT Hub işinin ayrıntılarını gösterin.

 Dahili GA

az iot hub job cancel

IoT Hub işini iptal etme.

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

Örnekler

IoT Hub işini iptal etme.

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

Gerekli Parametreler

--job-id

IoT Hub iş kimliği.

İsteğe Bağlı Parametreler

--auth-type

İşlemin bir ilke anahtarını otomatik olarak türetmesi mi yoksa geçerli Azure AD oturumunu mu kullanması gerektiğini gösterir. Kimlik doğrulama türü oturum açma bilgisiyse ve kaynak ana bilgisayar adı sağlanmışsa, gerekmedikçe kaynak araması atlanır. kullanarak varsayılanı az configure --defaults iothub-data-auth-type=<auth-type-value>yapılandırabilirsiniz.

Kabul edilen değerler: key, login
Default value: key
--hub-name -n

IoT Hub adı veya ana bilgisayar adı. --login sağlanmadıysa gereklidir.

--login -l

Bu komut, eylem gerçekleştirme haklarına sahip bir varlık bağlantı dizesi destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık bağlantı dizesi hem de ad sağlanırsa, bağlantı dizesi öncelik alır. --hub-name sağlanmadıysa gereklidir.

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>yapılandırabilirsiniz.

Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

--output -o

Çıkış biçimi.

Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

az iot hub job create

Yürütme için bir IoT Hub işi oluşturun ve zamanlayın.

bir ikiz güncelleştirme işi zamanlarken, ikiz yaması gerekli bir bağımsız değişkendir. Bir cihaz yöntemi işini zamanlarken, yöntem adı ve yükü gerekli bağımsız değişkenlerdir. LÜTFEN UNUTMAYIN: Geçmişteki özel bir başlangıç saatinin kullanılması işlemin başarısız olmasına neden olabilir.

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

Örnekler

Tüm cihazların ikiz etiketlerini güncelleştirmek için bir iş oluşturun ve zamanlayın.

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

"Tamamlandı", "başarısız" veya "iptal edildi" sonucu için işi ve bloğu zamanlayın. Yoklama aralığını saniye cinsinden belirtin.

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

Bir cihaz alt kümesinde istenen ikiz özelliğini güncelleştirmek için bir iş oluşturun ve gelecekteki rastgele bir zamanda çalışacak şekilde zamanlandı.

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']"

Sorgu koşuluna uygun bir cihaz kümesi için cihaz yöntemini çağırmak üzere bir iş oluşturun ve zamanlayın.

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"

Tüm cihazlar için bir cihaz yöntemi çağırmak üzere bir iş oluşturun ve zamanlayın.

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

Gerekli Parametreler

--job-id

IoT Hub iş kimliği.

--job-type --jt

Zamanlanmış işin türü.

Kabul edilen değerler: scheduleDeviceMethod, scheduleUpdateTwin

İsteğe Bağlı Parametreler

--auth-type

İşlemin bir ilke anahtarını otomatik olarak türetmesi mi yoksa geçerli Azure AD oturumunu mu kullanması gerektiğini gösterir. Kimlik doğrulama türü oturum açma bilgisiyse ve kaynak ana bilgisayar adı sağlanmışsa, gerekmedikçe kaynak araması atlanır. kullanarak varsayılanı az configure --defaults iothub-data-auth-type=<auth-type-value>yapılandırabilirsiniz.

Kabul edilen değerler: key, login
Default value: key
--duration --poll-duration

--wait bayrağı geçirilirse iş durumunun denetleneceği saniye cinsinden toplam süre.

Default value: 600
--hub-name -n

IoT Hub adı veya ana bilgisayar adı. --login sağlanmadıysa gereklidir.

--interval --poll-interval

--wait bayrağı geçirilirse iş durumunun denetleneceği saniye cinsinden aralık.

Default value: 10
--login -l

Bu komut, eylem gerçekleştirme haklarına sahip bir varlık bağlantı dizesi destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık bağlantı dizesi hem de ad sağlanırsa, bağlantı dizesi öncelik alır. --hub-name sağlanmadıysa gereklidir.

--mct --method-connect-timeout

Cihaz bağlantısında bek alınacak en fazla saniye sayısı.

Default value: 30
--method-name --mn

Çağırma için hedef yöntem.

--method-payload --mp

Yönteme geçirilecek Json yükü. Dosya yolu veya ham json olmalıdır.

--method-response-timeout --mrt

Cihaz yöntemi sonucunu beklemek için en fazla saniye sayısı.

Default value: 30
--patch --twin-patch

İstenen ikiz yaması. Dosya yolu veya ham json sağlayın.

--query-condition -q

cihazların işi yürütmesini sağlamak için cihaz sorgusu koşulu. İş türü scheduleDeviceMethod veya scheduleUpdateTwin ise gereklidir. Not: Hizmet girişe "SELECT * FROM devices WHERE " ön eki ekler.

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>yapılandırabilirsiniz.

--start --start-time

İşin ISO 8601 tarih saat biçiminde zamanlanmış başlangıcı. Başlangıç zamanı sağlanmazsa, iş anında yürütme için kuyruğa alınır. Geçmişte olan özel bir başlangıç saati kullanmak işlemin başarısız olmasına neden olabilir.

--ttl

İş sonlandırılmadan önce saniye olarak en uzun yürütme süresi.

Default value: 3600
--wait -w

Oluşturulan iş tamamlandı, başarısız veya iptal edildi durumuna gelene kadar engelleyin. --poll-interval tarafından belirtilen aralıkta düzenli olarak yoklama yapacaktır.

Kabul edilen değerler: false, true
Default value: False
Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

--output -o

Çıkış biçimi.

Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

az iot hub job list

IoT Hub'ın geçmiş işlerini listeleme.

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]

Örnekler

Saklama süresi içinde arşivlenen tüm işleri listeleyin (en fazla 30 gün).

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

Belirli özellikleri yansıtan tüm arşivlenmiş işleri listeleme

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

Yalnızca güncelleştirme ikiz türü işlerini listeleme

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

Durumu "zamanlanmış" olan cihaz yöntemi işlerini listeleme

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

Durumu "tamamlandı" olan cihaz dışarı aktarma işlerini listeleme

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

İsteğe Bağlı Parametreler

--auth-type

İşlemin bir ilke anahtarını otomatik olarak türetmesi mi yoksa geçerli Azure AD oturumunu mu kullanması gerektiğini gösterir. Kimlik doğrulama türü oturum açma bilgisiyse ve kaynak ana bilgisayar adı sağlanmışsa, gerekmedikçe kaynak araması atlanır. kullanarak varsayılanı az configure --defaults iothub-data-auth-type=<auth-type-value>yapılandırabilirsiniz.

Kabul edilen değerler: key, login
Default value: key
--hub-name -n

IoT Hub adı veya ana bilgisayar adı. --login sağlanmadıysa gereklidir.

--job-status --js

Zamanlanmış işin durumu.

Kabul edilen değerler: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown
--job-type --jt

Zamanlanmış işin türü.

Kabul edilen değerler: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--login -l

Bu komut, eylem gerçekleştirme haklarına sahip bir varlık bağlantı dizesi destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık bağlantı dizesi hem de ad sağlanırsa, bağlantı dizesi öncelik alır. --hub-name sağlanmadıysa gereklidir.

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>yapılandırabilirsiniz.

--top

Döndürülecek öğe sayısı üst sınırı. Sınırsız için -1 kullanın.

Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

--output -o

Çıkış biçimi.

Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

az iot hub job show

Mevcut bir IoT Hub işinin ayrıntılarını gösterin.

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

Örnekler

Oluşturulan işin ayrıntılarını gösterin.

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

Gerekli Parametreler

--job-id

IoT Hub iş kimliği.

İsteğe Bağlı Parametreler

--auth-type

İşlemin bir ilke anahtarını otomatik olarak türetmesi mi yoksa geçerli Azure AD oturumunu mu kullanması gerektiğini gösterir. Kimlik doğrulama türü oturum açma bilgisiyse ve kaynak ana bilgisayar adı sağlanmışsa, gerekmedikçe kaynak araması atlanır. kullanarak varsayılanı az configure --defaults iothub-data-auth-type=<auth-type-value>yapılandırabilirsiniz.

Kabul edilen değerler: key, login
Default value: key
--hub-name -n

IoT Hub adı veya ana bilgisayar adı. --login sağlanmadıysa gereklidir.

--login -l

Bu komut, eylem gerçekleştirme haklarına sahip bir varlık bağlantı dizesi destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık bağlantı dizesi hem de ad sağlanırsa, bağlantı dizesi öncelik alır. --hub-name sağlanmadıysa gereklidir.

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>yapılandırabilirsiniz.

Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

--output -o

Çıkış biçimi.

Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.