Update-AzIotHubDeviceTwin
Обновляет теги и требуемые свойства двойника устройства.
Синтаксис
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>]
Описание
Обновляет или заменяет двойник устройства. Дополнительные сведения см. в 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
Запрашивает подтверждение перед запуском командлета.
Тип: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DefaultProfile
Учетные данные, учетная запись, клиент и подписка, используемые для взаимодействия с Azure.
Тип: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Desired
Добавьте или обновите требуемое свойство в двойнике устройства.
Тип: | Hashtable |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DeviceId
Идентификатор целевого устройства.
Тип: | String |
Position: | 1 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-InputObject
Объект IotHub
Тип: | PSIotHub |
Position: | 0 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-IotHubName
Имя Центра Iot
Тип: | String |
Position: | 1 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Partial
Позволяет только частично обновлять теги и требуемые свойства двойника устройства.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ResourceGroupName
Имя группы ресурсов
Тип: | String |
Position: | 0 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ResourceId
Идентификатор ресурса IotHub
Тип: | String |
Position: | 0 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Tag
Добавьте или обновите свойство тегов в двойнике устройства.
Тип: | Hashtable |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-WhatIf
Показывает, что произойдет, если командлет выполняется. Командлет не выполняется.
Тип: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
Входные данные
Выходные данные
Azure PowerShell