az iot hub message-enrichment

  • リファレンス

IoT Hub のエンドポイントのメッセージ エンリッチメントを管理します。

コマンド

名前 説明 型 状態
az iot hub message-enrichment create

IoT Hub で選択したエンドポイントのメッセージ エンリッチメントを作成します。

 コア GA
az iot hub message-enrichment delete

IoT ハブのメッセージ エンリッチメントを (キー別に) 削除します。

 コア GA
az iot hub message-enrichment list

IoT Hub のすべてのメッセージ エンリッチメントに関する情報を取得します。

 コア GA
az iot hub message-enrichment update

(キー別に) IoT ハブのメッセージ エンリッチメントを更新します。

 コア GA

az iot hub message-enrichment create

編集

IoT Hub で選択したエンドポイントのメッセージ エンリッチメントを作成します。

az iot hub message-enrichment create --endpoints
                                     --key
                                     --name
                                     --value
                                     [--resource-group]

例

IoT Hub の "イベント" エンドポイントに対して {"key":"value"} のメッセージ エンリッチメントを作成する

az iot hub message-enrichment create --key key --value value --endpoints events -n {iothub_name}

必須のパラメーター

--endpoints -e

エンリッチメントを適用するエンドポイント。 複数のエンドポイントにスペース区切りリストを使用します。

--key -k

エンリッチメントのキー。

--name -n

IoT Hub 名。

--value -v

エンリッチメントの値。

省略可能のパラメーター

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

編集

IoT ハブのメッセージ エンリッチメントを (キー別に) 削除します。

az iot hub message-enrichment delete --key
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

例

キー 'test' を含むメッセージ エンリッチメントを IoT Hub から削除する

az iot hub message-enrichment delete --key test -n {iothub_name}

必須のパラメーター

--key -k

エンリッチメントのキー。

省略可能のパラメーター

--ids

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

--name -n

IoT Hub 名。

--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 message-enrichment list

編集

IoT Hub のすべてのメッセージ エンリッチメントに関する情報を取得します。

az iot hub message-enrichment list [--ids]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

例

IoT Hub のすべてのメッセージ エンリッチメントを一覧表示する

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

省略可能のパラメーター

--ids

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

--name -n

IoT Hub 名。

--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 message-enrichment update

編集

(キー別に) IoT ハブのメッセージ エンリッチメントを更新します。

az iot hub message-enrichment update --endpoints
                                     --key
                                     --value
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

例

IoT ハブのメッセージ エンリッチメントを更新して、新しいエンドポイント のセットに適用する

az iot hub message-enrichment update --key {key} --value {value} --endpoints NewEndpoint1 NewEndpoint2 -n {iothub_name}

必須のパラメーター

--endpoints -e

エンリッチメントを適用するエンドポイント。 複数のエンドポイントにスペース区切りリストを使用します。

--key -k

エンリッチメントのキー。

--value -v

エンリッチメントの値。

省略可能のパラメーター

--ids

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

--name -n

IoT Hub 名。

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