Add-AzIotHubMessageEnrichment
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
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Endpoint
エンリッチメントを適用するエンドポイント。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
IotHub オブジェクト
| Type: | PSIotHub |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Key
エンリッチメントのキー。
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
IoT ハブの名前
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
リソース グループの名前
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceId
IotHub リソース ID
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Value
エンリッチメントの値。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |