az iot hub message-endpoint

プレビュー
リファレンス

Note

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

このコマンドグループはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

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

必須のパラメーター

--hub-name -n

IoT Hub 名。

省略可能のパラメーター

--en --endpoint --endpoint-name

ルーティングエンドポイントの名前。

--endpoint-type --type -t

ルーティングエンドポイントの種類。

指定可能な値: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container

--force -f

エンドポイントと、関連付けられているルートとメッセージエンリッチメントを強制的に削除します。

規定値: False

--resource-group -g

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

--yes -y

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

指定可能な値: false, true

グローバルパラメーター

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

必須のパラメーター

--hub-name -n

IoT Hub 名。

省略可能のパラメーター

--endpoint-type --type -t

ルーティングエンドポイントの種類。

指定可能な値: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container

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

必須のパラメーター

--en --endpoint --endpoint-name

ルーティングエンドポイントの名前。

--hub-name -n

IoT Hub 名。

省略可能のパラメーター

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

コマンド

az iot hub message-endpoint delete

例

必須のパラメーター

省略可能のパラメーター

az iot hub message-endpoint list

例

必須のパラメーター

省略可能のパラメーター

az iot hub message-endpoint show

例

必須のパラメーター

省略可能のパラメーター

その他のリソース