Modules - Update Twin
Atualizações as etiquetas e as propriedades pretendidas de um módulo duplo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obter mais informações.
PATCH https://fully-qualified-iothubname.azure-devices.net/twins/{id}/modules/{mid}?api-version=2021-04-12Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
path | True |
string |
O identificador exclusivo do dispositivo. |
|
mid
|
path | True |
string |
O identificador exclusivo do módulo. |
|
api-version
|
query | True |
string |
Versão da API. |
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| If-Match |
string |
A cadeia que representa uma ETag fraca para o dispositivo duplo, de acordo com RFC7232. Determina se a operação de atualização deve ser executada. |
Corpo do Pedido
| Name | Tipo | Description |
|---|---|---|
| authenticationType |
enum:
|
O tipo de autenticação utilizado pelo dispositivo. |
| capabilities |
O estado das capacidades ativadas no dispositivo. |
|
| cloudToDeviceMessageCount |
integer |
O número de mensagens da cloud para o dispositivo enviadas. |
| connectionState |
enum:
|
O estado de ligação do dispositivo. |
| deviceEtag |
string |
A cadeia que representa uma ETag para o dispositivo, de acordo com RFC7232. |
| deviceId |
string |
O identificador exclusivo do dispositivo no registo de identidade do Hub IoT. É uma cadeia sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos ASCII de 7 bits, e os seguintes carateres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', '', '=', '@', ';', '$', '''}. |
| deviceScope |
string |
O âmbito do dispositivo. |
| etag |
string |
A cadeia que representa uma ETag para o dispositivo duplo, de acordo com RFC7232. |
| lastActivityTime |
string |
A data e hora em que o dispositivo ligou ou recebeu ou enviou uma mensagem pela última vez. A data e hora são específicas no formato datetime ISO8601 em UTC, por exemplo, 2015-01-28T16:24:48.789Z. Este valor não é atualizado se o dispositivo utilizar o protocolo HTTP/1 para realizar operações de mensagens. |
| moduleId |
string |
O identificador exclusivo do módulo no registo de identidade do Hub IoT. É uma cadeia sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos ASCII de 7 bits, e os seguintes carateres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', '', '=', '@', ';', '$', '''}. |
| parentScopes |
string[] |
Os âmbitos dos dispositivos edge de nível superior, se aplicável. Apenas disponível para dispositivos edge. |
| properties |
As propriedades pretendidas e comunicadas do duplo. |
|
| status |
enum:
|
O estado ativado do dispositivo. Se estiver desativado, o dispositivo não consegue ligar ao serviço. |
| statusReason |
string |
O motivo do estado atual do dispositivo, se existir. |
| statusUpdateTime |
string |
A data e hora em que o estado do dispositivo foi atualizado pela última vez. |
| tags |
object |
A coleção de pares chave-valor lida e escrita pelo back-end da solução. Não estão visíveis para as aplicações do dispositivo. As chaves são codificadas com UTF-8, sensíveis a maiúsculas e minúsculas e até 1 KB de comprimento. Os carateres permitidos excluem carateres de controlo UNICODE (segmentos C0 e C1), ".", "$" e espaço. Os valores são objetos JSON, com um comprimento máximo de 4 KB. |
| version |
integer |
A versão do dispositivo duplo, incluindo etiquetas e propriedades pretendidas |
| x509Thumbprint |
O thumbprint X509 do dispositivo. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
OK. |
Definições
| Name | Description |
|---|---|
|
Device |
O estado das capacidades ativadas no dispositivo. |
| Twin |
As informações de estado de um dispositivo ou módulo. Isto é criado e eliminado implicitamente quando a identidade do módulo/dispositivo correspondente é criada ou eliminada no Hub IoT. |
|
Twin |
As propriedades pretendidas e comunicadas do duplo. A profundidade máxima do objeto é 10. |
| X509Thumbprint |
DeviceCapabilities
O estado das capacidades ativadas no dispositivo.
| Name | Tipo | Description |
|---|---|---|
| iotEdge |
boolean |
A propriedade que determina se o dispositivo é ou não um dispositivo edge. |
Twin
As informações de estado de um dispositivo ou módulo. Isto é criado e eliminado implicitamente quando a identidade do módulo/dispositivo correspondente é criada ou eliminada no Hub IoT.
| Name | Tipo | Description |
|---|---|---|
| authenticationType |
enum:
|
O tipo de autenticação utilizado pelo dispositivo. |
| capabilities |
O estado das capacidades ativadas no dispositivo. |
|
| cloudToDeviceMessageCount |
integer |
O número de mensagens da cloud para o dispositivo enviadas. |
| connectionState |
enum:
|
O estado de ligação do dispositivo. |
| deviceEtag |
string |
A cadeia que representa uma ETag para o dispositivo, de acordo com RFC7232. |
| deviceId |
string |
O identificador exclusivo do dispositivo no registo de identidade do Hub IoT. É uma cadeia sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos ASCII de 7 bits, e os seguintes carateres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', '', '=', '@', ';', '$', '''}. |
| deviceScope |
string |
O âmbito do dispositivo. |
| etag |
string |
A cadeia que representa uma ETag para o dispositivo duplo, de acordo com RFC7232. |
| lastActivityTime |
string |
A data e hora em que o dispositivo ligou ou recebeu ou enviou uma mensagem pela última vez. A data e hora são específicas no formato datetime ISO8601 em UTC, por exemplo, 2015-01-28T16:24:48.789Z. Este valor não é atualizado se o dispositivo utilizar o protocolo HTTP/1 para realizar operações de mensagens. |
| moduleId |
string |
O identificador exclusivo do módulo no registo de identidade do Hub IoT. É uma cadeia sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos ASCII de 7 bits, e os seguintes carateres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', '', '=', '@', ';', '$', '''}. |
| parentScopes |
string[] |
Os âmbitos dos dispositivos edge de nível superior, se aplicável. Apenas disponível para dispositivos edge. |
| properties |
As propriedades pretendidas e comunicadas do duplo. |
|
| status |
enum:
|
O estado ativado do dispositivo. Se estiver desativado, o dispositivo não consegue ligar ao serviço. |
| statusReason |
string |
O motivo do estado atual do dispositivo, se existir. |
| statusUpdateTime |
string |
A data e hora em que o estado do dispositivo foi atualizado pela última vez. |
| tags |
object |
A coleção de pares chave-valor lida e escrita pelo back-end da solução. Não estão visíveis para as aplicações do dispositivo. As chaves são codificadas com UTF-8, sensíveis a maiúsculas e minúsculas e até 1 KB de comprimento. Os carateres permitidos excluem carateres de controlo UNICODE (segmentos C0 e C1), ".", "$" e espaço. Os valores são objetos JSON, com um comprimento máximo de 4 KB. |
| version |
integer |
A versão do dispositivo duplo, incluindo etiquetas e propriedades pretendidas |
| x509Thumbprint |
O thumbprint X509 do dispositivo. |
TwinProperties
As propriedades pretendidas e comunicadas do duplo. A profundidade máxima do objeto é 10.
| Name | Tipo | Description |
|---|---|---|
| desired |
object |
A coleção de pares chave-valor de propriedade pretendidos. As chaves têm codificação UTF-8, sensíveis a maiúsculas e minúsculas e até 1 KB de comprimento. Os carateres permitidos excluem carateres de controlo UNICODE (segmentos C0 e C1), ".", "$" e espaço. Os valores de porperty pretendidos são objetos JSON, com um comprimento máximo de 4 KB. |
| reported |
object |
A coleção de pares chave-valor da propriedade reportada. As chaves têm codificação UTF-8, sensíveis a maiúsculas e minúsculas e até 1 KB de comprimento. Os carateres permitidos excluem carateres de controlo UNICODE (segmentos C0 e C1), ".", "$" e espaço. Os valores de propriedade comunicados são objetos JSON, com um comprimento máximo de 4 KB. |
X509Thumbprint
| Name | Tipo | Description |
|---|---|---|
| primaryThumbprint |
string |
O thumbprint primário do certificado de cliente X509. |
| secondaryThumbprint |
string |
O thumbprint secundário do certificado de cliente X509. |