az iot hub message-route

コマンド

名前	説明	型	状態
az iot hub message-route create	IoT Hubのルートを追加します。	Extension	Preview
az iot hub message-route delete	IoT Hub内のすべてのルートまたは前述のルートを削除します。	Extension	Preview
az iot hub message-route fallback	IoT ハブのフォールバック ルートを管理します。	Extension	Preview
az iot hub message-route fallback set	IoT Hubでフォールバック ルートを有効または無効にします。	Extension	Preview
az iot hub message-route fallback show	IoT Hubのフォールバック ルートを表示します。	Extension	Preview
az iot hub message-route list	IoT Hub内のすべてのルートを取得します。	Extension	Preview
az iot hub message-route show	IoT Hub内のルートに関する情報を取得します。	Extension	Preview
az iot hub message-route test	IoT Hub内のすべてのルートまたは前述のルートをテストします。	Extension	Preview
az iot hub message-route update	IoT Hubのルートを更新します。	Extension	Preview

az iot hub message-route create --en --endpoint --endpoint-name
                                --hub-name
                                --rn --route --route-name
                                --source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}
                                [--acquire-policy-token]
                                [--change-reference]
                                [--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

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub message-route delete [--acquire-policy-token]
                                [--change-reference]
                                [--hub-name]
                                [--ids]
                                [--resource-group]
                                [--rn --route --route-name]
                                [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--subscription]
                                [--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}

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

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

例

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

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

例

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

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

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub message-route test [--acquire-policy-token]
                              [--ap --app-properties]
                              [--body]
                              [--change-reference]
                              [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--rn --route --route-name]
                              [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--sp --system-properties]
                              [--subscription]

例

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}

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot hub message-route update --rn --route --route-name
                                [--acquire-policy-token]
                                [--change-reference]
                                [--condition]
                                [--en --endpoint --endpoint-name]
                                [--enabled {false, true}]
                                [--hub-name]
                                [--ids]
                                [--resource-group]
                                [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--subscription]

例

特定のエンドポイントとソースの種類 "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}

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False