az iot device c2d-message

Note

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

クラウドからデバイスへのメッセージング コマンド。

コマンド

名前	説明	型	Status
az iot device c2d-message abandon	クラウドからデバイスへのメッセージを破棄します。	拡張	GA
az iot device c2d-message complete	クラウドからデバイスへのメッセージを完了します。	拡張	GA
az iot device c2d-message purge	ターゲット デバイスの cloud-to-device メッセージ キューを消去します。	拡張	GA
az iot device c2d-message receive	クラウドからデバイスへのメッセージを受信します。	拡張	GA
az iot device c2d-message reject	クラウドからデバイスへのメッセージを拒否または配信不能にする。	拡張	GA
az iot device c2d-message send	クラウドからデバイスへのメッセージを送信します。	拡張	GA

az iot device c2d-message abandon

クラウドからデバイスへのメッセージを破棄します。

az iot device c2d-message abandon --device-id
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

必須のパラメーター

--device-id -d

ターゲット デバイス ID。

省略可能のパラメーター

--etag -e

リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。

--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 device c2d-message complete

クラウドからデバイスへのメッセージを完了します。

az iot device c2d-message complete --device-id
                                   [--etag]
                                   [--hub-name]
                                   [--login]
                                   [--resource-group]

必須のパラメーター

--device-id -d

ターゲット デバイス ID。

省略可能のパラメーター

--etag -e

リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。

--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 device c2d-message purge

ターゲット デバイスの cloud-to-device メッセージ キューを消去します。

az iot device c2d-message purge --device-id
                                [--hub-name]
                                [--login]
                                [--resource-group]

必須のパラメーター

--device-id -d

ターゲット デバイス ID。

省略可能のパラメーター

--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 device c2d-message receive

クラウドからデバイスへのメッセージを受信します。

受信したメッセージ本文は、コンテンツ エンコードが 'utf-8'、'utf-16' または 'utf-32' に設定されている場合にのみデコードされます。 コンテンツ エンコードが上記のいずれかに設定されていない場合、またはコンテンツ エンコードが上記のいずれかに設定されている場合でもデコードに失敗した場合、メッセージ ペイロードは {{デコード不可能なペイロード}} として表示されます。

注: 1 つのメッセージ ack 引数 [--complete, --reject, --abandon] のみが受け入れられます。

az iot device c2d-message receive --device-id
                                  [--abandon {false, true}]
                                  [--complete {false, true}]
                                  [--hub-name]
                                  [--lock-timeout]
                                  [--login]
                                  [--reject {false, true}]
                                  [--resource-group]

例

基本的な使用

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group}

メッセージを受信し、そのメッセージのロック タイムアウトを 30 秒に設定する

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --lt {30}

メッセージを受信し、受信後に "完了" として確認する

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --complete

メッセージを受信し、受信後に拒否する

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --reject

必須のパラメーター

--device-id -d

ターゲット デバイス ID。

省略可能のパラメーター

--abandon

受信後にクラウドからデバイスへのメッセージを破棄します。

承認された値: false, true

既定値: False

--complete

受信後にクラウドからデバイスへのメッセージを完了します。

承認された値: false, true

既定値: False

--hub-name -n

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

--lock-timeout --lt

メッセージが他の受信呼び出しから見えなくなる時間を指定します。

既定値: 60

--login -l

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

--reject

受信後にクラウドからデバイスへのメッセージを拒否します。

承認された値: false, true

既定値: False

--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 device c2d-message reject

クラウドからデバイスへのメッセージを拒否または配信不能にする。

az iot device c2d-message reject --device-id
                                 [--etag]
                                 [--hub-name]
                                 [--login]
                                 [--resource-group]

必須のパラメーター

--device-id -d

ターゲット デバイス ID。

省略可能のパラメーター

--etag -e

リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。

--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 device c2d-message send

クラウドからデバイスへのメッセージを送信します。

このコマンドは依存しており、最初の実行時に依存する Cython パッケージ (uamqp) をインストールする場合があります。 https://github.com/Azure/azure-uamqp-python

