az iot hub route

このコマンド グループは非推奨となり、今後のリリースで削除される予定です。 代わりに、'IoT Extension (azure-iot) message-route コマンド グループ (az iot hub message-route)' を使用してください。

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

コマンド

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

非推奨

コマンド グループ 'iot hub route' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。 代わりに、'IoT Extension (azure-iot) message-route コマンド グループ (az iot hub message-route)' を使用してください。

IoT Hub でルートを作成します。

特定のデータ ソースと条件を目的のエンドポイントに送信するルートを作成します。

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

例

新しいルート "R1" を作成します。

az iot hub route create -g MyResourceGroup --hub-name MyIotHub --endpoint-name E2 --source DeviceMessages --route-name R1

すべてのパラメーターを含む新しいルート "R1" を作成します。

az iot hub route create -g MyResourceGroup --hub-name MyIotHub --endpoint-name E2 --source DeviceMessages --route-name R1 --condition true --enabled true

必須のパラメーター

--en --endpoint --endpoint-name

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

--hub-name

IoT Hub 名。

--name --route-name -n

ルートの名前。

--source --source-type --type -s

ルートのソース。

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

省略可能のパラメーター

--condition -c

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

--enabled -e

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

承認された値: false, 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 route delete

非推奨

コマンド グループ 'iot hub route' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。 代わりに、'IoT Extension (azure-iot) message-route コマンド グループ (az iot hub message-route)' を使用してください。

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

IoT Hub のルートまたはすべてのルートを削除します。

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

例

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

az iot hub route delete -g MyResourceGroup --hub-name MyIotHub --route-name R1

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

az iot hub route delete -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages

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

az iot hub route delete -g MyResourceGroup --hub-name MyIotHub

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name --route-name -n

ルートの名前。

--resource-group -g

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

--source --source-type --type -s

ルートのソース。

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

--subscription

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

グローバル パラメーター

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

非推奨

コマンド グループ 'iot hub route' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。 代わりに、'IoT Extension (azure-iot) message-route コマンド グループ (az iot hub message-route)' を使用してください。

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

IoT Hub からすべてのルートに関する情報を取得します。

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

例

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

az iot hub route list -g MyResourceGroup --hub-name MyIotHub

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

az iot hub route list -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

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

--source --source-type --type -s

ルートのソース。

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

--subscription

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

グローバル パラメーター

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

非推奨

コマンド グループ 'iot hub route' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。 代わりに、'IoT Extension (azure-iot) message-route コマンド グループ (az iot hub message-route)' を使用してください。

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

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

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

例

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

az iot hub route show -g MyResourceGroup --hub-name MyIotHub --route-name {routeName}

必須のパラメーター

--name --route-name -n

ルートの名前。

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

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

--subscription

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

グローバル パラメーター

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

非推奨

コマンド グループ 'iot hub route' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。 代わりに、'IoT Extension (azure-iot) message-route コマンド グループ (az iot hub message-route)' を使用してください。

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

IoT Hub 内のすべての既存のルートまたはメンションルートをテストします。 ルートをテストするためのサンプル メッセージを提供できます。

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

例

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

az iot hub route test -g MyResourceGroup --hub-name MyIotHub --route-name R1

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

az iot hub route test -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages

省略可能のパラメーター

--ap --app-properties

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

--body -b

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

--hub-name

IoT Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name --route-name -n

ルートの名前。

--resource-group -g

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

--source --source-type --type -s

ルートのソース。

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

--sp --system-properties

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

--subscription

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

グローバル パラメーター

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

非推奨

コマンド グループ 'iot hub route' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。 代わりに、'IoT Extension (azure-iot) message-route コマンド グループ (az iot hub message-route)' を使用してください。

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

IoT Hub でルートを更新します。 ルートのソース、エンドポイント、またはクエリを変更できます。

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

例

"MyIotHub" IoT Hub からルート "R1" のソースの種類を更新します。

az iot hub route update -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages --route-name R1

必須のパラメーター

--name --route-name -n

ルートの名前。

省略可能のパラメーター

--condition -c

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

--en --endpoint --endpoint-name

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

--enabled -e

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

承認された値: false, true

--hub-name

IoT Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

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

--source --source-type --type -s

ルートのソース。

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

--subscription

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

グローバル パラメーター

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