Add-AzIotHubMessageEnrichment

リファレンス

モジュール:: Az.IotHub

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

構文

Add-AzIotHubMessageEnrichment
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-Key] <String>
   -Value <String>
   -Endpoint <String[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-AzIotHubMessageEnrichment
   [-InputObject] <PSIotHub>
   [-Key] <String>
   -Value <String>
   -Endpoint <String[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-AzIotHubMessageEnrichment
   [-ResourceId] <String>
   [-Key] <String>
   -Value <String>
   -Endpoint <String[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

IoT Hub ごとに最大 10 個のメッセージエンリッチメントを追加します。これらは、選択したエンドポイントに送信されるメッセージにアプリケーションプロパティとして追加されます。詳細については、次を参照してください。 https://learn.microsoft.com/azure/iot-hub/iot-hub-message-enrichments-overview

例

例 1

Add-AzIotHubMessageEnrichment -ResourceGroupName "myresourcegroup" -Name "myiothub" -Key "newKey" -Value "newValue" -Endpoint endpoint1,endpoint2

Key          : newKey
Value        : newValue
Endpoint(s)  : { endpoint1, endpoint2 }

キー "newKey" と値 "newValue" を使用して新しいエンリッチメントを追加します。この新しいエンリッチメントは、"endpoint1" エンドポイントと "endpoint2" エンドポイントに適用されます。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Endpoint

エンリッチメントを適用するエンドポイント。

型:	String[]
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

IotHub オブジェクト

型:	PSIotHub
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Key

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

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Name

IoT ハブの名前

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソースグループの名前

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceId

IotHub リソース ID

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Value

エンリッチメントの値。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSIotHub

String

出力

PSEnrichmentMetadata

次の方法で共有