Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Add-AzIotHubMessageEnrichment
- Module:
- Az.IotHub Module
Creates a message enrichment for chosen endpoints in your IoT Hub.
Syntax
ResourceSet (Default)
Add-AzIotHubMessageEnrichment
[-ResourceGroupName] <String>
[-Name] <String>
[-Key] <String>
-Value <String>
-Endpoint <String[]>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObjectSet
Add-AzIotHubMessageEnrichment
[-InputObject] <PSIotHub>
[-Key] <String>
-Value <String>
-Endpoint <String[]>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceIdSet
Add-AzIotHubMessageEnrichment
[-ResourceId] <String>
[-Key] <String>
-Value <String>
-Endpoint <String[]>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Add up to 10 message enrichments per IoT Hub. These are added as application properties to messages sent to chosen endpoint(s). To know more, see https://learn.microsoft.com/azure/iot-hub/iot-hub-message-enrichments-overview
Examples
Example 1
Add-AzIotHubMessageEnrichment -ResourceGroupName "myresourcegroup" -Name "myiothub" -Key "newKey" -Value "newValue" -Endpoint endpoint1,endpoint2
Key : newKey
Value : newValue
Endpoint(s) : { endpoint1, endpoint2 }
Add a new enrichment with key "newKey" and value "newValue". This new enrichment is applied to "endpoint1" and "endpoint2" endpoints.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
-Endpoint
Endpoint(s) to apply enrichments to.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
IotHub object
Parameter properties
| Type: | PSIotHub |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Key
The enrichment's key.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Name of the Iot Hub
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
Name of the Resource Group
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceId
IotHub Resource Id
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Value
The enrichment's value.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
PSIotHub
String
Outputs
PSEnrichmentMetadata
Azure PowerShell
Feedback
Was this page helpful?