az iot hub

Note

このコマンド グループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。 各拡張機能をインストールして、拡張機能を活用します。 拡張機能の詳細については、 を参照してください。

Azure IoT Hub を管理します。

コマンド

名前	説明	型	状態
az iot hub certificate	IoT Hub 証明書を管理します。	コアと拡張機能	GA
az iot hub certificate create	Azure IoT Hub 証明書を作成/アップロードします。	Core	GA
az iot hub certificate create (azure-iot 拡張機能)	Azure IoT Hub 証明書を作成/アップロードします。	Extension	GA
az iot hub certificate delete	Azure IoT Hub 証明書を削除します。	Core	GA
az iot hub certificate delete (azure-iot 拡張機能)	Azure IoT Hub 証明書を削除します。	Extension	GA
az iot hub certificate generate-verification-code	Azure IoT Hub 証明書の検証コードを生成します。	Core	GA
az iot hub certificate generate-verification-code (azure-iot 拡張機能)	Azure IoT Hub 証明書の検証コードを生成します。	Extension	GA
az iot hub certificate list	Azure IoT Hub に含まれるすべての証明書を一覧表示します。	Core	GA
az iot hub certificate list (azure-iot 拡張機能)	Azure IoT Hub に含まれるすべての証明書を一覧表示します。	Extension	GA
az iot hub certificate show	特定の Azure IoT Hub 証明書に関する情報を表示します。	Core	GA
az iot hub certificate show (azure-iot 拡張機能)	特定の Azure IoT Hub 証明書に関する情報を表示します。	Extension	GA
az iot hub certificate update	Azure IoT Hub 証明書を更新します。	Core	GA
az iot hub certificate update (azure-iot 拡張機能)	Azure IoT Hub 証明書を更新します。	Extension	GA
az iot hub certificate verify	Azure IoT Hub 証明書を検証します。	Core	GA
az iot hub certificate verify (azure-iot 拡張機能)	Azure IoT Hub 証明書を検証します。	Extension	GA
az iot hub configuration	IoT の自動デバイス管理構成を大規模に管理します。	Extension	GA
az iot hub configuration create	ターゲット IoT Hub に IoT 自動デバイス管理構成を作成します。	Extension	GA
az iot hub configuration delete	IoT デバイス構成を削除します。	Extension	GA
az iot hub configuration list	IoT Hub 内の IoT 自動デバイス管理構成を一覧表示します。	Extension	GA
az iot hub configuration show	IoT 自動デバイス管理構成の詳細を取得します。	Extension	GA
az iot hub configuration show-metric	IoT デバイス構成で定義されているターゲット ユーザーまたはシステム メトリックを評価します。	Extension	GA
az iot hub configuration update	IoT 自動デバイス管理構成の指定されたプロパティを更新します。	Extension	GA
az iot hub connection-string	IoT Hub 接続文字列を管理します。	Extension	GA
az iot hub connection-string show	指定したポリシー名とキーを使用して、指定した IoT Hub の接続文字列を表示します。	Extension	GA
az iot hub consumer-group	IoT ハブのイベント ハブ コンシューマー グループを管理します。	コアと拡張機能	GA
az iot hub consumer-group create	イベント ハブ コンシューマー グループを作成します。	Core	GA
az iot hub consumer-group create (azure-iot 拡張機能)	イベント ハブ コンシューマー グループを作成します。	Extension	GA
az iot hub consumer-group delete	イベント ハブ コンシューマー グループを削除します。	Core	GA
az iot hub consumer-group delete (azure-iot 拡張機能)	イベント ハブ コンシューマー グループを削除します。	Extension	GA
az iot hub consumer-group list	イベント ハブ コンシューマー グループを一覧表示します。	Core	GA
az iot hub consumer-group list (azure-iot 拡張機能)	イベント ハブ コンシューマー グループを一覧表示します。	Extension	GA
az iot hub consumer-group show	イベント ハブ コンシューマー グループの詳細を取得します。	Core	GA
az iot hub consumer-group show (azure-iot 拡張機能)	イベント ハブ コンシューマー グループの詳細を取得します。	Extension	GA
az iot hub create	Azure IoT ハブを作成します。	Core	GA
az iot hub create (azure-iot 拡張機能)	Azure IoT ハブを作成します。	Extension	GA
az iot hub delete	IoT ハブを削除します。	Core	GA
az iot hub delete (azure-iot 拡張機能)	IoT ハブを削除します。	Extension	GA
az iot hub device-identity	IoT デバイスを管理します。	Extension	GA
az iot hub device-identity children	IoT エッジ デバイスの子デバイスリレーションシップを管理します。	Extension	GA
az iot hub device-identity children add	デバイスを子としてターゲット エッジ デバイスに追加します。	Extension	GA
az iot hub device-identity children list	割り当てられた子デバイスのコレクションを出力します。	Extension	GA
az iot hub device-identity children remove	ターゲット エッジ デバイスから子デバイスを削除します。	Extension	GA
az iot hub device-identity connection-string	IoT デバイスの接続文字列を管理します。	Extension	GA
az iot hub device-identity connection-string show	特定の IoT Hub デバイス 接続文字列を表示します。	Extension	GA
az iot hub device-identity create	IoT Hub にデバイスを作成します。	Extension	GA
az iot hub device-identity delete	IoT Hub デバイスを削除します。	Extension	GA
az iot hub device-identity export	IoT Hub から Azure Storage BLOB コンテナーにすべてのデバイス ID をエクスポートします。	Extension	GA
az iot hub device-identity import	ストレージ コンテナー BLOB から IoT Hub にデバイス ID をインポートします。	Extension	GA
az iot hub device-identity list	IoT Hub 内のデバイスを一覧表示します。	Extension	GA
az iot hub device-identity parent	IoT デバイスの親デバイスのリレーションシップを管理します。	Extension	GA
az iot hub device-identity parent set	ターゲット デバイスの親デバイスを設定します。	Extension	GA
az iot hub device-identity parent show	ターゲット デバイスの親デバイスを取得します。	Extension	GA
az iot hub device-identity renew-key	Sas 認証を使用して IoT Hub デバイスのターゲット キーを更新します。	Extension	GA
az iot hub device-identity show	IoT Hub デバイスの詳細を取得します。	Extension	GA
az iot hub device-identity update	IoT Hub デバイスを更新します。	Extension	GA
az iot hub device-twin	IoT デバイス ツインの構成を管理します。	Extension	GA
az iot hub device-twin list	IoT Hub 内のデバイス ツインを一覧表示します。	Extension	GA
az iot hub device-twin replace	デバイス ツイン定義をターゲット json に置き換えます。	Extension	GA
az iot hub device-twin show	デバイス ツイン定義を取得します。	Extension	GA
az iot hub device-twin update	デバイス ツインの必要なプロパティとタグを更新します。	Extension	GA
az iot hub devicestream	IoT ハブのデバイス ストリームを管理します。	Extension	Preview
az iot hub devicestream show	IoT Hub のデバイス ストリーム エンドポイントを取得します。	Extension	Preview
az iot hub digital-twin	IoT Hub デバイスのデジタル ツインを操作して操作します。	Extension	GA
az iot hub digital-twin invoke-command	デジタル ツイン デバイスのルートまたはコンポーネント レベルのコマンドを呼び出します。	Extension	GA
az iot hub digital-twin show	IoT Hub デバイスのデジタル ツインを表示します。	Extension	GA
az iot hub digital-twin update	JSON パッチ仕様を使用して、デジタル ツイン デバイスの読み取り/書き込みプロパティを更新します。	Extension	GA
az iot hub distributed-tracing	デバイスごとに分散設定を管理します。	Extension	Preview
az iot hub distributed-tracing show	デバイスの分散トレース設定を取得します。	Extension	Preview
az iot hub distributed-tracing update	デバイスの分散トレース オプションを更新します。	Extension	Preview
az iot hub generate-sas-token	ターゲット IoT Hub、デバイス、またはモジュールの SAS トークンを生成します。	Extension	GA
az iot hub identity	Azure IoT ハブの ID を管理します。	コアと拡張機能	GA
az iot hub identity assign	IoT Hub にマネージド ID を割り当てます。	Core	GA
az iot hub identity assign (azure-iot 拡張機能)	IoT Hub にマネージド ID を割り当てます。	Extension	GA
az iot hub identity remove	IoT Hub からマネージド ID を削除します。	Core	GA
az iot hub identity remove (azure-iot 拡張機能)	IoT Hub からマネージド ID を削除します。	Extension	GA
az iot hub identity show	IoT Hub の ID プロパティを表示します。	Core	GA
az iot hub identity show (azure-iot 拡張機能)	IoT Hub の ID プロパティを表示します。	Extension	GA
az iot hub invoke-device-method	デバイス メソッドを呼び出します。	Extension	GA
az iot hub invoke-module-method	モジュール メソッドを呼び出します。	Extension	GA
az iot hub job	IoT Hub ジョブ (v2) を管理します。	Extension	GA
az iot hub job cancel	IoT Hub ジョブを取り消します。	Extension	GA
az iot hub job create	IoT Hub ジョブを作成して実行のスケジュールを設定します。	Extension	GA
az iot hub job list	IoT Hub の履歴ジョブを一覧表示します。	Extension	GA
az iot hub job show	既存の IoT Hub ジョブの詳細を表示します。	Extension	GA
az iot hub list	IoT ハブを一覧表示します。	Core	GA
az iot hub list (azure-iot 拡張機能)	IoT ハブを一覧表示します。	Extension	GA
az iot hub list-skus	使用可能な価格レベルを一覧表示します。	Core	GA
az iot hub list-skus (azure-iot 拡張機能)	使用可能な価格レベルを一覧表示します。	Extension	GA
az iot hub manual-failover	geo ペアのディザスター リカバリー領域への IoT Hub の手動フェールオーバーを開始します。	Core	GA
az iot hub manual-failover (azure-iot 拡張機能)	geo ペアのディザスター リカバリー領域への IoT Hub の手動フェールオーバーを開始します。	Extension	GA
az iot hub message-endpoint	IoT ハブのカスタム エンドポイントを管理します。	Extension	Preview
az iot hub message-endpoint create	IoT Hub にエンドポイントを追加します。	Extension	Preview
az iot hub message-endpoint create cosmosdb-container	IoT Hub の Cosmos DB コンテナー エンドポイントを追加します。	Extension	Preview
az iot hub message-endpoint create eventhub	IoT Hub のイベント ハブ エンドポイントを追加します。	Extension	Preview
az iot hub message-endpoint create servicebus-queue	IoT Hub の Service Bus キュー エンドポイントを追加します。	Extension	Preview
az iot hub message-endpoint create servicebus-topic	IoT Hub の Service Bus トピック エンドポイントを追加します。	Extension	Preview
az iot hub message-endpoint create storage-container	IoT Hub のストレージ コンテナー エンドポイントを追加します。	Extension	Preview
az iot hub message-endpoint delete	IoT Hub のすべてまたは特定のエンドポイントを削除します。	Extension	Preview
az iot hub message-endpoint list	IoT Hub のすべてのエンドポイントに関する情報を取得します。	Extension	Preview
az iot hub message-endpoint show	IoT Hub の前述のエンドポイントに関する情報を取得します。	Extension	Preview
az iot hub message-endpoint update	IoT Hub の既存のエンドポイントのプロパティを更新します。	Extension	Preview
az iot hub message-endpoint update cosmosdb-container	IoT Hub の既存の Cosmos DB コンテナー エンドポイントのプロパティを更新します。	Extension	Preview
az iot hub message-endpoint update eventhub	IoT Hub の既存のイベント ハブ エンドポイントのプロパティを更新します。	Extension	Preview
az iot hub message-endpoint update servicebus-queue	IoT Hub の既存の Service Bus キュー エンドポイントのプロパティを更新します。	Extension	Preview
az iot hub message-endpoint update servicebus-topic	IoT Hub の既存の Service Bus トピック エンドポイントのプロパティを更新します。	Extension	Preview
az iot hub message-endpoint update storage-container	IoT Hub の既存のストレージ コンテナー エンドポイントのプロパティを更新します。	Extension	Preview
az iot hub message-enrichment	IoT Hub のエンドポイントのメッセージ エンリッチメントを管理します。	コアと拡張機能	GA
az iot hub message-enrichment create	IoT Hub で選択したエンドポイントのメッセージ エンリッチメントを作成します。	Core	GA
az iot hub message-enrichment create (azure-iot 拡張機能)	IoT Hub で選択したエンドポイントのメッセージ エンリッチメントを作成します。	Extension	GA
az iot hub message-enrichment delete	IoT ハブのメッセージ エンリッチメントを (キー別に) 削除します。	Core	GA
az iot hub message-enrichment delete (azure-iot 拡張機能)	IoT ハブのメッセージ エンリッチメントを (キー別に) 削除します。	Extension	GA
az iot hub message-enrichment list	IoT Hub のすべてのメッセージ エンリッチメントに関する情報を取得します。	Core	GA
az iot hub message-enrichment list (azure-iot 拡張機能)	IoT Hub のすべてのメッセージ エンリッチメントに関する情報を取得します。	Extension	GA
az iot hub message-enrichment update	(キー別に) IoT ハブのメッセージ エンリッチメントを更新します。	Core	GA
az iot hub message-enrichment update (azure-iot 拡張機能)	(キー別に) IoT ハブのメッセージ エンリッチメントを更新します。	Extension	GA
az iot hub message-route	IoT ハブのルートを管理します。	Extension	Preview
az iot hub message-route create	IoT Hub のルートを追加します。	Extension	Preview
az iot hub message-route delete	IoT Hub 内のすべてのルートまたは前述のルートを削除します。	Extension	Preview
az iot hub message-route fallback	IoT ハブのフォールバック ルートを管理します。	Extension	Preview
az iot hub message-route fallback set	IoT Hub でフォールバック ルートを有効または無効にします。	Extension	Preview
az iot hub message-route fallback show	IoT Hub のフォールバック ルートを表示します。	Extension	Preview
az iot hub message-route list	IoT Hub 内のすべてのルートを取得します。	Extension	Preview
az iot hub message-route show	IoT Hub 内のルートに関する情報を取得します。	Extension	Preview
az iot hub message-route test	IoT Hub 内のすべてのルートまたは前述のルートをテストします。	Extension	Preview
az iot hub message-route update	IoT Hub のルートを更新します。	Extension	Preview
az iot hub module-identity	IoT デバイス モジュールを管理します。	Extension	GA
az iot hub module-identity connection-string	IoT デバイス モジュールの接続文字列を管理します。	Extension	GA
az iot hub module-identity connection-string show	ターゲット IoT デバイス モジュールの接続文字列を表示します。	Extension	GA
az iot hub module-identity create	IoT Hub 内のターゲット IoT デバイスにモジュールを作成します。	Extension	GA
az iot hub module-identity delete	IoT Hub 内のデバイスを削除します。	Extension	GA
az iot hub module-identity list	IoT Hub 内の IoT デバイスにあるモジュールを一覧表示します。	Extension	GA
az iot hub module-identity renew-key	Sas 認証を使用して IoT Hub デバイス モジュールのターゲット キーを更新します。	Extension	GA
az iot hub module-identity show	IoT Hub 内の IoT デバイス モジュールの詳細を取得します。	Extension	GA
az iot hub module-identity update	IoT Hub デバイス モジュールを更新します。	Extension	GA
az iot hub module-twin	IoT デバイス モジュール ツイン構成を管理します。	Extension	GA
az iot hub module-twin replace	モジュール ツイン定義をターゲット json に置き換えます。	Extension	GA
az iot hub module-twin show	モジュール ツイン定義を表示します。	Extension	GA
az iot hub module-twin update	モジュール ツインの必要なプロパティとタグを更新します。	Extension	GA
az iot hub monitor-events	IoT Hub に送信されたデバイス テレメトリとメッセージを監視します。	Extension	GA
az iot hub monitor-feedback	cloud-to-device (C2D) メッセージに確認応答するためにデバイスによって送信されたフィードバックをモニターします。	Extension	GA
az iot hub policy	IoT ハブの共有アクセス ポリシーを管理します。	コアと拡張機能	GA
az iot hub policy create	IoT ハブに新しい共有アクセス ポリシーを作成します。	Core	GA
az iot hub policy create (azure-iot 拡張機能)	IoT ハブに新しい共有アクセス ポリシーを作成します。	Extension	GA
az iot hub policy delete	IoT ハブから共有アクセス ポリシーを削除します。	Core	GA
az iot hub policy delete (azure-iot 拡張機能)	IoT ハブから共有アクセス ポリシーを削除します。	Extension	GA
az iot hub policy list	IoT ハブの共有アクセス ポリシーを一覧表示します。	Core	GA
az iot hub policy list (azure-iot 拡張機能)	IoT ハブの共有アクセス ポリシーを一覧表示します。	Extension	GA
az iot hub policy renew-key	IoT ハブの共有アクセス ポリシーのキーを再生成します。	Core	GA
az iot hub policy renew-key (azure-iot 拡張機能)	IoT ハブの共有アクセス ポリシーのキーを再生成します。	Extension	GA
az iot hub policy show	IoT ハブの共有アクセス ポリシーの詳細を取得します。	Core	GA
az iot hub policy show (azure-iot 拡張機能)	IoT ハブの共有アクセス ポリシーの詳細を取得します。	Extension	GA
az iot hub query	強力な SQL に似た言語を使用して IoT Hub にクエリを実行します。	Extension	GA
az iot hub show	IoT ハブの詳細を取得します。	Core	GA
az iot hub show (azure-iot 拡張機能)	IoT ハブの詳細を取得します。	Extension	GA
az iot hub show-quota-metrics	IoT ハブのクォータ メトリックを取得します。	Core	GA
az iot hub show-quota-metrics (azure-iot 拡張機能)	IoT ハブのクォータ メトリックを取得します。	Extension	GA
az iot hub show-stats	IoT ハブの統計情報を取得します。	Core	GA
az iot hub show-stats (azure-iot 拡張機能)	IoT ハブの統計情報を取得します。	Extension	GA
az iot hub state	IoT Hub の状態を管理します。	Extension	Experimental
az iot hub state export	IoT Hub の状態をファイルにエクスポートします。	Extension	Experimental
az iot hub state import	ファイルから IoT Hub にハブの状態をインポートします。	Extension	Experimental
az iot hub state migrate	ファイルに保存せずに、あるハブの状態を別のハブに移行します。	Extension	Experimental
az iot hub update	IoT ハブのメタデータを更新します。	Core	GA
az iot hub update (azure-iot 拡張機能)	IoT ハブのメタデータを更新します。	Extension	GA
az iot hub wait	IoT Hub インスタンスの操作が完了するまで待ちます。	Core	GA

az iot hub create

Azure IoT ハブを作成します。

Azure IoT Hub の概要については、 https://learn.microsoft.com/azure/iot-hub/を参照してください。

az iot hub create --name
                  --resource-group
                  [--c2d-max-delivery-count --cdd]
                  [--c2d-ttl --ct]
                  [--dds --disable-device-sas {false, true}]
                  [--disable-local-auth --dla {false, true}]
                  [--disable-module-sas --dms {false, true}]
                  [--edr --enforce-data-residency {false, true}]
                  [--fc --fileupload-storage-container-name]
                  [--fcs --fileupload-storage-connectionstring]
                  [--fd --feedback-max-delivery-count]
                  [--feedback-lock-duration --fld]
                  [--feedback-ttl --ft]
                  [--fileupload-notification-lock-duration --fnld]
                  [--fileupload-notification-max-delivery-count --fnd]
                  [--fileupload-notification-ttl --fnt]
                  [--fileupload-notifications --fn {false, true}]
                  [--fileupload-sas-ttl --fst]
                  [--fileupload-storage-auth-type --fsa {identityBased, keyBased}]
                  [--fileupload-storage-identity --fsi]
                  [--location]
                  [--mi-system-assigned {false, true}]
                  [--mi-user-assigned]
                  [--min-tls-version --mintls]
                  [--no-wait]
                  [--partition-count]
                  [--rd --retention-day]
                  [--role]
                  [--scopes]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--tags]
                  [--unit]

例

リソース グループのリージョンに、無料価格レベル F1 の IoT Hub を作成します。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --sku F1 --partition-count 2

タグを使用して、"westus" リージョンに Standard 価格レベル S1 と 4 のパーティションを持つ IoT Hub を作成します。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --tags a=b c=d

システム割り当てマネージド ID を使用して IoT Hub を作成し、作成された ID のストレージ アカウントにロールとスコープを割り当てます。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --mi-system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

ローカル認証、デバイス SAS キー、モジュール SAS キーがすべて無効になっている IoT Hub を作成する

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --disable-local-auth --disable-device-sas --disable-module-sas

データ所在地が適用された IoT Hub を作成します。 これにより、リージョン間のディザスター リカバリーが無効になります。

az iot hub create --resource-group MyResourceGroup --name MyIoTHub --edr

必須のパラメーター

--name -n

IoT Hub 名。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--c2d-max-delivery-count --cdd

IoT ハブがクラウドからデバイスへのメッセージのデバイスへの配信を試行する回数 (1 ~ 100)。

プロパティ	値
規定値:	10

--c2d-ttl --ct

IoT Hub によって期限切れになるまでにデバイスがメッセージを使用できる時間 (1 ~ 48 時間)。

プロパティ	値
規定値:	1

--dds --disable-device-sas

認証のためにすべてのデバイス (Edge デバイスを含むが、モジュールを除く) スコープ SAS キーを無効にするかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--disable-local-auth --dla

認証のために IoT ハブ スコープの SAS キーを無効にするかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--disable-module-sas --dms

モジュール スコープの SAS キーを認証用に無効にするかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--edr --enforce-data-residency

リージョン間のディザスター リカバリーを無効にして、この IoT Hub のデータ所在地を強制します。 このプロパティは、リソースに設定されると変更できません。 一部のリージョンでのみ使用できます。 詳細については、https://aka.ms/iothubdisabledrを参照してください。

プロパティ	値
指定可能な値:	false, true

--fc --fileupload-storage-container-name

ファイルをアップロードするルート コンテナーの名前。 コンテナーは存在する必要はありませんが、指定された connectionString を使用して作成できる必要があります。

--fcs --fileupload-storage-connectionstring

ファイルがアップロードされる Azure Storage アカウントの接続文字列。

--fd --feedback-max-delivery-count

IoT ハブがフィードバック キューにメッセージを配信しようとした回数 (1 ~ 100)。

プロパティ	値
規定値:	10

--feedback-lock-duration --fld

フィードバック キューのロック期間 (5 ~ 300 秒)。

プロパティ	値
規定値:	5

--feedback-ttl --ft

クラウドからデバイスへのメッセージの有効期限または配信について、IoT ハブが 1 から 48 時間の間にフィードバックを保持する期間。

プロパティ	値
規定値:	1

--fileupload-notification-lock-duration --fnld

ファイル アップロード通知キューのロック期間 (5 ~ 300 秒)。

プロパティ	値
規定値:	5

--fileupload-notification-max-delivery-count --fnd

IoT ハブがファイル通知メッセージの配信を試行する回数 (1 ~ 100)。

プロパティ	値
規定値:	10

--fileupload-notification-ttl --fnt

IoT Hub によって有効期限が切れるまでの 1 時間から 48 時間の間に、サービスが使用できるファイル アップロード通知の時間。

プロパティ	値
規定値:	1

--fileupload-notifications --fn

アップロードされたファイルに関する情報をメッセージ/servicebound/filenotifications IoT Hub エンドポイントにログに記録するかどうかを示すブール値。

プロパティ	値
規定値:	False
指定可能な値:	false, true

--fileupload-sas-ttl --fst

IoT Hub によって生成された SAS URI が有効期限が切れるまでの有効期間 (1 ~ 24 時間)。

プロパティ	値
規定値:	1

--fileupload-storage-auth-type --fsa

ファイルのアップロード先となる Azure Storage アカウントの認証の種類。

プロパティ	値
指定可能な値:	identityBased, keyBased

--fileupload-storage-identity --fsi

ファイル アップロード認証に使用するマネージド ID。 '[system]' を使用して、システム割り当てマネージド ID またはリソース ID を参照して、ユーザー割り当てマネージド ID を参照します。

--location -l

IoT Hub の場所。 既定値は、ターゲット リソース グループの場所です。

--mi-system-assigned

このハブのシステム割り当てマネージド ID を有効にします。

プロパティ	値
指定可能な値:	false, true

--mi-user-assigned

このハブのユーザー割り当てマネージド ID を有効にします。 ID リソース ID のスペース区切りの一覧を受け入れます。

--min-tls-version --mintls

このハブをサポートする最小 TLS バージョンを指定します。 "1.0" または "1.2" に設定できます。 たとえば、TLS の最小バージョンが "1.2" に設定されている場合、1.2 未満の TLS バージョンを使用するクライアントは拒否されます。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--partition-count

デバイスからクラウドへのメッセージのバッキング イベント ハブのパーティションの数。

プロパティ	値
規定値:	4

--rd --retention-day

この IoT ハブがデバイスからクラウドへのイベントを 1 日から 7 日間保持する期間を指定します。

プロパティ	値
規定値:	1

--role

ハブのシステム割り当てマネージド ID に割り当てるロール。

--scopes

システム割り当てマネージド ID のロール (--role) を割り当てるスコープのスペース区切りリスト。

--sku

Azure IoT Hub の価格レベル。 各サブスクリプションで使用できる無料の IoT ハブ インスタンス (F1) は 1 つだけであることに注意してください。 空きインスタンスが 1 を超えると、例外がスローされます。

プロパティ	値
規定値:	S1
指定可能な値:	B1, B2, B3, F1, S1, S2, S3

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--unit

IoT Hub 内のユニット。

プロパティ	値
規定値:	1

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub create (azure-iot 拡張機能)

Azure IoT ハブを作成します。

Azure IoT Hub の概要については、 https://learn.microsoft.com/azure/iot-hub/を参照してください。

az iot hub create --name
                  --resource-group
                  [--c2d-max-delivery-count --cdd]
                  [--c2d-ttl --ct]
                  [--custom-ns-role-id]
                  [--dds --disable-device-sas {false, true}]
                  [--disable-local-auth --dla {false, true}]
                  [--disable-module-sas --dms {false, true}]
                  [--edr --enforce-data-residency {false, true}]
                  [--fc --fileupload-storage-container-name]
                  [--fcs --fileupload-storage-connectionstring]
                  [--fd --feedback-max-delivery-count]
                  [--feedback-lock-duration --fld]
                  [--feedback-ttl --ft]
                  [--fileupload-notification-lock-duration --fnld]
                  [--fileupload-notification-max-delivery-count --fnd]
                  [--fileupload-notification-ttl --fnt]
                  [--fileupload-notifications --fn {false, true}]
                  [--fileupload-sas-ttl --fst]
                  [--fileupload-storage-auth-type --fsa {identityBased, keyBased}]
                  [--fileupload-storage-identity --fsi]
                  [--location]
                  [--mi-system-assigned {false, true}]
                  [--mi-user-assigned]
                  [--min-tls-version --mintls]
                  [--no-wait]
                  [--ns-identity-id]
                  [--ns-resource-id]
                  [--partition-count]
                  [--rd --retention-day]
                  [--role]
                  [--scopes]
                  [--skip-ns-ra {false, true}]
                  [--sku {B1, B2, B3, F1, GEN2, S1, S2, S3}]
                  [--tags]
                  [--unit]

例

リソース グループのリージョンに、無料価格レベル F1 の IoT Hub を作成します。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --sku F1 --partition-count 2

タグを使用して、"westus" リージョンに Standard 価格レベル S1 と 4 のパーティションを持つ IoT Hub を作成します。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --tags a=b c=d

システム割り当てマネージド ID を使用して IoT Hub を作成し、作成された ID のストレージ アカウントにロールとスコープを割り当てます。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --mi-system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

ローカル認証、デバイス SAS キー、モジュール SAS キーがすべて無効になっている IoT Hub を作成する

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --disable-local-auth --disable-device-sas --disable-module-sas

データ所在地が適用された IoT Hub を作成します。 これにより、リージョン間のディザスター リカバリーが無効になります。

az iot hub create --resource-group MyResourceGroup --name MyIoTHub --edr

Device Registry 名前空間プロパティを使用して Generation2 IoT Hub を作成します。

az iot hub create --resource-group MyResourceGroup --name MyHub --sku GEN2 --ns-resource-id NamespaceResourceId --ns-identity-id UserIdentityResourceId

Device Registry 名前空間のプロパティとカスタム ロールの割り当てを使用して Generation2 IoT Hub を作成します。

az iot hub create --resource-group MyResourceGroup --name MyHub --sku GEN2 --ns-resource-id NamespaceResourceId --ns-identity-id UserIdentityResourceId --custom-ns-role-id RoleResourceId

Device Registry 名前空間プロパティを使用して Generation2 IoT Hub を作成し、ロールの割り当てをスキップします。

az iot hub create --resource-group MyResourceGroup --name MyHub --sku GEN2 --ns-resource-id NamespaceResourceId --ns-identity-id UserIdentityResourceId --skip-ns-ra

必須のパラメーター

--name -n

IoT Hub 名。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--c2d-max-delivery-count --cdd

IoT ハブがクラウドからデバイスへのメッセージのデバイスへの配信を試行する回数 (1 ~ 100)。

プロパティ	値
規定値:	10

--c2d-ttl --ct

IoT Hub によって期限切れになるまでにデバイスがメッセージを使用できる時間 (1 ~ 48 時間)。

プロパティ	値
規定値:	1

--custom-ns-role-id

ADR 名前空間に適用する完全修飾ロール定義 ID(/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleDefinitions/{roleId})。 Gen2 IoT Hubs にのみ適用されます。

プロパティ	値
パラメーター グループ:	ADR Namespace Role Assignment Arguments

--dds --disable-device-sas

認証のためにすべてのデバイス (Edge デバイスを含むが、モジュールを除く) スコープ SAS キーを無効にするかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--disable-local-auth --dla

認証のために IoT ハブ スコープの SAS キーを無効にするかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--disable-module-sas --dms

モジュール スコープの SAS キーを認証用に無効にするかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--edr --enforce-data-residency

リージョン間のディザスター リカバリーを無効にして、この IoT Hub のデータ所在地を強制します。 このプロパティは、リソースに設定されると変更できません。 一部のリージョンでのみ使用できます。 詳細については、https://aka.ms/iothubdisabledrを参照してください。

プロパティ	値
指定可能な値:	false, true

--fc --fileupload-storage-container-name

ファイルをアップロードするルート コンテナーの名前。 コンテナーは存在する必要はありませんが、指定された connectionString を使用して作成できる必要があります。

--fcs --fileupload-storage-connectionstring

ファイルがアップロードされる Azure Storage アカウントの接続文字列。

--fd --feedback-max-delivery-count

IoT ハブがフィードバック キューにメッセージを配信しようとした回数 (1 ~ 100)。

プロパティ	値
規定値:	10

--feedback-lock-duration --fld

フィードバック キューのロック期間 (5 ~ 300 秒)。

プロパティ	値
規定値:	5

--feedback-ttl --ft

クラウドからデバイスへのメッセージの有効期限または配信について、IoT ハブが 1 から 48 時間の間にフィードバックを保持する期間。

プロパティ	値
規定値:	1

--fileupload-notification-lock-duration --fnld

ファイル アップロード通知キューのロック期間 (5 ~ 300 秒)。

プロパティ	値
規定値:	5

--fileupload-notification-max-delivery-count --fnd

IoT ハブがファイル通知メッセージの配信を試行する回数 (1 ~ 100)。

プロパティ	値
規定値:	10

--fileupload-notification-ttl --fnt

IoT Hub によって有効期限が切れるまでの 1 時間から 48 時間の間に、サービスが使用できるファイル アップロード通知の時間。

プロパティ	値
規定値:	1

--fileupload-notifications --fn

アップロードされたファイルに関する情報をメッセージ/servicebound/filenotifications IoT Hub エンドポイントにログに記録するかどうかを示すブール値。

プロパティ	値
規定値:	False
指定可能な値:	false, true

--fileupload-sas-ttl --fst

IoT Hub によって生成された SAS URI が有効期限が切れるまでの有効期間 (1 ~ 24 時間)。

プロパティ	値
規定値:	1

--fileupload-storage-auth-type --fsa

ファイルのアップロード先となる Azure Storage アカウントの認証の種類。

プロパティ	値
指定可能な値:	identityBased, keyBased

--fileupload-storage-identity --fsi

ファイル アップロード認証に使用するマネージド ID。 '[system]' を使用して、システム割り当てマネージド ID またはリソース ID を参照して、ユーザー割り当てマネージド ID を参照します。

--location -l

IoT Hub の場所。 既定値は、ターゲット リソース グループの場所です。

--mi-system-assigned

このハブのシステム割り当てマネージド ID を有効にします。

プロパティ	値
指定可能な値:	false, true

--mi-user-assigned

このハブのユーザー割り当てマネージド ID を有効にします。 ID リソース ID のスペース区切りの一覧を受け入れます。

--min-tls-version --mintls

このハブをサポートする最小 TLS バージョンを指定します。 "1.0" または "1.2" に設定できます。 たとえば、TLS の最小バージョンが "1.2" に設定されている場合、1.2 未満の TLS バージョンを使用するクライアントは拒否されます。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--ns-identity-id

Device Registry 名前空間にアクセスするためのユーザーマネージド ID リソース ID。

--ns-resource-id

この IoT ハブにリンクする Device Registry 名前空間リソース ID。

--partition-count

デバイスからクラウドへのメッセージのバッキング イベント ハブのパーティションの数。

プロパティ	値
規定値:	4

--rd --retention-day

この IoT ハブがデバイスからクラウドへのイベントを 1 日から 7 日間保持する期間を指定します。

プロパティ	値
規定値:	1

--role

ハブのシステム割り当てマネージド ID に割り当てるロール。

--scopes

システム割り当てマネージド ID のロール (--role) を割り当てるスコープのスペース区切りリスト。

--skip-ns-ra

IoT ハブの作成後に ADR 名前空間ロールの割り当てをスキップするために使用されます。 Gen2 IoT Hubs にのみ適用されます。

プロパティ	値
パラメーター グループ:	ADR Namespace Role Assignment Arguments
指定可能な値:	false, true

--sku

Azure IoT Hub の価格レベル。 各サブスクリプションで使用できる無料の IoT ハブ インスタンス (F1) は 1 つだけであることに注意してください。 空きインスタンスが 1 を超えると、例外がスローされます。

プロパティ	値
規定値:	S1
指定可能な値:	B1, B2, B3, F1, GEN2, S1, S2, S3

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--unit

IoT Hub 内のユニット。

プロパティ	値
規定値:	1

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub delete

IoT ハブを削除します。

az iot hub delete [--ids]
                  [--name]
                  [--no-wait]
                  [--resource-group]
                  [--subscription]

例

IoT ハブを削除します。 (autogenerated)

az iot hub delete --name MyIoTHub --resource-group MyResourceGroup

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub delete (azure-iot 拡張機能)

IoT ハブを削除します。

az iot hub delete [--ids]
                  [--name]
                  [--no-wait]
                  [--resource-group]
                  [--subscription]

例

IoT ハブを削除します。 (autogenerated)

