Update-AzIotHubDeviceTwin
Met à jour les balises et les propriétés souhaitées d’un jumeau d’appareil.
Syntaxe
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
Met à jour ou remplace un jumeau d’appareil. Pour plus d’informations, consultez https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.
Exemples
Exemple 1
Update-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Tag $updatedTag -Desired $updatedDesired -Partial
Retourne l’objet jumeau d’appareil mis à jour.
Exemple 2
Update-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Desired $updatedDesired -Partial
Retourne l’objet jumeau d’appareil avec les propriétés souhaitées mises à jour.
Exemple 3
Update-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Tag $updatedTag -Partial
Retourne l’objet jumeau d’appareil avec la propriété tags mise à jour.
Exemple 4
$updatedTag = @{}
$updatedTag.add("key0","value0")
$updatedDesired =@{}
$updatedDesired.add("desiredkey","desiredvalue")
Update-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Tag $updatedTag -Desired $updatedDesired
Retourne l’objet jumeau d’appareil remplacé.
Paramètres
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
Type: | SwitchParameter |
Alias: | cf |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
Type: | IAzureContextContainer |
Alias: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Desired
Ajoutez ou mettez à jour la propriété souhaitée dans un jumeau d’appareil.
Type: | Hashtable |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-DeviceId
ID d’appareil cible.
Type: | String |
Position: | 1 |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-InputObject
Objet IotHub
Type: | PSIotHub |
Position: | 0 |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-IotHubName
Nom du hub Iot
Type: | String |
Position: | 1 |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Partial
Permet uniquement de mettre à jour partiellement les balises et les propriétés souhaitées d’un jumeau d’appareil.
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ResourceGroupName
Nom du groupe de ressources
Type: | String |
Position: | 0 |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ResourceId
ID de ressource IotHub
Type: | String |
Position: | 0 |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Tag
Ajoutez ou mettez à jour la propriété tags dans un jumeau d’appareil.
Type: | Hashtable |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.
Type: | SwitchParameter |
Alias: | wi |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |