az iot hub message-route

Note

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

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

IoT ハブのルートを管理します。

コマンド

名前	説明	型	Status
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 message-route create

プレビュー

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

IoT Hub のルートを追加します。

az iot hub message-route create --en
                                --hub-name
                                --rn
                                --source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}
                                [--condition]
                                [--enabled {false, true}]
                                [--resource-group]

例

指定されたエンドポイントとソースの種類が "DeviceMessages" の IoT Hub のルートを作成します。

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

組み込みのエンドポイントとソースの種類が "DeviceMessages" の IoT Hub のルートを作成します。

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name events --source DeviceMessages

指定されたエンドポイント、ソースの種類 "DigitalTwinChangeEvents"、およびカスタム条件を使用して、IoT Hub の無効なルートを作成します。

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DigitalTwinChangeEvents --condition {condition} --enabled false

必須のパラメーター

--en --endpoint --endpoint-name

ルーティング エンドポイントの名前。 組み込みエンドポイントの場合は、エンドポイント名 'events' を使用します。

--hub-name -n

IoT Hub 名。

--rn --route --route-name

ルートの名前。

--source-type --type -t

ルートのソース。

承認された値: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

省略可能のパラメーター

--condition -c

ルーティング規則を適用するために評価される条件。

既定値: true

--enabled -e

IoT Hub へのルートを有効にするかどうかを示すブール値。

承認された値: false, true

既定値: True

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

プレビュー

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

IoT Hub 内のすべてのルートまたはメンションルートを削除します。

az iot hub message-route delete --hub-name
                                [--resource-group]
                                [--rn]
                                [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--yes {false, true}]

例

IoT Hub からルートを削除します。

az iot hub message-route delete -n {iothub_name} --route-name {route_name}

ソースの種類 "DeviceMessages" のすべてのルートを IoT Hub から削除します。

az iot hub message-route delete -n {iothub_name} --source DeviceMessages

IoT Hub からすべてのルートを削除します。

az iot hub message-route delete -n {iothub_name}

必須のパラメーター

--hub-name -n

IoT Hub 名。

省略可能のパラメーター

--resource-group -g

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

--rn --route --route-name

ルートの名前。

--source-type --type -t

ルートのソース。

承認された値: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

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

プレビュー

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

IoT Hub 内のすべてのルートを取得します。

az iot hub message-route list --hub-name
                              [--resource-group]
                              [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]

例

IoT Hub からすべてのルートを取得します。

az iot hub message-route list -n {iothub_name}

IoT Hub からソースの種類 "DeviceMessages" のすべてのルートを取得します。

az iot hub message-route list -n {iothub_name} --source DeviceMessages

必須のパラメーター

--hub-name -n

IoT Hub 名。

省略可能のパラメーター

--resource-group -g

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

--source-type --type -t

ルートのソース。

承認された値: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

グローバル パラメーター

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

プレビュー

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

IoT Hub 内のルートに関する情報を取得します。

az iot hub message-route show --hub-name
                              --rn
                              [--resource-group]

例

IoT Hub からルート情報を取得します。

az iot hub message-route show -n {iothub_name} --route-name {route_name}

必須のパラメーター

--hub-name -n

IoT Hub 名。

--rn --route --route-name

ルートの名前。

省略可能のパラメーター

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

プレビュー

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

IoT Hub 内のすべてのルートまたはメンションルートをテストします。

ルートをテストするためのサンプル メッセージを提供できます。

az iot hub message-route test --hub-name
                              [--ap]
                              [--body]
                              [--resource-group]
                              [--rn]
                              [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--sp]

例

IoT Hub からのルートをテストします。

az iot hub message-route test -n {iothub_name} --route-name {route_name}

IoT Hub からソースの種類 "DeviceMessages" のすべてのルートをテストします。

az iot hub message-route test -n {iothub_name} --source DeviceMessages

本文、アプリのプロパティ、システム プロパティなど、カスタム メッセージを使用して IoT Hub からのすべてのルートをテストします。

az iot hub message-route test -n {iothub_name} -b {body} --ap {app_properties} --sp {system_properties}

必須のパラメーター

--hub-name -n

IoT Hub 名。

省略可能のパラメーター

--ap --app-properties

ルート メッセージのアプリ プロパティ。

--body -b

ルート メッセージの本文。

--resource-group -g

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

--rn --route --route-name

ルートの名前。

--source-type --type -t

ルートのソース。

承認された値: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--sp --system-properties

ルート メッセージのシステム プロパティ。

グローバル パラメーター

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

プレビュー

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

IoT Hub のルートを更新します。

ルートのソース、エンドポイント、条件、または有効な状態を変更できます。

az iot hub message-route update --hub-name
                                --rn
                                [--condition]
                                [--en]
                                [--enabled {false, true}]
                                [--resource-group]
                                [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]

例

特定のエンドポイントとソースの種類 "DeviceMessages" へのルートを更新します。

az iot hub message-route update -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

ルートを無効にします。

az iot hub message-route update -n {iothub_name} --route-name {route_name} --enabled false

ルートの条件を変更します。

az iot hub message-route update -n {iothub_name} --route-name {route_name} --condition {condition}

必須のパラメーター

--hub-name -n

IoT Hub 名。

--rn --route --route-name

ルートの名前。

省略可能のパラメーター

--condition -c

ルーティング規則を適用するために評価される条件。

--en --endpoint --endpoint-name

ルーティング エンドポイントの名前。 組み込みエンドポイントの場合は、エンドポイント名 'events' を使用します。

--enabled -e

IoT Hub へのルートを有効にするかどうかを示すブール値。

承認された値: false, true

--resource-group -g

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

--source-type --type -t

ルートのソース。

承認された値: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

グローバル パラメーター

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