az iot hub delete --name MyIoTHub --resource-group MyResourceGroup

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

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 --cs]
                              [--device-id]
                              [--du --duration]
                              [--hub-name]
                              [--key-type --kt {primary, secondary}]
                              [--login]
                              [--module-id]
                              [--pn --policy-name]
                              [--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'

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--auth-type

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

プロパティ	値
パラメーター グループ:	Access Control Arguments
規定値:	key
指定可能な値:	key, login

--connection-string --cs

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

--device-id -d

ターゲット デバイス ID。

--du --duration

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

プロパティ	値
規定値:	3600

--hub-name -n

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--key-type --kt

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

プロパティ	値
規定値:	primary
指定可能な値:	primary, secondary

--login -l

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--module-id -m

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

--pn --policy-name

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

プロパティ	値
規定値:	iothubowner

--resource-group -g

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

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub invoke-device-method

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

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

例

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

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

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--auth-type

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

プロパティ	値
パラメーター グループ:	Access Control Arguments
規定値:	key
指定可能な値:	key, login

--hub-name -n

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--login -l

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--method-payload --mp

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

プロパティ	値
規定値:	{}

--resource-group -g

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

--timeout --to

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

プロパティ	値
規定値:	30

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub invoke-module-method

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

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

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

例

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

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。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--auth-type

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

プロパティ	値
パラメーター グループ:	Access Control Arguments
規定値:	key
指定可能な値:	key, login

--hub-name -n

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--login -l

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--method-payload --mp

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

プロパティ	値
規定値:	{}

--resource-group -g

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

--timeout --to

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

プロパティ	値
規定値:	30

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub list

IoT ハブを一覧表示します。

az iot hub list [--resource-group]

例

サブスクリプション内のすべての IoT ハブを一覧表示します。

az iot hub list

リソース グループ 'MyGroup' 内のすべての IoT ハブを一覧表示する

az iot hub list --resource-group MyGroup

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--resource-group -g

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

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub list (azure-iot 拡張機能)

IoT ハブを一覧表示します。

az iot hub list [--resource-group]

例

サブスクリプション内のすべての IoT ハブを一覧表示します。

az iot hub list

リソース グループ 'MyGroup' 内のすべての IoT ハブを一覧表示する

az iot hub list --resource-group MyGroup

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--resource-group -g

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

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub list-skus

使用可能な価格レベルを一覧表示します。

az iot hub list-skus [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

例

使用可能な価格レベルを一覧表示します。 (autogenerated)

az iot hub list-skus --name MyIoTHub

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub list-skus (azure-iot 拡張機能)

使用可能な価格レベルを一覧表示します。

az iot hub list-skus [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

例

使用可能な価格レベルを一覧表示します。 (autogenerated)

az iot hub list-skus --name MyIoTHub

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub manual-failover

geo ペアのディザスター リカバリー領域への IoT Hub の手動フェールオーバーを開始します。

az iot hub manual-failover [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]

例

プライマリ リージョンからセカンダリ リージョンへのフェールオーバー "myhub" を開始します。

az iot hub manual-failover -n myhub

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub manual-failover (azure-iot 拡張機能)

geo ペアのディザスター リカバリー領域への IoT Hub の手動フェールオーバーを開始します。

az iot hub manual-failover [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]

例

プライマリ リージョンからセカンダリ リージョンへのフェールオーバー "myhub" を開始します。

az iot hub manual-failover -n myhub

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub monitor-events

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

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

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

az iot hub monitor-events [--cg --consumer-group]
                          [--content-type --ct]
                          [--device-id]
                          [--device-query]
                          [--enqueued-time --et]
                          [--hub-name]
                          [--interface]
                          [--login]
                          [--mc --message-count]
                          [--module-id]
                          [--properties --props {all, anno, app, sys}]
                          [--repair {false, true}]
                          [--resource-group]
                          [--timeout --to]
                          [--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}

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--interface -i

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

--login -l

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--mc --message-count

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

--module-id -m

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

--properties --props -p

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

プロパティ	値
指定可能な値:	all, anno, app, sys

--repair -r

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

プロパティ	値
規定値:	False
指定可能な値:	false, true

--resource-group -g

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

--timeout --to -t

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

プロパティ	値
規定値:	300

--yes -y

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

プロパティ	値
規定値:	False
指定可能な値:	false, true

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

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}

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--auth-type

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

プロパティ	値
パラメーター グループ:	Access Control Arguments
規定値:	key
指定可能な値:	key, login

--device-id -d

ターゲット デバイス ID。

--hub-name -n

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--login -l

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--repair -r

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

プロパティ	値
規定値:	False
指定可能な値:	false, true

--resource-group -g

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

--wait-on-msg -w

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

--yes -y

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

プロパティ	値
規定値:	False
指定可能な値:	false, true

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub query

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

デバイス ツインとモジュール ツイン、ジョブ、メッセージ ルーティングに関する情報を取得します。 詳細については、https://learn.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

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--auth-type

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

プロパティ	値
パラメーター グループ:	Access Control Arguments
規定値:	key
指定可能な値:	key, login

--hub-name -n

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--login -l

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--resource-group -g

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

--top

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

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub show

IoT ハブの詳細を取得します。

az iot hub show [--ids]
                [--name]
                [--resource-group]
                [--subscription]

例

IoT ハブの詳細を取得します。 (autogenerated)

az iot hub show --name MyIoTHub

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub show (azure-iot 拡張機能)

IoT ハブの詳細を取得します。

az iot hub show [--ids]
                [--name]
                [--resource-group]
                [--subscription]

例

IoT ハブの詳細を取得します。 (autogenerated)

az iot hub show --name MyIoTHub

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub show-quota-metrics

IoT ハブのクォータ メトリックを取得します。

az iot hub show-quota-metrics [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

例

IoT ハブのクォータ メトリックを取得します。 (autogenerated)

az iot hub show-quota-metrics --ids {ids}

IoT ハブのクォータ メトリックを取得します。 (autogenerated)

az iot hub show-quota-metrics --name MyIoTHub

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub show-quota-metrics (azure-iot 拡張機能)

IoT ハブのクォータ メトリックを取得します。

az iot hub show-quota-metrics [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

例

IoT ハブのクォータ メトリックを取得します。 (autogenerated)

az iot hub show-quota-metrics --ids {ids}

IoT ハブのクォータ メトリックを取得します。 (autogenerated)

az iot hub show-quota-metrics --name MyIoTHub

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub show-stats

IoT ハブの統計情報を取得します。

az iot hub show-stats [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

例

IoT ハブの統計情報を取得します。 (autogenerated)

az iot hub show-stats --name MyIoTHub

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub show-stats (azure-iot 拡張機能)

IoT ハブの統計情報を取得します。

az iot hub show-stats [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

例

IoT ハブの統計情報を取得します。 (autogenerated)

az iot hub show-stats --name MyIoTHub

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub update

IoT ハブのメタデータを更新します。

az iot hub update [--add]
                  [--c2d-max-delivery-count --cdd]
                  [--c2d-ttl --ct]
                  [--dds --disable-device-sas {false, true}]
                  [--disable-local-auth --dla {false, true}]
                  [--disable-module-sas --dms {false, true}]
                  [--fc --fileupload-storage-container-name]
                  [--fcs --fileupload-storage-connectionstring]
                  [--fd --feedback-max-delivery-count]
                  [--feedback-lock-duration --fld]
                  [--feedback-ttl --ft]
                  [--fileupload-notification-lock-duration --fnld]
                  [--fileupload-notification-max-delivery-count --fnd]
                  [--fileupload-notification-ttl --fnt]
                  [--fileupload-notifications --fn {false, true}]
                  [--fileupload-sas-ttl --fst]
                  [--fileupload-storage-auth-type --fsa {identityBased, keyBased}]
                  [--fileupload-storage-identity --fsi]
                  [--force-string]
                  [--ids]
                  [--min-tls-version --mintls]
                  [--name]
                  [--rd --retention-day]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--subscription]
                  [--tags]
                  [--unit]

例

ファイルのアップロードにストレージ コンテナー設定を追加する

az iot hub update --name MyIotHub --fileupload-storage-connectionstring "connection-string" \ --fileupload-storage-container-name "container_name"

IP マスク 127.0.0.0/31 からのトラフィックを受け入れるファイアウォール フィルター規則を追加します。

az iot hub update --name MyIotHub --add properties.ipFilterRules filter_name=test-rule action=Accept ip_mask=127.0.0.0/31

IoT ハブのメタデータを更新します。 (autogenerated)

az iot hub update --name MyIotHub --set properties.allocationPolicy="GeoLatency"

IoT Hub のユニットを 2 に更新し、タグを追加する

az iot hub update -n MyIotHub --unit 2 --tags a=b c=d

IoT Hub の価格レベルを S2 として更新する

az iot hub update -n MyIotHub --sku S2

IoT Hub デバイスからクラウドへのイベントのリテンション期間を 3 日として更新する

az iot hub update -n MyIotHub --retention-day 3

IoT Hub のクラウドからデバイスへのメッセージング設定を更新する

az iot hub update --name MyIotHub --c2d-max-delivery-count 30 --c2d-ttl 5

IoT Hub フィードバック キューの設定を更新する

az iot hub update --name MyIoTHub --feedback-max-delivery-count 20 --feedback-lock-duration 100 --feedback-ttl 4

IoT Hub ファイルのアップロード設定を更新し、ファイルアップロードのためにマネージド ID をユーザーに割り当てる

az iot hub update -n MyIoTHub --fileupload-sas-ttl 5 --fileupload-storage-auth-type identityBased --fileupload-storage-identity [system]

IoT Hub ファイルのアップロード通知設定とキュー ロック期間を更新する

az iot hub update -n MyIoTHub --fileupload-notification-max-delivery-count 50 --fileupload-notification-ttl 48 --fileupload-notifications --fileupload-notification-lock-duration 10

IoT Hub のローカル認証、デバイス SAS、およびモジュール SAS の設定を更新する

az iot hub update -n MyIoTHub --disable-local-auth --disable-device-sas false --disable-module-sas true

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

プロパティ	値
パラメーター グループ:	Generic Update Arguments
規定値:	[]

--c2d-max-delivery-count --cdd

IoT ハブがクラウドからデバイスへのメッセージのデバイスへの配信を試行する回数 (1 ~ 100)。

--c2d-ttl --ct

IoT Hub によって期限切れになるまでにデバイスがメッセージを使用できる時間 (1 ~ 48 時間)。

--dds --disable-device-sas

認証のためにすべてのデバイス (Edge デバイスを含むが、モジュールを除く) スコープ SAS キーを無効にするかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--disable-local-auth --dla

認証のために IoT ハブ スコープの SAS キーを無効にするかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--disable-module-sas --dms

モジュール スコープの SAS キーを認証用に無効にするかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--fc --fileupload-storage-container-name

ファイルをアップロードするルート コンテナーの名前。 コンテナーは存在する必要はありませんが、指定された connectionString を使用して作成できる必要があります。

--fcs --fileupload-storage-connectionstring

ファイルがアップロードされる Azure Storage アカウントの接続文字列。

--fd --feedback-max-delivery-count

IoT ハブがフィードバック キューにメッセージを配信しようとした回数 (1 ~ 100)。

--feedback-lock-duration --fld

フィードバック キューのロック期間 (5 ~ 300 秒)。

--feedback-ttl --ft

クラウドからデバイスへのメッセージの有効期限または配信について、IoT ハブが 1 から 48 時間の間にフィードバックを保持する期間。

--fileupload-notification-lock-duration --fnld

ファイル アップロード通知キューのロック期間 (5 ~ 300 秒)。

--fileupload-notification-max-delivery-count --fnd

IoT ハブがファイル通知メッセージの配信を試行する回数 (1 ~ 100)。

--fileupload-notification-ttl --fnt

IoT Hub によって有効期限が切れるまでの 1 時間から 48 時間の間に、サービスが使用できるファイル アップロード通知の時間。

--fileupload-notifications --fn

アップロードされたファイルに関する情報をメッセージ/servicebound/filenotifications IoT Hub エンドポイントにログに記録するかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--fileupload-sas-ttl --fst

IoT Hub によって生成された SAS URI が有効期限が切れるまでの有効期間 (1 ~ 24 時間)。

--fileupload-storage-auth-type --fsa

ファイルのアップロード先となる Azure Storage アカウントの認証の種類。

プロパティ	値
指定可能な値:	identityBased, keyBased

--fileupload-storage-identity --fsi

ファイル アップロード認証に使用するマネージド ID。 '[system]' を使用して、システム割り当てマネージド ID またはリソース ID を参照して、ユーザー割り当てマネージド ID を参照します。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ	値
パラメーター グループ:	Generic Update Arguments
規定値:	False

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--min-tls-version --mintls

このハブをサポートする最小 TLS バージョンを指定します。 "1.0" または "1.2" に設定できます。 たとえば、TLS の最小バージョンが "1.2" に設定されている場合、1.2 未満の TLS バージョンを使用するクライアントは拒否されます。

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--rd --retention-day

この IoT ハブがデバイスからクラウドへのイベントを 1 日から 7 日間保持する期間を指定します。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ	値
パラメーター グループ:	Generic Update Arguments
規定値:	[]

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

プロパティ	値
パラメーター グループ:	Generic Update Arguments
規定値:	[]

--sku

Azure IoT Hub の価格レベル。 各サブスクリプションで使用できる無料の IoT ハブ インスタンス (F1) は 1 つだけであることに注意してください。 空きインスタンスが 1 を超えると、例外がスローされます。

プロパティ	値
指定可能な値:	B1, B2, B3, F1, S1, S2, S3

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--unit

IoT Hub 内のユニット。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub update (azure-iot 拡張機能)

IoT ハブのメタデータを更新します。

az iot hub update [--add]
                  [--c2d-max-delivery-count --cdd]
                  [--c2d-ttl --ct]
                  [--dds --disable-device-sas {false, true}]
                  [--disable-local-auth --dla {false, true}]
                  [--disable-module-sas --dms {false, true}]
                  [--fc --fileupload-storage-container-name]
                  [--fcs --fileupload-storage-connectionstring]
                  [--fd --feedback-max-delivery-count]
                  [--feedback-lock-duration --fld]
                  [--feedback-ttl --ft]
                  [--fileupload-notification-lock-duration --fnld]
                  [--fileupload-notification-max-delivery-count --fnd]
                  [--fileupload-notification-ttl --fnt]
                  [--fileupload-notifications --fn {false, true}]
                  [--fileupload-sas-ttl --fst]
                  [--fileupload-storage-auth-type --fsa {identityBased, keyBased}]
                  [--fileupload-storage-identity --fsi]
                  [--force-string]
                  [--ids]
                  [--min-tls-version --mintls]
                  [--name]
                  [--ns-identity-id]
                  [--rd --retention-day]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--sku {B1, B2, B3, F1, GEN2, S1, S2, S3}]
                  [--subscription]
                  [--tags]
                  [--unit]

例

ファイルのアップロードにストレージ コンテナー設定を追加する

az iot hub update --name MyIotHub --fileupload-storage-connectionstring "connection-string" \ --fileupload-storage-container-name "container_name"

IP マスク 127.0.0.0/31 からのトラフィックを受け入れるファイアウォール フィルター規則を追加します。

az iot hub update --name MyIotHub --add properties.ipFilterRules filter_name=test-rule action=Accept ip_mask=127.0.0.0/31

IoT ハブのメタデータを更新します。 (autogenerated)

az iot hub update --name MyIotHub --set properties.allocationPolicy="GeoLatency"

IoT Hub のユニットを 2 に更新し、タグを追加する

az iot hub update -n MyIotHub --unit 2 --tags a=b c=d

IoT Hub の価格レベルを S2 として更新する

az iot hub update -n MyIotHub --sku S2

IoT Hub デバイスからクラウドへのイベントのリテンション期間を 3 日として更新する

az iot hub update -n MyIotHub --retention-day 3

IoT Hub のクラウドからデバイスへのメッセージング設定を更新する

az iot hub update --name MyIotHub --c2d-max-delivery-count 30 --c2d-ttl 5

IoT Hub フィードバック キューの設定を更新する

az iot hub update --name MyIoTHub --feedback-max-delivery-count 20 --feedback-lock-duration 100 --feedback-ttl 4

IoT Hub ファイルのアップロード設定を更新し、ファイルアップロードのためにマネージド ID をユーザーに割り当てる

az iot hub update -n MyIoTHub --fileupload-sas-ttl 5 --fileupload-storage-auth-type identityBased --fileupload-storage-identity [system]

IoT Hub ファイルのアップロード通知設定とキュー ロック期間を更新する

az iot hub update -n MyIoTHub --fileupload-notification-max-delivery-count 50 --fileupload-notification-ttl 48 --fileupload-notifications --fileupload-notification-lock-duration 10

IoT Hub のローカル認証、デバイス SAS、およびモジュール SAS の設定を更新する

az iot hub update -n MyIoTHub --disable-local-auth --disable-device-sas false --disable-module-sas true

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

プロパティ	値
パラメーター グループ:	Generic Update Arguments
規定値:	[]

--c2d-max-delivery-count --cdd

IoT ハブがクラウドからデバイスへのメッセージのデバイスへの配信を試行する回数 (1 ~ 100)。

--c2d-ttl --ct

IoT Hub によって期限切れになるまでにデバイスがメッセージを使用できる時間 (1 ~ 48 時間)。

--dds --disable-device-sas

認証のためにすべてのデバイス (Edge デバイスを含むが、モジュールを除く) スコープ SAS キーを無効にするかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--disable-local-auth --dla

認証のために IoT ハブ スコープの SAS キーを無効にするかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--disable-module-sas --dms

モジュール スコープの SAS キーを認証用に無効にするかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--fc --fileupload-storage-container-name

ファイルをアップロードするルート コンテナーの名前。 コンテナーは存在する必要はありませんが、指定された connectionString を使用して作成できる必要があります。

--fcs --fileupload-storage-connectionstring

ファイルがアップロードされる Azure Storage アカウントの接続文字列。

--fd --feedback-max-delivery-count

IoT ハブがフィードバック キューにメッセージを配信しようとした回数 (1 ~ 100)。

--feedback-lock-duration --fld

フィードバック キューのロック期間 (5 ~ 300 秒)。

--feedback-ttl --ft

クラウドからデバイスへのメッセージの有効期限または配信について、IoT ハブが 1 から 48 時間の間にフィードバックを保持する期間。

--fileupload-notification-lock-duration --fnld

ファイル アップロード通知キューのロック期間 (5 ~ 300 秒)。

--fileupload-notification-max-delivery-count --fnd

IoT ハブがファイル通知メッセージの配信を試行する回数 (1 ~ 100)。

--fileupload-notification-ttl --fnt

IoT Hub によって有効期限が切れるまでの 1 時間から 48 時間の間に、サービスが使用できるファイル アップロード通知の時間。

--fileupload-notifications --fn

アップロードされたファイルに関する情報をメッセージ/servicebound/filenotifications IoT Hub エンドポイントにログに記録するかどうかを示すブール値。

プロパティ	値
指定可能な値:	false, true

--fileupload-sas-ttl --fst

IoT Hub によって生成された SAS URI が有効期限が切れるまでの有効期間 (1 ~ 24 時間)。

--fileupload-storage-auth-type --fsa

ファイルのアップロード先となる Azure Storage アカウントの認証の種類。

プロパティ	値
指定可能な値:	identityBased, keyBased

--fileupload-storage-identity --fsi

ファイル アップロード認証に使用するマネージド ID。 '[system]' を使用して、システム割り当てマネージド ID またはリソース ID を参照して、ユーザー割り当てマネージド ID を参照します。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ	値
パラメーター グループ:	Generic Update Arguments
規定値:	False

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--min-tls-version --mintls

このハブをサポートする最小 TLS バージョンを指定します。 "1.0" または "1.2" に設定できます。 たとえば、TLS の最小バージョンが "1.2" に設定されている場合、1.2 未満の TLS バージョンを使用するクライアントは拒否されます。

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--ns-identity-id

Device Registry 名前空間にアクセスするためのユーザーマネージド ID リソース ID。

--rd --retention-day

この IoT ハブがデバイスからクラウドへのイベントを 1 日から 7 日間保持する期間を指定します。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ	値
パラメーター グループ:	Generic Update Arguments
規定値:	[]

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

プロパティ	値
パラメーター グループ:	Generic Update Arguments
規定値:	[]

--sku

Azure IoT Hub の価格レベル。 各サブスクリプションで使用できる無料の IoT ハブ インスタンス (F1) は 1 つだけであることに注意してください。 空きインスタンスが 1 を超えると、例外がスローされます。

プロパティ	値
指定可能な値:	B1, B2, B3, F1, GEN2, S1, S2, S3

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--unit

IoT Hub 内のユニット。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub wait

IoT Hub インスタンスの操作が完了するまで待ちます。

az iot hub wait [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--ids]
                [--interval]
                [--name]
                [--resource-group]
                [--subscription]
                [--timeout]
                [--updated]

例

既存の IoT Hub インスタンスが作成されるまで待つ

az iot hub wait -n MyIoTHub --created

IoT Hub インスタンスが削除されるまで待つ

az iot hub wait -n MyIoTHub --deleted

既存の IoT Hub インスタンスがアクティブな状態になるまで待つ

az iot hub wait -n MyIoTHub --custom "properties.state=='Active'"

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments

--deleted

削除されるまで待ちます。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	False

--exists

リソースが存在するまで待ちます。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	False

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--interval

ポーリング間隔 (秒単位)。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	30

--name -n

IoT Hub 名。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--timeout

最大待機時間 (秒単位)。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False