az iot device

リファレンス

Note

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

デバイスシミュレーションやその他のデバイス中心の操作 (デバイスからクラウド、クラウドからデバイスへのメッセージング機能など) を活用します。

コマンド

名前	説明	型	状態
az iot device c2d-message	クラウドからデバイスへのメッセージングコマンド。	拡張子	GA
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 registration	IoT Device Provisioning Service の IoT デバイス登録を管理します。	拡張子	プレビュー
az iot device registration create	IoT デバイスを IoT Device Provisioning Service に登録します。	拡張子	プレビュー
az iot device send-d2c-message	mqtt device-to-cloud メッセージを送信します。	拡張子	GA
az iot device simulate	Azure IoT Hub でデバイスをシミュレートします。	拡張子	実験用
az iot device upload-file	事前構成済みの BLOB ストレージコンテナーに、デバイスとしてローカルファイルをアップロードします。	拡張子	GA

az iot device send-d2c-message

mqtt device-to-cloud メッセージを送信します。

このコマンドは、Unicode 文字列またはバイナリ形式のカスタムペイロードを使用したメッセージの送信をサポートしています。バイナリを送信する場合、データは ( --data-file-path経由で) ファイルから取得し、コンテンツタイプを application/octet-stream に設定する必要があります。

注: このコマンドは、対称キー認証 (SAS) ベースのデバイスでのみ機能します。メッセージルーティングでメッセージ本文に対するクエリを有効にするには、contentType システムプロパティが application/JSON である必要があり、contentEncoding システムプロパティは、そのシステムプロパティ (UTF-8、UTF-16、または UTF-32) でサポートされている UTF エンコード値のいずれかである必要があります。 Azure Storage をルーティングエンドポイントとして使用するときにコンテンツエンコードが設定されていない場合、IoT Hub は Base 64 でエンコードされた形式でメッセージを書き込みます。 x509 認証方法を使用する場合は、証明書ファイルとキーファイル (および必要に応じてパスフレーズ) を指定する必要があります。

az iot device send-d2c-message --device-id
                               [--certificate-file-path]
                               [--da]
                               [--data-file-path]
                               [--dtmi]
                               [--hub-name]
                               [--key]
                               [--key-file-path]
                               [--login]
                               [--mc]
                               [--pass]
                               [--properties]
                               [--resource-group]

例

基本的な使用方法

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

'dtmi:com:example:Thermostat; のモデル ID を登録するデバイスの基本的な使用方法。接続時に 1'

az iot device send-d2c-message -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'

x509 認証を使用したデバイスの基本的な使用方法

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

キーファイルにパスフレーズが含まれる x509 認証を使用したデバイスの基本的な使用方法

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

カスタムデータでの基本的な使用方法

az iot device send-d2c-message -n {iothub_name} -d {device_id} --data {message_body}

アプリケーションのプロパティを送信する

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

システムプロパティの送信 (メッセージ ID と関連付け ID)

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.mid={id};$.cid={id}'

システムプロパティでコンテンツタイプとコンテンツエンコードを指定してカスタムデータを送信する

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct={content-type};$.ce={content-encoding}' --data {message_body}

システムプロパティでコンテンツエンコードを指定して、カスタムデータをバイナリ形式で送信する

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/octet-stream' --data-file-path {file_path}

システムプロパティでコンテンツタイプとコンテンツエンコードを指定して JSON 形式でカスタムデータを送信する

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/json;$.ce=utf-8' --data-file-path {file_path}

必須のパラメーター

--device-id -d

ターゲットデバイス ID。

省略可能のパラメーター

--certificate-file-path --cp

証明書ファイルへのパス。

--da --data

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

規定値: Ping from Az CLI IoT Extension

--data-file-path --dfp

プレビュー

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

--dtmi --model-id

ハブに接続するときにデバイスが報告するデジタルツインモデル ID。詳細については、 https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play をご覧ください。

--hub-name -n

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

--key --symmetric-key

デバイスに使用する対称キー。対称キーとその他のデバイス認証引数が指定されている場合は、対称キーが優先されます。

--key-file-path --kp

キーファイルへのパス。

--login -l

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

--mc --msg-count

IoT Hub に送信するデバイスメッセージの数。

規定値: 1

--pass --passphrase

キーファイルのパスフレーズ。

--properties --props -p

--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 simulate

実験用

このコマンドは試験段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

Azure IoT Hub でデバイスをシミュレートします。

デバイスシミュレーションの実行中、デバイスは自動的に cloud-to-device (c2d) メッセージを受信して確認します。 mqtt シミュレーションの場合、すべての c2d メッセージが完了して確認されます。 http シミュレーションの c2d 受信確認は、完了、拒否、または破棄できるユーザーの選択に基づいています。 mqtt シミュレーションでは、応答状態コードと応答ペイロードで確認できるダイレクトメソッド呼び出しもサポートされています。注: 既定では、このコマンドはコンテンツタイプを application/json に設定し、content-encoding を utf-8 に設定します。これはオーバーライドできます。注: x509 認証方法を使用する場合は、証明書ファイルとキーファイル (および必要に応じてパスフレーズ) を指定する必要があります。

az iot device simulate --device-id
                       [--certificate-file-path]
                       [--da]
                       [--dtmi]
                       [--hub-name]
                       [--init-reported-properties]
                       [--key]
                       [--key-file-path]
                       [--login]
                       [--mc]
                       [--method-response-code]
                       [--method-response-payload]
                       [--mi]
                       [--pass]
                       [--properties]
                       [--proto {http, mqtt}]
                       [--receive-settle {abandon, complete, reject}]
                       [--resource-group]

例

基本的な使用法 (mqtt)

az iot device simulate -n {iothub_name} -d {device_id}

'dtmi:com:example:Thermostat; のモデル ID を登録するデバイスの基本的な使用方法。接続時に 1' (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'

x509 認証を使用したデバイスの基本的な使用方法 (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

キーファイルにパスフレーズが含まれる x509 認証 (mqtt) を使用したデバイスの基本的な使用方法

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

混合プロパティの送信 (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --properties "myprop=myvalue;$.ct=application/json"

ダイレクトメソッド応答状態コードとダイレクトメソッド応答ペイロードを生 json として送信する (mqtt のみ)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '{"result":"Direct method successful"}'

ダイレクトメソッド応答状態コードとダイレクトメソッド応答ペイロードをローカルファイルへのパスとして送信する (mqtt のみ)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '../my_direct_method_payload.json'

デバイスツインの報告されたプロパティの初期状態をターゲットデバイスの生の json として送信する (mqtt のみ)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '{"reported_prop_1":"val_1", "reported_prop_2":val_2}'

デバイスツインの報告されたプロパティの初期状態をターゲットデバイスのローカルファイルへのパスとして送信する (mqtt のみ)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '../my_device_twin_reported_properties.json'

基本的な使用方法 (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http

混合プロパティの送信 (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http --properties "iothub-app-myprop=myvalue;content-type=application/json;iothub-correlationid=12345"

メッセージの合計数とメッセージ間の間隔を選択する

az iot device simulate -n {iothub_name} -d {device_id} --msg-count 1000 --msg-interval 5

c2d メッセージを拒否する (http のみ)

az iot device simulate -n {iothub_name} -d {device_id} --rs reject --protocol http

c2d メッセージを破棄する (http のみ)

az iot device simulate -n {iothub_name} -d {device_id} --rs abandon --protocol http

必須のパラメーター

--device-id -d

ターゲットデバイス ID。

省略可能のパラメーター

--certificate-file-path --cp

証明書ファイルへのパス。

--da --data

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

規定値: Ping from Az CLI IoT Extension

--dtmi --model-id

--hub-name -n

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

--init-reported-properties --irp

シミュレーターの実行時にターゲットデバイスのツインによって報告されるプロパティの初期状態。省略可能なパラメーター。mqtt でのみサポートされます。

--key --symmetric-key

デバイスに使用する対称キー。対称キーとその他のデバイス認証引数が指定されている場合は、対称キーが優先されます。

--key-file-path --kp

キーファイルへのパス。

--login -l

--mc --msg-count

IoT Hub に送信するデバイスメッセージの数。

規定値: 100

--method-response-code --mrc

ダイレクトメソッドがデバイスで実行されたときに返される状態コード。省略可能なパラメーター。mqtt でのみサポートされます。

--method-response-payload --mrp

ダイレクトメソッドがデバイスで実行されたときに返されるペイロード。ファイルパスまたは生の json を指定します。省略可能なパラメーター。mqtt でのみサポートされます。

--mi --msg-interval

デバイスからクラウドへのメッセージ間の遅延 (秒単位)。

規定値: 3

--pass --passphrase

キーファイルのパスフレーズ。

--properties --props -p

次の形式のキーと値のペアのメッセージプロパティバッグ: a=b;c=d。 mqtt メッセージングの場合- $.=value を使用してシステムプロパティを送信できます。たとえば、$.cid=12345 はシステム相関 ID プロパティを設定します。その他のシステムプロパティ識別子の例には、コンテンツタイプの $.ct、メッセージ ID の$.mid、コンテンツエンコード用の $.ce などがあります。 http メッセージングの場合、アプリケーションのプロパティは iothub-app-=value (例: iothub-app-myprop=myvalue) を使用して送信されます。システムプロパティには、通常、iothub-correlationid のような iothub というプレフィックスが付けられますが、コンテンツタイプやコンテンツエンコードなどの例外があります。

--proto --protocol

デバイスからクラウドへのメッセージプロトコルを示します。

指定可能な値: http, mqtt

規定値: mqtt

--receive-settle --rs

受信したクラウドからデバイスへのメッセージを解決する方法を示します。 HTTP でのみサポートされます。

指定可能な値: abandon, complete, reject

規定値: complete

--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 upload-file

事前構成済みの BLOB ストレージコンテナーに、デバイスとしてローカルファイルをアップロードします。

az iot device upload-file --content-type
                          --device-id
                          --file-path
                          [--hub-name]
                          [--login]
                          [--resource-group]

必須のパラメーター

--content-type --ct

MIME ファイルの種類。

--device-id -d

ターゲットデバイス ID。

--file-path --fp

アップロードするファイルへのパス。

省略可能のパラメーター

--hub-name -n

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

--login -l

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

コマンド

az iot device send-d2c-message

例

必須のパラメーター

省略可能のパラメーター

az iot device simulate

例

必須のパラメーター

省略可能のパラメーター

az iot device upload-file

必須のパラメーター

省略可能のパラメーター

その他のリソース