az iot hub job

Note

このリファレンスは、Azure CLI (バージョン 2.37.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot hub job コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

IoT Hub ジョブ (v2) を管理します。

コマンド

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

az iot hub job cancel

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

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}

必須のパラメーター

--job-id

IoT Hub ジョブ ID。

省略可能のパラメーター

--auth-type

操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>既定値を構成できます。

承認された値: key, login

既定値: key

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--login -l

このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot hub job create

IoT Hub ジョブを作成して実行のスケジュールを設定します。

ツイン更新ジョブをスケジュールする場合、ツインパッチは必須の引数です。 デバイス メソッド ジョブをスケジュールする場合、メソッド名とペイロードは必須の引数です。 PLEA Standard Edition注: 過去のカスタム開始時刻を使用すると、操作が失敗する可能性があります。

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

例

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

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

必須のパラメーター

--job-id

IoT Hub ジョブ ID。

--job-type --jt

スケジュールされたジョブの種類。

承認された値: scheduleDeviceMethod, scheduleUpdateTwin

省略可能のパラメーター

--auth-type

操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>既定値を構成できます。

承認された値: key, login

既定値: key

--duration --poll-duration

--wait フラグが渡された場合にジョブの状態がチェックされる合計時間 (秒)。

既定値: 600

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--interval --poll-interval

--wait フラグが渡された場合にジョブの状態がチェックされる間隔 (秒単位)。

既定値: 10

--login -l

このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。

--mct --method-connect-timeout

デバイス接続を待機する最大秒数。

既定値: 30

--method-name --mn

呼び出しのターゲット メソッド。

--method-payload --mp

メソッドに渡される Json ペイロード。 ファイル パスまたは生の json である必要があります。

--method-response-timeout --mrt

デバイス メソッドの結果を待機する最大秒数。

既定値: 30

--patch --twin-patch

目的のツイン パッチ。 ファイル パスまたは生の json を指定します。

--query-condition -q

ジョブを実行するデバイスを取得するためのデバイス クエリの条件。 ジョブの種類が scheduleDeviceMethod または scheduleUpdateTwin の場合は必須。 注: このサービスは、入力に "Standard Edition LECT * FROM devices WHERE" というプレフィックスを付けます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--start --start-time

ジョブのスケジュールされた開始 (ISO 8601 日時形式)。 開始時刻が指定されていない場合、ジョブはできるだけ早く実行するためにキューに入れられます。 過去のカスタム開始時刻を使用すると、操作が失敗する可能性があります。

--ttl

ジョブが終了するまでの最大実行時間 (秒単位)。

既定値: 3600

--wait -w

作成されたジョブが完了、失敗、または取り消された状態になるまでブロックします。 --poll-interval で指定された間隔で定期的にポーリングします。

承認された値: false, true

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot hub job list

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]

例

保持期間内 (最大 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

省略可能のパラメーター

--auth-type

操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>既定値を構成できます。

承認された値: key, login

既定値: key

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--job-status --js

スケジュールされたジョブの状態。

承認された値: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown

--job-type --jt

スケジュールされたジョブの種類。

承認された値: export, import, scheduleDeviceMethod, scheduleUpdateTwin

--login -l

このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--top

返される要素の最大数。 無制限の場合は -1 を使用します。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot hub job show

既存の IoT Hub ジョブの詳細を表示します。

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}

必須のパラメーター

--job-id

IoT Hub ジョブ ID。

省略可能のパラメーター

--auth-type

操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>既定値を構成できます。

承認された値: key, login

既定値: key

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--login -l

このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。