az iot hub job

コマンド

名前	説明	型	状態
az iot hub job cancel	IoT Hub ジョブを取り消します。	Extension	GA
az iot hub job create	IoT Hub ジョブを作成して実行のスケジュールを設定します。	Extension	GA
az iot hub job list	IoT Hub の履歴ジョブを一覧表示します。	Extension	GA
az iot hub job show	既存の IoT Hub ジョブの詳細を表示します。	Extension	GA

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

例

IoT Hub ジョブを取り消します。

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

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

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

例

すべてのデバイスのツイン タグを更新するジョブを作成してスケジュールします。

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

ジョブをスケジュールし、"completed"、"failed"、または "cancelled" の結果をブロックします。 ポーリング間隔を秒単位で指定します。

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

任意の将来の時刻に実行されるようにスケジュールされた、デバイスのサブセットで目的のツイン プロパティを更新するジョブを作成します。

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

クエリ条件を満たす一連のデバイスのデバイス メソッドを呼び出すジョブを作成してスケジュールします。

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"

すべてのデバイスに対してデバイス メソッドを呼び出すジョブを作成してスケジュールします。

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

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

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

例

保持期間内 (最大 30 日間) 内のすべてのアーカイブ済みジョブを一覧表示します。

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

特定のプロパティを投影するアーカイブ済みジョブをすべて一覧表示する

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

更新ツインの種類のジョブのみを一覧表示する

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

状態が "scheduled" のデバイス メソッド ジョブを一覧表示する

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

状態が "完了" のデバイス エクスポート ジョブを一覧表示する

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

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

例

作成されたジョブの詳細を表示します。

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

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False