你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Add-AzIotHubMessageEnrichment

为 IoT 中心内所选终结点创建消息扩充。

语法

ResourceSet (默认值)

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>]

说明

每个 IoT 中心最多添加 10 个消息扩充。 这些属性作为发送到所选终结点的消息的应用程序属性添加。 若要了解详细信息,请参阅 https://free.blessedness.top/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

在运行 cmdlet 之前,提示你进行确认。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Endpoint

要向其应用扩充的终结点(s)。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-InputObject

IotHub 对象

参数属性

类型:PSIotHub
默认值:None
支持通配符:False
不显示:False

参数集

InputObjectSet
Position:0
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Key

扩充的密钥。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:1
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Name

IoT 中心的名称

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ResourceSet
Position:1
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ResourceGroupName

资源组的名称

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ResourceSet
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ResourceId

IotHub 资源 ID

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ResourceIdSet
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Value

扩充的值。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

PSIotHub

String

输出

PSEnrichmentMetadata