az iot device c2d-message
Note
This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). az iot device c2d-message コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 Learn more about extensions.
クラウドからデバイスへのメッセージング コマンド。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az iot device c2d-message abandon |
クラウドからデバイスへのメッセージを破棄します。 |
Extension | GA |
az iot device c2d-message complete |
クラウドからデバイスへのメッセージを完了します。 |
Extension | GA |
az iot device c2d-message purge |
ターゲット デバイスの cloud-to-device メッセージ キューを消去します。 |
Extension | GA |
az iot device c2d-message receive |
クラウドからデバイスへのメッセージを受信します。 |
Extension | GA |
az iot device c2d-message reject |
クラウドからデバイスへのメッセージを拒否または配信不能にする。 |
Extension | GA |
az iot device c2d-message send |
クラウドからデバイスへのメッセージを送信します。 |
Extension | GA |
az iot device c2d-message abandon
クラウドからデバイスへのメッセージを破棄します。
az iot device c2d-message abandon --device-id
[--etag]
[--hub-name]
[--login]
[--resource-group]
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az iot device c2d-message complete
クラウドからデバイスへのメッセージを完了します。
az iot device c2d-message complete --device-id
[--etag]
[--hub-name]
[--login]
[--resource-group]
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az iot device c2d-message purge
ターゲット デバイスの cloud-to-device メッセージ キューを消去します。
az iot device c2d-message purge --device-id
[--hub-name]
[--login]
[--resource-group]
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
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 --lt]
[--login]
[--reject {false, true}]
[--resource-group]
例
Basic usage
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
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
受信後にクラウドからデバイスへのメッセージを破棄します。
プロパティ | 値 |
---|---|
Parameter group: | Message Ack Arguments |
規定値: | False |
指定可能な値: | false, true |
受信後にクラウドからデバイスへのメッセージを完了します。
プロパティ | 値 |
---|---|
Parameter group: | Message Ack Arguments |
規定値: | False |
指定可能な値: | false, true |
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
メッセージが他の受信呼び出しから見えなくなる時間を指定します。
プロパティ | 値 |
---|---|
規定値: | 60 |
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
受信後にクラウドからデバイスへのメッセージを拒否します。
プロパティ | 値 |
---|---|
Parameter group: | Message Ack Arguments |
規定値: | False |
指定可能な値: | false, true |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az iot device c2d-message reject
クラウドからデバイスへのメッセージを拒否または配信不能にする。
az iot device c2d-message reject --device-id
[--etag]
[--hub-name]
[--login]
[--resource-group]
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
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
経由で) ファイルからコンテンツを提供し、コンテンツ タイプを application/octet-stream
に設定する必要があります。
az iot device c2d-message send --device-id
[--ack {full, negative, positive}]
[--auth-type {key, login}]
[--ce --content-encoding]
[--cid --correlation-id]
[--content-type --ct]
[--da --data]
[--data-file-path --dfp]
[--expiry --expiry-time-utc]
[--hub-name]
[--login]
[--message-id --mid]
[--properties --props]
[--repair {false, true}]
[--resource-group]
[--uid --user-id]
[--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'
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
メッセージの最終状態に関するメッセージごとのフィードバックの配信を要求します。 ack 値の説明は次のとおりです。 正: c2d メッセージが完了状態に達すると、IoT Hub によってフィードバック メッセージが生成されます。 負の値: c2d メッセージが配信不能状態に達すると、IoT Hub によってフィードバック メッセージが生成されます。 完全: どちらの場合も、IoT Hub によってフィードバック メッセージが生成されます。 既定では、ack は要求されません。
プロパティ | 値 |
---|---|
指定可能な値: | full, negative, positive |
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。既定値は、 az configure --defaults iothub-data-auth-type={auth-type-value}
を使用して構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Access Control Arguments |
規定値: | key |
指定可能な値: | key, login |
C2D メッセージ本文のエンコード。
プロパティ | 値 |
---|---|
規定値: | utf-8 |
C2D メッセージに関連付けられている関連付け ID。
C2D メッセージ本文のコンテンツ タイプ。
Message body. テキストまたは生の json を指定します。
プロパティ | 値 |
---|---|
規定値: | Ping from Az CLI IoT Extension |
メッセージ本文ペイロードのファイルへのパスを指定します。 ペイロードをバイナリ形式で送信する必要がある場合は、コンテンツ タイプを application/octet-stream に設定してください。
単位は unix エポック以降のミリ秒です。 時刻が指定されていない場合は、既定の IoT Hub C2D メッセージ TTL が使用されます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
C2D メッセージ ID。メッセージ ID が指定されていない場合は、UUID が生成されます。
次の形式のキーと値のペアのメッセージ プロパティ バッグ: a=b;c=d。
拡張機能のバージョンと互換性のある uamqp 依存関係を再インストールします。 Default: false.
プロパティ | 値 |
---|---|
規定値: | False |
指定可能な値: | false, true |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
C2D メッセージ、ユーザー ID プロパティ。
c2d 送信操作を設定すると、デバイスのフィードバックが受信されるまでブロックされます。
プロパティ | 値 |
---|---|
規定値: | False |
指定可能な値: | false, true |
ユーザー プロンプトをスキップします。 アクションの受け入れを示します。 主に自動化シナリオに使用されます。 Default: false.
プロパティ | 値 |
---|---|
規定値: | False |
指定可能な値: | false, true |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |