az iot hub
Note
このコマンド グループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。 各拡張機能をインストールして、拡張機能を活用します。 拡張機能の詳細をご覧ください。
Azure IoT Hub を管理します。
コマンド
名前 | 説明 | 型 | Status |
---|---|---|---|
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
必須のパラメーター
IoT Hub 名。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
IoT ハブがクラウドからデバイスへのメッセージのデバイスへの配信を試行する回数 (1 ~ 100)。
IoT Hub によって期限切れになるまでにデバイスがメッセージを使用できる時間 (1 ~ 48 時間)。
認証のためにすべてのデバイス (Edge デバイスを含むが、モジュールを除く) スコープ SAS キーを無効にするかどうかを示すブール値。
認証のために IoT ハブ スコープの SAS キーを無効にするかどうかを示すブール値。
モジュール スコープの SAS キーを認証用に無効にするかどうかを示すブール値。
リージョン間のディザスター リカバリーを無効にして、この IoT Hub のデータ所在地を強制します。 このプロパティは、リソースに設定されると変更できません。 一部のリージョンでのみ使用できます。 詳細については、https://aka.ms/iothubdisabledr をご覧ください。
ファイルをアップロードするルート コンテナーの名前。 コンテナーは存在する必要はありませんが、指定された connectionString を使用して作成できる必要があります。
ファイルのアップロード先となる Azure Storage アカウントの接続文字列。
IoT ハブがフィードバック キューにメッセージを配信しようとした回数 (1 ~ 100)。
フィードバック キューのロック期間 (5 ~ 300 秒)。
IoT ハブが 1 時間から 48 時間の間、クラウドからデバイスへのメッセージの有効期限または配信に関するフィードバックをメインする期間。
ファイル アップロード通知キューのロック期間 (5 ~ 300 秒)。
IoT ハブがファイル通知メッセージの配信を試行する回数 (1 ~ 100)。
IoT Hub によって有効期限が切れるまでの 1 時間から 48 時間の間に、サービスが使用できるファイル アップロード通知の時間。
アップロードされたファイルに関する情報をメッセージ/servicebound/filenotifications IoT Hub エンドポイントにログに記録するかどうかを示すブール値。
IoT Hub によって生成された SAS URI が有効期限が切れるまでの有効期間 (1 ~ 24 時間)。
ファイルのアップロード先となる Azure Storage アカウントの認証の種類。
ファイル アップロード認証に使用するマネージド ID。 '[system]' を使用して、システム割り当てマネージド ID またはリソース ID を参照して、ユーザー割り当てマネージド ID を参照します。
IoT Hub の場所。 既定値は、ターゲット リソース グループの場所です。
このハブのシステム割り当てマネージド ID を有効にします。
このハブのユーザー割り当てマネージド ID を有効にします。 ID リソース ID のスペース区切りの一覧を受け入れます。
このハブをサポートする最小 TLS バージョンを指定します。 1.2 より前の TLS バージョンを使用するクライアントを拒否するには、"1.2" に設定できます。
実行時間の長い操作の終了を待機しません。
デバイスからクラウドへのメッセージのバッキング イベント ハブのパーティションの数。
この IoT ハブメインデバイスからクラウドへのイベントを保持する期間 (1 日から 7 日間) を指定します。
ハブのシステム割り当てマネージド ID に割り当てるロール。
システム割り当てマネージド ID のロール (--role) を割り当てるスコープのスペース区切りリスト。
Azure IoT Hub の価格レベル。 各サブスクリプションで使用できる無料の IoT ハブ インスタンス (F1) は 1 つだけであることに注意してください。 空きインスタンスが 1 を超えると、例外がスローされます。
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
IoT Hub 内のユニット。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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
省略可能のパラメーター
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
IoT Hub 名。
実行時間の長い操作の終了を待機しません。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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'
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
ターゲット 接続文字列。 これにより、IoT Hub レジストリがバイパスされ、追加の検証なしで、指定された対称キーから直接 SAS トークンが生成されます。 期間以外の他のすべてのコマンド パラメーターは無視されます。 サポートされている接続文字列の種類: IoT Hub、デバイス、モジュール。
ターゲット デバイス ID。
有効なトークン期間 (秒単位)。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
認証用の共有アクセス ポリシー キーの種類。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
ターゲット モジュール ID。
ターゲット IoT Hub エンティティの操作アクセス許可を持つ共有アクセス ポリシー。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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"}'
必須のパラメーター
ターゲット デバイス ID。
呼び出しのターゲット メソッド。
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
メソッドに渡される Json ペイロード。 ファイル パスまたは生の json である必要があります。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
デバイス メソッドの結果を待機する最大秒数。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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"}'
必須のパラメーター
ターゲット デバイス ID。
呼び出しのターゲット メソッド。
ターゲット モジュール ID。
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
メソッドに渡される Json ペイロード。 ファイル パスまたは生の json である必要があります。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
モジュール メソッドの結果を待機する最大秒数。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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
省略可能のパラメーター
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub list-skus
使用可能な価格レベルを一覧表示します。
az iot hub list-skus [--ids]
[--name]
[--resource-group]
[--subscription]
例
使用可能な価格レベルを一覧表示します。 (自動生成)
az iot hub list-skus --name MyIoTHub
省略可能のパラメーター
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
IoT Hub 名。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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
省略可能のパラメーター
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
IoT Hub 名。
実行時間の長い操作の終了を待機しません。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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}
省略可能のパラメーター
イベント ハブ エンドポイントに接続するときに使用するコンシューマー グループを指定します。
メッセージ ペイロードの Content-Type を指定して、その種類の出力を自動的に書式設定します。
ターゲット デバイス ID。
デバイスをフィルター処理するカスタム クエリを指定します。
パーティションからメッセージを読み取る開始点として使用する必要がある時間を示します。 単位は unix エポック以降のミリ秒です。 時刻が "now" と示されていない場合は使用されます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
フィルター処理するターゲット インターフェイス識別子。 例: dtmi:com:example:TemperatureController;1。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
モニターが終了する前にキャプチャするテレメトリ メッセージの数。 指定しない場合、モニターは、ハブからメッセージを受信しないというタイムアウトしきい値を満たすまで実行を続けます。
ターゲット モジュール ID。
出力するキー メッセージのプロパティを指定します。 sys = システム プロパティ、app = アプリケーション プロパティ、anno = 注釈。
拡張機能のバージョンと互換性のある uamqp 依存関係を再インストールします。 既定値は false です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
メッセージを受信せずに接続メイン保持されるまでの最大秒数。 無限大には 0 を使用します。
ユーザー プロンプトをスキップします。 アクションの受け入れを示します。 主に自動化シナリオに使用されます。 既定値は false です。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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}
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
ターゲット デバイス ID。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
拡張機能のバージョンと互換性のある uamqp 依存関係を再インストールします。 既定値は false です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
フィードバック モニターは、特定の ID (uuid) のメッセージが受信されるまでブロックされます。
ユーザー プロンプトをスキップします。 アクションの受け入れを示します。 主に自動化シナリオに使用されます。 既定値は false です。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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}'"
必須のパラメーター
実行するユーザー クエリ。
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
返される要素の最大数。 既定では、クエリには上限はありません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub show
IoT ハブの詳細を取得します。
az iot hub show [--ids]
[--name]
[--resource-group]
[--subscription]
例
IoT ハブの詳細を取得します。 (自動生成)
az iot hub show --name MyIoTHub
省略可能のパラメーター
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
IoT Hub 名。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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
省略可能のパラメーター
すべての共有アクセス ポリシーの表示を許可します。
IoT Hub 名。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
使用するキー。
使用する共有アクセス ポリシー。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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
省略可能のパラメーター
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
IoT Hub 名。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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
省略可能のパラメーター
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
IoT Hub 名。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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 property.listProperty <key=value, string or JSON string>
。
IoT ハブがクラウドからデバイスへのメッセージのデバイスへの配信を試行する回数 (1 ~ 100)。
IoT Hub によって期限切れになるまでにデバイスがメッセージを使用できる時間 (1 ~ 48 時間)。
認証のためにすべてのデバイス (Edge デバイスを含むが、モジュールを除く) スコープ SAS キーを無効にするかどうかを示すブール値。
認証のために IoT ハブ スコープの SAS キーを無効にするかどうかを示すブール値。
モジュール スコープの SAS キーを認証用に無効にするかどうかを示すブール値。
ファイルをアップロードするルート コンテナーの名前。 コンテナーは存在する必要はありませんが、指定された connectionString を使用して作成できる必要があります。
ファイルのアップロード先となる Azure Storage アカウントの接続文字列。
IoT ハブがフィードバック キューにメッセージを配信しようとした回数 (1 ~ 100)。
フィードバック キューのロック期間 (5 ~ 300 秒)。
IoT ハブが 1 時間から 48 時間の間、クラウドからデバイスへのメッセージの有効期限または配信に関するフィードバックをメインする期間。
ファイル アップロード通知キューのロック期間 (5 ~ 300 秒)。
IoT ハブがファイル通知メッセージの配信を試行する回数 (1 ~ 100)。
IoT Hub によって有効期限が切れるまでの 1 時間から 48 時間の間に、サービスが使用できるファイル アップロード通知の時間。
アップロードされたファイルに関する情報をメッセージ/servicebound/filenotifications IoT Hub エンドポイントにログに記録するかどうかを示すブール値。
IoT Hub によって生成された SAS URI が有効期限が切れるまでの有効期間 (1 ~ 24 時間)。
ファイルのアップロード先となる Azure Storage アカウントの認証の種類。
ファイル アップロード認証に使用するマネージド ID。 '[system]' を使用して、システム割り当てマネージド ID またはリソース ID を参照して、ユーザー割り当てマネージド ID を参照します。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
IoT Hub 名。
この IoT ハブメインデバイスからクラウドへのイベントを保持する期間 (1 日から 7 日間) を指定します。
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
Azure IoT Hub の価格レベル。 各サブスクリプションで使用できる無料の IoT ハブ インスタンス (F1) は 1 つだけであることに注意してください。 空きインスタンスが 1 を超えると、例外がスローされます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
IoT Hub 内のユニット。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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'"
省略可能のパラメーター
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
削除されるまで待ちます。
リソースが存在するまで待ちます。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
ポーリング間隔 (秒単位)。
IoT Hub 名。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
最大待機時間 (秒単位)。
provisioningState が 'Succeeded' で更新されるまで待ちます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI