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 証明書を作成/アップロードします。	コア	GA
az iot hub certificate delete	Azure IoT Hub 証明書を削除します。	コア	GA
az iot hub certificate generate-verification-code	Azure IoT Hub 証明書の検証コードを生成します。	コア	GA
az iot hub certificate list	Azure 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 certificate show	特定の Azure IoT Hub 証明書に関する情報を表示します。	コア	GA
az iot hub certificate update	Azure IoT Hub 証明書を更新します。	コア	GA
az iot hub certificate verify	Azure IoT Hub 証明書を検証します。	コア	GA
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 consumer-group	IoT ハブのイベントハブコンシューマーグループを管理します。	コア	GA
az iot hub consumer-group create	イベントハブコンシューマーグループを作成します。	コア	GA
az iot hub consumer-group delete	イベントハブコンシューマーグループを削除します。	コア	GA
az iot hub consumer-group list	イベントハブコンシューマーグループを一覧表示します。	コア	GA
az iot hub consumer-group show	イベントハブコンシューマーグループの詳細を取得します。	コア	GA
az iot hub create	Azure IoT ハブを作成します。	コア	GA
az iot hub delete	IoT ハブを削除します。	コア	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 devicestream	IoT ハブのデバイスストリームを管理します。	コア	プレビュー
az iot hub devicestream show	IoT Hub のデバイスストリームエンドポイントを取得します。	コア	プレビュー
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 identity	Azure IoT ハブの ID を管理します。	コア	GA
az iot hub identity assign	IoT Hub にマネージド ID を割り当てます。	コア	GA
az iot hub identity remove	IoT Hub からマネージド ID を削除します。	コア	GA
az iot hub identity show	IoT Hub の ID プロパティを表示します。	コア	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 list	IoT ハブを一覧表示します。	コア	GA
az iot hub list-skus	使用可能な価格レベルを一覧表示します。	コア	GA
az iot hub manual-failover	geo ペアのディザスターリカバリー領域への 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-enrichment	IoT Hub のエンドポイントのメッセージエンリッチメントを管理します。	コア	GA
az iot hub message-enrichment create	IoT Hub で選択したエンドポイントのメッセージエンリッチメントを作成します。	コア	GA
az iot hub message-enrichment delete	IoT ハブのメッセージエンリッチメントを (キー別に) 削除します。	コア	GA
az iot hub message-enrichment list	IoT Hub のすべてのメッセージエンリッチメントに関する情報を取得します。	コア	GA
az iot hub message-enrichment update	(キー別に) IoT ハブのメッセージエンリッチメントを更新します。	コア	GA
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 policy	IoT ハブの共有アクセスポリシーを管理します。	コア	GA
az iot hub policy create	IoT ハブに新しい共有アクセスポリシーを作成します。	コア	GA
az iot hub policy delete	IoT ハブから共有アクセスポリシーを削除します。	コア	GA
az iot hub policy list	IoT ハブの共有アクセスポリシーを一覧表示します。	コア	GA
az iot hub policy renew-key	IoT ハブの共有アクセスポリシーのキーを再生成します。	コア	GA
az iot hub policy show	IoT ハブの共有アクセスポリシーの詳細を取得します。	コア	GA
az iot hub query	強力な SQL に似た言語を使用して、IoT Hub に対するクエリを実行します。	拡張子	GA
az iot hub route	IoT ハブのルートを管理します。	コア	"非推奨"
az iot hub route create	IoT Hub でルートを作成します。	コア	"非推奨"
az iot hub route delete	IoT Hub のすべてのルートまたはメンションルートを削除します。	コア	"非推奨"
az iot hub route list	IoT Hub 内のすべてのルートを取得します。	コア	"非推奨"
az iot hub route show	IoT Hub のルートに関する情報を取得します。	コア	"非推奨"
az iot hub route test	IoT Hub 内のすべてのルートまたはメンションルートをテストします。	コア	"非推奨"
az iot hub route update	IoT Hub のルートを更新します。	コア	"非推奨"
az iot hub routing-endpoint	IoT ハブのカスタムエンドポイントを管理します。	コア	"非推奨"
az iot hub routing-endpoint create	IoT Hub にエンドポイントを追加します。	コア	"非推奨"
az iot hub routing-endpoint delete	IoT Hub のすべてのエンドポイントまたはメンションエンドポイントを削除します。	コア	"非推奨"
az iot hub routing-endpoint list	IoT Hub のすべてのエンドポイントに関する情報を取得します。	コア	"非推奨"
az iot hub routing-endpoint show	IoT Hub のメンションエンドポイントに関する情報を取得します。	コア	"非推奨"
az iot hub show	IoT ハブの詳細を取得します。	コア	GA
az iot hub show-connection-string	IoT ハブの接続文字列を表示します。	コア	"非推奨"
az iot hub show-quota-metrics	IoT ハブのクォータメトリックを取得します。	コア	GA
az iot hub show-stats	IoT ハブの統計情報を取得します。	コア	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 update	IoT ハブのメタデータを更新します。	コア	GA
az iot hub wait	IoT Hub インスタンスの操作が完了するまで待ちます。	コア	GA

az iot hub create

編集

Azure IoT ハブを作成します。

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

az iot hub create --name
                  --resource-group
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--dds {false, true}]
                  [--disable-local-auth {false, true}]
                  [--disable-module-sas {false, true}]
                  [--edr {false, true}]
                  [--fc]
                  [--fcs]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-lock-duration]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type {identityBased, keyBased}]
                  [--fileupload-storage-identity]
                  [--location]
                  [--mi-system-assigned {false, true}]
                  [--mi-user-assigned]
                  [--min-tls-version]
                  [--no-wait]
                  [--partition-count]
                  [--rd]
                  [--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> を使用して、既定のグループを構成できます。

省略可能のパラメーター

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

規定値: False

--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.2 より前の TLS バージョンを使用するクライアントを拒否するには、"1.2" に設定できます。

--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 を超えると、例外がスローされます。

指定可能な値: B1, B2, B3, F1, S1, S2, S3

規定値: S1

--tags

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

--unit

IoT Hub 内のユニット。

規定値: 1

グローバルパラメーター

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

編集

IoT ハブを削除します。

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

例

IoT ハブを削除します。 (自動生成)

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

省略可能のパラメーター

--ids

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

--name -n

IoT Hub 名。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--resource-group -g

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

--subscription

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

グローバルパラメーター

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

指定可能な値: key, login

規定値: key

--hub-name -n

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

--login -l

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

指定可能な値: key, login

規定値: key

--hub-name -n

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

--login -l

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

編集

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

az iot hub list [--resource-group]

例

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

az iot hub list

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

az iot hub list --resource-group MyGroup

省略可能のパラメーター

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

編集

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

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

例

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

az iot hub list-skus --name MyIoTHub

省略可能のパラメーター

--ids

--name -n

IoT Hub 名。

--resource-group -g

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

--subscription

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

グローバルパラメーター

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

省略可能のパラメーター

--ids

--name -n

IoT Hub 名。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--resource-group -g

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

--subscription

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

グローバルパラメーター

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

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

指定可能な値: key, login

規定値: key

--device-id -d

ターゲットデバイス ID。

--hub-name -n

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

--login -l

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

指定可能な値: key, login

規定値: key

--hub-name -n

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

--login -l

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

az iot hub show

編集

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

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

例

IoT ハブの詳細を取得します。 (自動生成)

az iot hub show --name MyIoTHub

省略可能のパラメーター

--ids

--name -n

IoT Hub 名。

--resource-group -g

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

--subscription

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

グローバルパラメーター

--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 show-connection-string

編集

非推奨

このコマンドは非推奨となり、今後のリリースで削除される予定です。代わりに'IoT Extension (azure-iot) 接続文字列コマンド (az iot hub connection-string show)' を使用してください。

IoT ハブの接続文字列を表示します。

az iot hub show-connection-string [--all]
                                  [--hub-name]
                                  [--ids]
                                  [--key {primary, secondary}]
                                  [--policy-name]
                                  [--resource-group]
                                  [--subscription]

例

既定のポリシーと主キーを使用して、IoT ハブの接続文字列を表示します。

az iot hub show-connection-string --name MyIotHub

ポリシー 'service' とセカンダリキーを使用して、IoT Hub の接続文字列を表示します。

az iot hub show-connection-string --name MyIotHub --policy-name service --key secondary

リソースグループ内のすべての IoT ハブの接続文字列を表示します。

az iot hub show-connection-string --resource-group MyResourceGroup

サブスクリプション内のすべての IoT ハブの接続文字列を表示します。

az iot hub show-connection-string

IoT ハブの接続文字列を表示します。 (自動生成)

az iot hub show-connection-string --key primary --policy-name MyPolicy

省略可能のパラメーター

--all

すべての共有アクセスポリシーの表示を許可します。

規定値: False

--hub-name --name -n

IoT Hub 名。

--ids

--key

使用するキー。

指定可能な値: primary, secondary

規定値: primary

--policy-name

使用する共有アクセスポリシー。

規定値: iothubowner

--resource-group -g

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

--subscription

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

グローバルパラメーター

--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 show-quota-metrics

編集

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

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

例

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

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

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

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

省略可能のパラメーター

--ids

--name -n

IoT Hub 名。

--resource-group -g

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

--subscription

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

グローバルパラメーター

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

編集

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

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

例

IoT ハブの統計情報を取得します。 (自動生成)

az iot hub show-stats --name MyIoTHub

省略可能のパラメーター

--ids

--name -n

IoT Hub 名。

--resource-group -g

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

--subscription

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

グローバルパラメーター

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

編集

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

az iot hub update [--add]
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--dds {false, true}]
                  [--disable-local-auth {false, true}]
                  [--disable-module-sas {false, true}]
                  [--fc]
                  [--fcs]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-lock-duration]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type {identityBased, keyBased}]
                  [--fileupload-storage-identity]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--rd]
                  [--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 ハブのメタデータを更新します。 (自動生成)

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

省略可能のパラメーター

--add

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

規定値: []

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

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

--force-string

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

規定値: False

--ids

--name -n

IoT Hub 名。

--rd --retention-day

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

--remove

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

規定値: []

--resource-group -g

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

--set

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

規定値: []

--sku

指定可能な値: B1, B2, B3, F1, S1, S2, S3

--subscription

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

--tags

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

--unit

IoT Hub 内のユニット。

グローバルパラメーター

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

省略可能のパラメーター

--created

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

規定値: False

--custom

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

--deleted

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

規定値: False

--exists

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

規定値: False

--ids

--interval

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

規定値: 30

--name -n

IoT Hub 名。

--resource-group -g

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

--subscription

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

--timeout

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

規定値: 3600

--updated

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

規定値: 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

コマンド

az iot hub create

例

必須のパラメーター

省略可能のパラメーター

az iot hub delete

例

省略可能のパラメーター

az iot hub generate-sas-token

例

省略可能のパラメーター

az iot hub invoke-device-method

例

必須のパラメーター

省略可能のパラメーター

az iot hub invoke-module-method

例

必須のパラメーター

省略可能のパラメーター

az iot hub list

例

省略可能のパラメーター

az iot hub list-skus

例

省略可能のパラメーター

az iot hub manual-failover

例

省略可能のパラメーター

az iot hub monitor-events

例

省略可能のパラメーター

az iot hub monitor-feedback

例

省略可能のパラメーター

az iot hub query

例

必須のパラメーター

省略可能のパラメーター

az iot hub show

例

省略可能のパラメーター

az iot hub show-connection-string

例

省略可能のパラメーター

az iot hub show-quota-metrics

例

省略可能のパラメーター

az iot hub show-stats

例

省略可能のパラメーター

az iot hub update

例

省略可能のパラメーター

az iot hub wait

例

省略可能のパラメーター

その他のリソース