az iot hub message-endpoint
Note
このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot hub message-endpoint コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
このコマンド グループはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT ハブのカスタム エンドポイントを管理します。
コマンド
名前 | 説明 | 型 | Status |
---|---|---|---|
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-endpoint delete
コマンド グループ "iot hub message-endpoint" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT Hub のすべてまたは特定のエンドポイントを削除します。
エンドポイントを削除する前に、エンドポイントへのルートとメッセージ エンリッチメントを削除する必要があります。
az iot hub message-endpoint delete --hub-name
[--en]
[--endpoint-type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
[--force]
[--resource-group]
[--yes {false, true}]
例
IoT Hub からエンドポイントを削除します。
az iot hub message-endpoint delete -n {iothub_name} --endpoint-name {endpoint_name}
IoT Hub から "EventHub" 型のすべてのエンドポイントを削除します。
az iot hub message-endpoint delete -n {iothub_name} --endpoint-type eventhub
IoT Hub からすべてのエンドポイントを削除します。
az iot hub message-endpoint delete -n {iothub_name}
IoT Hub からエンドポイントを強制的に削除します。 これにより、このエンドポイントに関連付けられているルートとメッセージ エンリッチメントが削除されます。
az iot hub message-endpoint delete -n {iothub_name} --endpoint-name {endpoint_name} -f
IoT Hub から "EventHub" 型のすべてのエンドポイントを強制的に削除します。 これにより、このエンドポイントに関連付けられているルートとメッセージ エンリッチメントが削除されます。
az iot hub message-endpoint delete -n {iothub_name} --endpoint-type eventhub -f
必須のパラメーター
IoT Hub 名。
省略可能のパラメーター
ルーティング エンドポイントの名前。
ルーティング エンドポイントの種類。
エンドポイントと、関連付けられているルートとメッセージ エンリッチメントを強制的に削除します。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
ユーザー プロンプトをスキップします。 アクションの受け入れを示します。 主に自動化シナリオに使用されます。 既定値は false です。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub message-endpoint list
コマンド グループ "iot hub message-endpoint" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT Hub のすべてのエンドポイントに関する情報を取得します。
情報を取得するエンドポイントの種類を指定することもできます。
az iot hub message-endpoint list --hub-name
[--endpoint-type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
[--resource-group]
例
IoT Hub からすべてのエンドポイントを取得します。
az iot hub message-endpoint list -n {iothub_name}
IoT Hub から "EventHub" 型のすべてのエンドポイントを取得します。
az iot hub message-endpoint list -n {iothub_name} --endpoint-type eventhub
必須のパラメーター
IoT Hub 名。
省略可能のパラメーター
ルーティング エンドポイントの種類。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub message-endpoint show
コマンド グループ "iot hub message-endpoint" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT Hub の前述のエンドポイントに関する情報を取得します。
az iot hub message-endpoint show --en
--hub-name
[--resource-group]
例
IoT Hub からエンドポイント情報を取得します。
az iot hub message-endpoint show -n {iothub_name} --endpoint-name {endpoint_name}
必須のパラメーター
ルーティング エンドポイントの名前。
IoT Hub 名。
省略可能のパラメーター
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI