az iot hub

Note

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

Azure IoT Hub 内のエンティティを管理します。

コマンド

名前	説明	型	Status
az iot hub certificate	IoT Hub 証明書を管理します。	拡張子	GA
az iot hub certificate root-authority	IoT Hub インスタンスの証明書ルート証明機関を管理します。	拡張子	"非推奨"
az iot hub certificate root-authority set	IoT Hub インスタンスの証明書ルート証明機関を特定のバージョンに設定します。	拡張子	"非推奨"
az iot hub certificate root-authority show	IoT Hub インスタンスの現在の証明書ルート証明機関を表示します。	拡張子	"非推奨"
az iot hub configuration	IoT の自動デバイス管理構成を大規模に管理します。	拡張子	GA
az iot hub configuration create	ターゲット IoT Hub に IoT 自動デバイス管理構成を作成します。	拡張子	GA
az iot hub configuration delete	IoT デバイス構成を削除します。	拡張子	GA
az iot hub configuration list	IoT Hub 内の IoT 自動デバイス管理構成を一覧表示します。	拡張子	GA
az iot hub configuration show	IoT 自動デバイス管理構成の詳細を取得します。	拡張子	GA
az iot hub configuration show-metric	IoT デバイス構成で定義されているターゲット ユーザーまたはシステム メトリックを評価します。	拡張子	GA
az iot hub configuration update	IoT 自動デバイス管理構成の指定されたプロパティを更新します。	拡張子	GA
az iot hub connection-string	IoT Hub 接続文字列を管理します。	拡張子	GA
az iot hub connection-string show	指定したポリシー名とキーを使用して、指定した IoT Hub の接続文字列を表示します。	拡張子	GA
az iot hub device-identity	IoT デバイスを管理します。	拡張子	GA
az iot hub device-identity children	IoT エッジ デバイスの子デバイスリレーションシップを管理します。	拡張子	GA
az iot hub device-identity children add	デバイスを子としてターゲット エッジ デバイスに追加します。	拡張子	GA
az iot hub device-identity children list	割り当てられた子デバイスのコレクションを出力します。	拡張子	GA
az iot hub device-identity children remove	ターゲット エッジ デバイスから子デバイスを削除します。	拡張子	GA
az iot hub device-identity connection-string	IoT デバイスの接続文字列を管理します。	拡張子	GA
az iot hub device-identity connection-string show	特定の IoT Hub デバイス 接続文字列を表示します。	拡張子	GA
az iot hub device-identity create	IoT Hub にデバイスを作成します。	拡張子	GA
az iot hub device-identity delete	IoT Hub デバイスを削除します。	拡張子	GA
az iot hub device-identity export	IoT Hub から Azure Storage BLOB コンテナーにすべてのデバイス ID をエクスポートします。	拡張子	GA
az iot hub device-identity import	ストレージ コンテナー BLOB から IoT Hub にデバイス ID をインポートします。	拡張子	GA
az iot hub device-identity list	IoT Hub 内のデバイスを一覧表示します。	拡張子	GA
az iot hub device-identity parent	IoT デバイスの親デバイスのリレーションシップを管理します。	拡張子	GA
az iot hub device-identity parent set	ターゲット デバイスの親デバイスを設定します。	拡張子	GA
az iot hub device-identity parent show	ターゲット デバイスの親デバイスを取得します。	拡張子	GA
az iot hub device-identity renew-key	Sas 認証を使用して IoT Hub デバイスのターゲット キーを更新します。	拡張子	GA
az iot hub device-identity show	IoT Hub デバイスの詳細を取得します。	拡張子	GA
az iot hub device-identity update	IoT Hub デバイスを更新します。	拡張子	GA
az iot hub device-twin	IoT デバイス ツインの構成を管理します。	拡張子	GA
az iot hub device-twin list	IoT Hub 内のデバイス ツインを一覧表示します。	拡張子	GA
az iot hub device-twin replace	デバイス ツイン定義をターゲット json に置き換えます。	拡張子	GA
az iot hub device-twin show	デバイス ツイン定義を取得します。	拡張子	GA
az iot hub device-twin update	デバイス ツインの必要なプロパティとタグを更新します。	拡張子	GA
az iot hub digital-twin	IoT Hub デバイスのデジタル ツインを操作して操作します。	拡張子	GA
az iot hub digital-twin invoke-command	デジタル ツイン デバイスのルートまたはコンポーネント レベルのコマンドを呼び出します。	拡張子	GA
az iot hub digital-twin show	IoT Hub デバイスのデジタル ツインを表示します。	拡張子	GA
az iot hub digital-twin update	JSON パッチ仕様を使用して、デジタル ツイン デバイスの読み取り/書き込みプロパティを更新します。	拡張子	GA
az iot hub distributed-tracing	デバイスごとに分散設定を管理します。	拡張子	プレビュー
az iot hub distributed-tracing show	デバイスの分散トレース設定を取得します。	拡張子	プレビュー
az iot hub distributed-tracing update	デバイスの分散トレース オプションを更新します。	拡張子	プレビュー
az iot hub generate-sas-token	ターゲット IoT Hub、デバイス、またはモジュールの SAS トークンを生成します。	拡張子	GA
az iot hub invoke-device-method	デバイス メソッドを呼び出します。	拡張子	GA
az iot hub invoke-module-method	モジュール メソッドを呼び出します。	拡張子	GA
az iot hub job	IoT Hub ジョブ (v2) を管理します。	拡張子	GA
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 message-endpoint	IoT ハブのカスタム エンドポイントを管理します。	拡張子	プレビュー
az iot hub message-endpoint create	IoT Hub にエンドポイントを追加します。	拡張子	プレビュー
az iot hub message-endpoint create cosmosdb-container	IoT Hub の Cosmos DB コンテナー エンドポイントを追加します。	拡張子	プレビュー
az iot hub message-endpoint create eventhub	IoT Hub のイベント ハブ エンドポイントを追加します。	拡張子	プレビュー
az iot hub message-endpoint create servicebus-queue	IoT Hub の Service Bus キュー エンドポイントを追加します。	拡張子	プレビュー
az iot hub message-endpoint create servicebus-topic	IoT Hub の Service Bus トピック エンドポイントを追加します。	拡張子	プレビュー
az iot hub message-endpoint create storage-container	IoT Hub のストレージ コンテナー エンドポイントを追加します。	拡張子	プレビュー
az iot hub message-endpoint delete	IoT Hub のすべてまたは特定のエンドポイントを削除します。	拡張子	プレビュー
az iot hub message-endpoint list	IoT Hub のすべてのエンドポイントに関する情報を取得します。	拡張子	プレビュー
az iot hub message-endpoint show	IoT Hub の前述のエンドポイントに関する情報を取得します。	拡張子	プレビュー
az iot hub message-endpoint update	IoT Hub の既存のエンドポイントのプロパティを更新します。	拡張子	プレビュー
az iot hub message-endpoint update cosmosdb-container	IoT Hub の既存の Cosmos DB コンテナー エンドポイントのプロパティを更新します。	拡張子	プレビュー
az iot hub message-endpoint update eventhub	IoT Hub の既存のイベント ハブ エンドポイントのプロパティを更新します。	拡張子	プレビュー
az iot hub message-endpoint update servicebus-queue	IoT Hub の既存の Service Bus キュー エンドポイントのプロパティを更新します。	拡張子	プレビュー
az iot hub message-endpoint update servicebus-topic	IoT Hub の既存の Service Bus トピック エンドポイントのプロパティを更新します。	拡張子	プレビュー
az iot hub message-endpoint update storage-container	IoT Hub の既存のストレージ コンテナー エンドポイントのプロパティを更新します。	拡張子	プレビュー
az iot hub message-route	IoT ハブのルートを管理します。	拡張子	プレビュー
az iot hub message-route create	IoT Hub のルートを追加します。	拡張子	プレビュー
az iot hub message-route delete	IoT Hub 内のすべてのルートまたは前述のルートを削除します。	拡張子	プレビュー
az iot hub message-route fallback	IoT ハブのフォールバック ルートを管理します。	拡張子	プレビュー
az iot hub message-route fallback set	IoT Hub でフォールバック ルートを有効または無効にします。	拡張子	プレビュー
az iot hub message-route fallback show	IoT Hub のフォールバック ルートを表示します。	拡張子	プレビュー
az iot hub message-route list	IoT Hub 内のすべてのルートを取得します。	拡張子	プレビュー
az iot hub message-route show	IoT Hub 内のルートに関する情報を取得します。	拡張子	プレビュー
az iot hub message-route test	IoT Hub 内のすべてのルートまたは前述のルートをテストします。	拡張子	プレビュー
az iot hub message-route update	IoT Hub のルートを更新します。	拡張子	プレビュー
az iot hub module-identity	IoT デバイス モジュールを管理します。	拡張子	GA
az iot hub module-identity connection-string	IoT デバイス モジュールの接続文字列を管理します。	拡張子	GA
az iot hub module-identity connection-string show	ターゲット IoT デバイス モジュールの接続文字列を表示します。	拡張子	GA
az iot hub module-identity create	IoT Hub 内のターゲット IoT デバイスにモジュールを作成します。	拡張子	GA
az iot hub module-identity delete	IoT Hub 内のデバイスを削除します。	拡張子	GA
az iot hub module-identity list	IoT Hub 内の IoT デバイスにあるモジュールを一覧表示します。	拡張子	GA
az iot hub module-identity renew-key	Sas 認証を使用して IoT Hub デバイス モジュールのターゲット キーを更新します。	拡張子	GA
az iot hub module-identity show	IoT Hub 内の IoT デバイス モジュールの詳細を取得します。	拡張子	GA
az iot hub module-identity update	IoT Hub デバイス モジュールを更新します。	拡張子	GA
az iot hub module-twin	IoT デバイス モジュール ツイン構成を管理します。	拡張子	GA
az iot hub module-twin replace	モジュール ツイン定義をターゲット json に置き換えます。	拡張子	GA
az iot hub module-twin show	モジュール ツイン定義を表示します。	拡張子	GA
az iot hub module-twin update	モジュール ツインの必要なプロパティとタグを更新します。	拡張子	GA
az iot hub monitor-events	IoT Hub に送信されたデバイス テレメトリとメッセージを監視します。	拡張子	GA
az iot hub monitor-feedback	cloud-to-device (C2D) メッセージに確認応答するためにデバイスによって送信されたフィードバックをモニターします。	拡張子	GA
az iot hub query	強力な SQL に似た言語を使用して、IoT Hub に対するクエリを実行します。	拡張子	GA
az iot hub state	IoT Hub の状態を管理します。	拡張子	実験用
az iot hub state export	IoT Hub の状態をファイルにエクスポートします。	拡張子	実験用
az iot hub state import	ファイルから IoT Hub にハブの状態をインポートします。	拡張子	実験用
az iot hub state migrate	ファイルに保存せずに、あるハブの状態を別のハブに移行します。	拡張子	実験用

az iot hub generate-sas-token

ターゲット IoT Hub、デバイス、またはモジュールの SAS トークンを生成します。

デバイス SAS トークンの場合、ポリシー パラメーターはデバイス レジストリにのみアクセスするために使用されます。 そのため、ポリシーにはレジストリへの読み取りアクセス権が必要です。 IoT Hub トークンの場合、ポリシーは SAS の一部です。

az iot hub generate-sas-token [--auth-type {key, login}]
                              [--connection-string]
                              [--device-id]
                              [--du]
                              [--hub-name]
                              [--key-type {primary, secondary}]
                              [--login]
                              [--module-id]
                              [--pn]
                              [--resource-group]

例

iothubowner ポリシーと主キーを使用して IoT Hub SAS トークンを生成します。

az iot hub generate-sas-token -n {iothub_name}

registryRead ポリシーとセカンダリ キーを使用して IoT Hub SAS トークンを生成します。

az iot hub generate-sas-token -n {iothub_name} --policy registryRead --key-type secondary

iothubowner ポリシーを使用してデバイス SAS トークンを生成し、{iothub_name} デバイス レジストリにアクセスします。

az iot hub generate-sas-token -d {device_id} -n {iothub_name}

IoT Hub 接続文字列 (レジストリ アクセスを使用) を使用してデバイス SAS トークンを生成する

az iot hub generate-sas-token -d {device_id} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

IoT Hub 接続文字列を使用して IoT Hub SAS トークンを生成する

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

デバイス 接続文字列を使用してデバイス SAS トークンを生成する

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

モジュール 接続文字列を使用してモジュール SAS トークンを生成する

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;ModuleId=mymodule;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

省略可能のパラメーター

--auth-type

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

承認された値: key, login

既定値: key

--connection-string --cs

ターゲット 接続文字列。 これにより、IoT Hub レジストリがバイパスされ、追加の検証なしで、指定された対称キーから直接 SAS トークンが生成されます。 期間以外の他のすべてのコマンド パラメーターは無視されます。 サポートされている接続文字列の種類: IoT Hub、デバイス、モジュール。

--device-id -d

ターゲット デバイス ID。

--du --duration

有効なトークン期間 (秒単位)。

既定値: 3600

--hub-name -n

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

--key-type --kt

認証用の共有アクセス ポリシー キーの種類。

承認された値: primary, secondary

既定値: primary

--login -l

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

--module-id -m

ターゲット モジュール ID。

--pn --policy-name

ターゲット IoT Hub エンティティの操作アクセス許可を持つ共有アクセス ポリシー。

既定値: iothubowner

--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 invoke-device-method

デバイス メソッドを呼び出します。

az iot hub invoke-device-method --device-id
                                --method-name
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

例

デバイスでダイレクト メソッドを呼び出します。

az iot hub invoke-device-method --hub-name {iothub_name} --device-id {device_id} --method-name Reboot --method-payload '{"version":"1.0"}'

必須のパラメーター

--device-id -d

ターゲット デバイス ID。

--method-name --mn

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

省略可能のパラメーター

--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 が指定されていない場合は必須です。

--method-payload --mp

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

既定値: {}

--resource-group -g

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

--timeout --to

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

既定値: 30

グローバル パラメーター

--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 invoke-module-method

モジュール メソッドを呼び出します。

このコマンドは、エッジ デバイス モジュールと非エッジ デバイス モジュールの両方をサポートします。

az iot hub invoke-module-method --device-id
                                --method-name
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

例

エッジ デバイス モジュールでダイレクト メソッドを呼び出します。

az iot hub invoke-module-method -n {iothub_name} -d {device_id} -m '$edgeAgent' --method-name 'RestartModule' --method-payload '{"schemaVersion": "1.0"}'

必須のパラメーター

--device-id -d

ターゲット デバイス ID。

--method-name --mn

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

--module-id -m

ターゲット モジュール 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 が指定されていない場合は必須です。

--method-payload --mp

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

既定値: {}

--resource-group -g

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

--timeout --to

モジュール メソッドの結果を待機する最大秒数。

既定値: 30

グローバル パラメーター

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

IoT Hub に送信されたデバイス テレメトリとメッセージを監視します。

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

注: このイベントは、メッセージ本文が Unicode デコード不可能な場合でも表示されます。この場合、イベント ペイロード部分は {{デコード不可能なペイロード}} として表示され、残りのイベント プロパティは使用可能です。

az iot hub monitor-events [--cg]
                          [--content-type]
                          [--device-id]
                          [--device-query]
                          [--enqueued-time]
                          [--hub-name]
                          [--interface]
                          [--login]
                          [--mc]
                          [--module-id]
                          [--properties {all, anno, app, sys}]
                          [--repair {false, true}]
                          [--resource-group]
                          [--timeout]
                          [--yes {false, true}]

例

基本的な使用方法

az iot hub monitor-events -n {iothub_name}

IoT Hub 接続文字列での基本的な使用方法

az iot hub monitor-events -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

ターゲット デバイスでフィルター処理するときの基本的な使用方法

az iot hub monitor-events -n {iothub_name} -d {device_id}

ID にワイルドカードを使用して対象デバイスをフィルター処理するときの基本的な使用方法

az iot hub monitor-events -n {iothub_name} -d Device*

IoT Hub クエリ言語を使用してデバイスをフィルター処理する

az iot hub monitor-events -n {iothub_name} -q "select * from devices where tags.location.region = 'US'"

デバイスをフィルター処理し、バインドするイベント ハブ コンシューマー グループを指定します。

az iot hub monitor-events -n {iothub_name} -d {device_id} --cg {consumer_group_name}

メッセージ注釈の受信 (メッセージ ヘッダー)

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno

メッセージ注釈とシステム プロパティを受け取ります。 タイムアウトは決してありません。

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno sys --timeout 0

すべてのデバイス メッセージからすべてのメッセージ属性を受信する

az iot hub monitor-events -n {iothub_name} --props all

すべてのメッセージを受信し、JSON としてメッセージ ペイロードを解析する

az iot hub monitor-events -n {iothub_name} --content-type application/json

ハブから指定した数のメッセージを受信し、シャットダウンします。

az iot hub monitor-events -n {iothub_name} --message-count {message_count}

省略可能のパラメーター

--cg --consumer-group -c

イベント ハブ エンドポイントに接続するときに使用するコンシューマー グループを指定します。

既定値: $Default

--content-type --ct

メッセージ ペイロードの Content-Type を指定して、その種類の出力を自動的に書式設定します。

--device-id -d

ターゲット デバイス ID。

--device-query -q

デバイスをフィルター処理するカスタム クエリを指定します。

--enqueued-time --et -e

パーティションからメッセージを読み取る開始点として使用する必要がある時間を示します。 単位は unix エポック以降のミリ秒です。 時刻が "now" と示されていない場合は使用されます。

--hub-name -n

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

--interface -i

フィルター処理するターゲット インターフェイス識別子。 例: dtmi:com:example:TemperatureController;1。

--login -l

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

--mc --message-count

モニターが終了する前にキャプチャするテレメトリ メッセージの数。 指定しない場合、モニターは、ハブからメッセージを受信しないというタイムアウトしきい値を満たすまで実行を続けます。

--module-id -m

ターゲット モジュール ID。

--properties --props -p

出力するキー メッセージのプロパティを指定します。 sys = システム プロパティ、app = アプリケーション プロパティ、anno = 注釈。

承認された値: all, anno, app, sys

--repair -r

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

承認された値: false, true

既定値: False

--resource-group -g

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

--timeout --to -t

メッセージを受信せずに接続を維持する最大秒数。 無限大には 0 を使用します。

既定値: 300

--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 を使います。

az iot hub monitor-feedback

cloud-to-device (C2D) メッセージに確認応答するためにデバイスによって送信されたフィードバックをモニターします。

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

az iot hub monitor-feedback [--auth-type {key, login}]
                            [--device-id]
                            [--hub-name]
                            [--login]
                            [--repair {false, true}]
                            [--resource-group]
                            [--wait-on-msg]
                            [--yes {false, true}]

例

基本的な使用方法

az iot hub monitor-feedback -n {iothub_name}

IoT Hub 接続文字列での基本的な使用方法

az iot hub monitor-feedback -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

ターゲット デバイスでフィルター処理するときの基本的な使用方法

az iot hub monitor-feedback -n {iothub_name} -d {device_id}

特定の ID (uuid) を持つメッセージを受信したときにフィードバック モニターを終了する

az iot hub monitor-feedback -n {iothub_name} -d {device_id} -w {message_id}

省略可能のパラメーター

--auth-type

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

承認された値: key, login

既定値: key

--device-id -d

ターゲット デバイス ID。

--hub-name -n

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

--login -l

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

--repair -r

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

承認された値: false, true

既定値: False

--resource-group -g

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

--wait-on-msg -w

フィードバック モニターは、特定の ID (uuid) のメッセージが受信されるまでブロックされます。

--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 を使います。

az iot hub query

強力な SQL に似た言語を使用して、IoT Hub に対するクエリを実行します。

デバイス ツインとモジュール ツイン、ジョブ、メッセージ ルーティングに関する情報を取得します。 詳細については、「 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language 」を参照してください。

az iot hub query --query-command
                 [--auth-type {key, login}]
                 [--hub-name]
                 [--login]
                 [--resource-group]
                 [--top]

例

Azure IoT Hub 内のすべてのデバイス ツイン データに対してクエリを実行します。

az iot hub query -n {iothub_name} -q "select * from devices"

ターゲット デバイス上のすべてのモジュール ツイン データに対してクエリを実行します。

az iot hub query -n {iothub_name} -q "select * from devices.modules where devices.deviceId = '{device_id}'"

必須のパラメーター

--query-command -q

実行するユーザー クエリ。

省略可能のパラメーター

--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> を使用して、既定のグループを構成できます。

--top

返される要素の最大数。 既定では、クエリには上限はありません。

グローバル パラメーター

--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 を使います。