注: コンテンツ エンコードは既定で utf-8 に設定されています。 コンテンツ エンコード プロパティが utf-8、utf-16、または utf-32 の場合、このコマンドはエンコード アクションを含むメッセージ本文を送信します。 コンテンツ エンコード値がこれらの値でない場合でも、エンコード アクションは実行されずにプロパティが送信されます。

バイナリ メッセージ本文を送信する場合、コンテンツはファイルから (経由して --data-file-path) 指定する必要があり、content-type は application/octet-stream.

az iot device c2d-message send --device-id
                               [--ack {full, negative, positive}]
                               [--auth-type {key, login}]
                               [--ce]
                               [--cid]
                               [--content-type]
                               [--da]
                               [--data-file-path]
                               [--expiry]
                               [--hub-name]
                               [--login]
                               [--message-id]
                               [--properties]
                               [--repair {false, true}]
                               [--resource-group]
                               [--uid]
                               [--wait {false, true}]
                               [--yes {false, true}]

例

既定のメッセージ本文での基本的な使用方法

az iot device c2d-message send -d {device_id} -n {iothub_name}

カスタム データとプロパティを使用して、クラウドからデバイスへのメッセージを送信します。

az iot device c2d-message send -d {device_id} -n {iothub_name} --data 'Hello World' --props 'key0=value0;key1=value1'

C2D メッセージを送信し、デバイスの受信確認を待機する

az iot device c2d-message send -d {device_id} -n {iothub_name} --ack full --wait

ファイルからバイナリ形式で C2D メッセージを送信します。

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/octet-stream'

ファイルから JSON 形式で C2D メッセージを送信します。

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/json'

必須のパラメーター

--device-id -d

ターゲット デバイス ID。

省略可能のパラメーター

--ack

メッセージの最終状態に関するメッセージごとのフィードバックの配信を要求します。 ack 値の説明は次のとおりです。 正: c2d メッセージが完了状態に達すると、IoT Hub によってフィードバック メッセージが生成されます。 負の値: c2d メッセージが配信不能状態に達すると、IoT Hub によってフィードバック メッセージが生成されます。 完全: どちらの場合も、IoT Hub によってフィードバック メッセージが生成されます。 既定では、ack は要求されません。

承認された値: full, negative, positive

--auth-type

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

承認された値: key, login

既定値: key

--ce --content-encoding

C2D メッセージ本文のエンコード。

既定値: utf-8

--cid --correlation-id

C2D メッセージに関連付けられている関連付け ID。

--content-type --ct

C2D メッセージ本文のコンテンツ タイプ。

--da --data

メッセージの本文。 テキストまたは生の json を指定します。

既定値: Ping from Az CLI IoT Extension

--data-file-path --dfp

プレビュー

メッセージ本文ペイロードのファイルへのパスを指定します。 ペイロードをバイナリ形式で送信する必要がある場合は、コンテンツ タイプを application/octet-stream に設定してください。

--expiry --expiry-time-utc

単位は unix エポック以降のミリ秒です。 時刻が指定されていない場合は、既定の IoT Hub C2D メッセージ TTL が使用されます。

--hub-name -n

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

--login -l

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

--message-id --mid

C2D メッセージ ID。メッセージ ID が指定されていない場合は、UUID が生成されます。

--properties --props -p

次の形式のキーと値のペアのメッセージ プロパティ バッグ: a=b;c=d。

--repair -r

拡張機能のバージョンと互換性のある uamqp 依存関係を再インストールします。 既定値は false です。

承認された値: false, true

既定値: False

--resource-group -g

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

--uid --user-id

C2D メッセージ、ユーザー ID プロパティ。

--wait -w

c2d 送信操作を設定すると、デバイスのフィードバックが受信されるまでブロックされます。

承認された値: false, true

既定値: False

--yes -y

ユーザー プロンプトをスキップします。 アクションの受け入れを示します。 主に自動化シナリオに使用されます。 既定値は false です。

承認された値: 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 を使います。