Update-AzIotHubDeviceTwin

參考

模組:: Az.IotHub

更新裝置對應項的標記和所需屬性。

Syntax

Update-AzIotHubDeviceTwin
      [-ResourceGroupName] <String>
      [-IotHubName] <String>
      [-DeviceId] <String>
      [-Tag <Hashtable>]
      [-Desired <Hashtable>]
      [-Partial]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzIotHubDeviceTwin
      [-InputObject] <PSIotHub>
      [-DeviceId] <String>
      [-Tag <Hashtable>]
      [-Desired <Hashtable>]
      [-Partial]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzIotHubDeviceTwin
      [-ResourceId] <String>
      [-DeviceId] <String>
      [-Tag <Hashtable>]
      [-Desired <Hashtable>]
      [-Partial]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

更新或取代裝置對應項。如需相關資訊，請參閱 https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins 。

範例

範例 1

Update-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Tag $updatedTag -Desired $updatedDesired -Partial

傳回更新的裝置對應項物件。

範例 2

Update-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Desired $updatedDesired -Partial

傳回具有更新所需屬性的裝置對應項物件。

範例 3

Update-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Tag $updatedTag -Partial

傳回具有更新標籤屬性的裝置對應項物件。

範例 4

$updatedTag = @{}
$updatedTag.add("key0","value0")
$updatedDesired =@{}
$updatedDesired.add("desiredkey","desiredvalue")
Update-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Tag $updatedTag -Desired $updatedDesired

傳回已取代的裝置對應項物件。

參數

-Confirm

執行 Cmdlet 之前先提示您確認。

類型:	SwitchParameter
Aliases:	cf
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

類型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Desired

在裝置對應項中新增或更新所需的屬性。

類型:	Hashtable
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeviceId

目標裝置標識碼。

類型:	String
Position:	1
預設值:	None
必要:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

IotHub 物件

類型:	PSIotHub
Position:	0
預設值:	None
必要:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-IotHubName

IoT 中樞的名稱

類型:	String
Position:	1
預設值:	None
必要:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Partial

只允許部分更新裝置對應項的標記和所需屬性。

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

資源群組的名稱

類型:	String
Position:	0
預設值:	None
必要:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

IotHub 資源標識碼

類型:	String
Position:	0
預設值:	None
必要:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Tag

在裝置對應項中新增或更新 tags 屬性。

類型:	Hashtable
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。未執行 Cmdlet。

類型:	SwitchParameter
Aliases:	wi
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

輸入

PSIotHub

String

輸出