Update-AzIotHubDeviceTwin

模組:
Az.IotHub Module

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

語法

ResourceSet (預設值) 

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

InputObjectSet 

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

ResourceIdSet 

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
預設值: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

-Desired

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

參數屬性

類型:Hashtable
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DeviceId

目標裝置標識碼。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:1
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-InputObject

IotHub 物件

參數屬性

類型:PSIotHub
預設值:None
支援萬用字元:False
不要顯示:False

參數集

InputObjectSet
Position:0
必要:True
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-IotHubName

IoT 中樞的名稱

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ResourceSet
Position:1
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Partial

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ResourceGroupName

資源群組的名稱

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ResourceSet
Position:0
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ResourceId

IotHub 資源識別碼

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ResourceIdSet
Position:0
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Tag

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

參數屬性

類型:Hashtable
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值: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

輸出

String