Devices - Replace Twin
Substitui as marcas e as propriedades desejadas de um dispositivo gêmeo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obter mais informações.
PUT https://fully-qualified-iothubname.azure-devices.net/twins/{id}?api-version=2021-04-12Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
id
|
path | True |
string |
O identificador exclusivo do dispositivo. |
|
api-version
|
query | True |
string |
Versão da API. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| If-Match |
string |
A cadeia de caracteres que representa uma ETag fraca para o dispositivo gêmeo, de acordo com RFC7232. Ele determina se a operação de substituição deve ser executada. |
Corpo da solicitação
| Nome | Tipo | Description |
|---|---|---|
| authenticationType |
enum:
|
O tipo de autenticação usado pelo dispositivo. |
| capabilities |
O status de recursos habilitados no dispositivo. |
|
| cloudToDeviceMessageCount |
integer |
O número de mensagens de nuvem para dispositivo enviadas. |
| connectionState |
enum:
|
O estado de conexão do dispositivo. |
| deviceEtag |
string |
A cadeia de caracteres que representa uma ETag para o dispositivo, de acordo com RFC7232. |
| deviceId |
string |
O identificador exclusivo do dispositivo no registro de identidade do Hub IoT. É uma cadeia de caracteres que diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos ASCII de 7 bits, e os seguintes caracteres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', '', '=', '@', ';', '$', '''}. |
| deviceScope |
string |
O escopo do dispositivo. |
| etag |
string |
A cadeia de caracteres que representa uma ETag para o dispositivo gêmeo, de acordo com RFC7232. |
| lastActivityTime |
string |
A data e a hora em que o dispositivo se conectou pela última vez ou recebeu ou enviou uma mensagem. A data e hora são especificadas em ISO8601 formato datetime em UTC, por exemplo, 2015-01-28T16:24:48.789Z. Esse valor não será atualizado se o dispositivo usar o protocolo HTTP/1 para executar operações de mensagens. |
| moduleId |
string |
O identificador exclusivo do módulo no registro de identidade do Hub IoT. É uma cadeia de caracteres que diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos ASCII de 7 bits, e os seguintes caracteres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', '', '=', '@', ';', '$', '''}. |
| parentScopes |
string[] |
Os escopos dos dispositivos de borda de nível superior, se aplicável. Disponível apenas para dispositivos de borda. |
| properties |
As propriedades desejadas e relatadas do gêmeo. |
|
| status |
enum:
|
O status habilitado do dispositivo. Se desabilitado, o dispositivo não poderá se conectar ao serviço. |
| statusReason |
string |
O motivo do status atual do dispositivo, se houver. |
| statusUpdateTime |
string |
A data e a hora em que o status do dispositivo foi atualizado pela última vez. |
| tags |
object |
A coleção de pares chave-valor lida e gravada pelo back-end da solução. Eles não são visíveis para aplicativos de dispositivo. As chaves são codificadas em UTF-8, diferenciam maiúsculas de minúsculas e têm até 1KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores são objetos JSON, de até 4KB de comprimento. |
| version |
integer |
A versão do dispositivo gêmeo, incluindo marcas e propriedades desejadas |
| x509Thumbprint |
A impressão digital X509 do dispositivo. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
OK. |
Definições
| Nome | Description |
|---|---|
|
Device |
O status de recursos habilitados no dispositivo. |
| Twin |
As informações de estado de um dispositivo ou módulo. Isso é criado e excluído implicitamente quando a identidade do dispositivo/módulo correspondente é criada ou excluída no Hub IoT. |
|
Twin |
As propriedades desejadas e relatadas do gêmeo. A profundidade máxima do objeto é 10. |
| X509Thumbprint |
DeviceCapabilities
O status de recursos habilitados no dispositivo.
| Nome | Tipo | Description |
|---|---|---|
| iotEdge |
boolean |
A propriedade que determina se o dispositivo é um dispositivo de borda ou não. |
Twin
As informações de estado de um dispositivo ou módulo. Isso é criado e excluído implicitamente quando a identidade do dispositivo/módulo correspondente é criada ou excluída no Hub IoT.
| Nome | Tipo | Description |
|---|---|---|
| authenticationType |
enum:
|
O tipo de autenticação usado pelo dispositivo. |
| capabilities |
O status de recursos habilitados no dispositivo. |
|
| cloudToDeviceMessageCount |
integer |
O número de mensagens de nuvem para dispositivo enviadas. |
| connectionState |
enum:
|
O estado de conexão do dispositivo. |
| deviceEtag |
string |
A cadeia de caracteres que representa uma ETag para o dispositivo, de acordo com RFC7232. |
| deviceId |
string |
O identificador exclusivo do dispositivo no registro de identidade do Hub IoT. É uma cadeia de caracteres que diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos ASCII de 7 bits, e os seguintes caracteres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', '', '=', '@', ';', '$', '''}. |
| deviceScope |
string |
O escopo do dispositivo. |
| etag |
string |
A cadeia de caracteres que representa uma ETag para o dispositivo gêmeo, de acordo com RFC7232. |
| lastActivityTime |
string |
A data e a hora em que o dispositivo se conectou pela última vez ou recebeu ou enviou uma mensagem. A data e hora são especificadas em ISO8601 formato datetime em UTC, por exemplo, 2015-01-28T16:24:48.789Z. Esse valor não será atualizado se o dispositivo usar o protocolo HTTP/1 para executar operações de mensagens. |
| moduleId |
string |
O identificador exclusivo do módulo no registro de identidade do Hub IoT. É uma cadeia de caracteres que diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos ASCII de 7 bits, e os seguintes caracteres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', '', '=', '@', ';', '$', '''}. |
| parentScopes |
string[] |
Os escopos dos dispositivos de borda de nível superior, se aplicável. Disponível apenas para dispositivos de borda. |
| properties |
As propriedades desejadas e relatadas do gêmeo. |
|
| status |
enum:
|
O status habilitado do dispositivo. Se desabilitado, o dispositivo não poderá se conectar ao serviço. |
| statusReason |
string |
O motivo do status atual do dispositivo, se houver. |
| statusUpdateTime |
string |
A data e a hora em que o status do dispositivo foi atualizado pela última vez. |
| tags |
object |
A coleção de pares chave-valor lida e gravada pelo back-end da solução. Eles não são visíveis para aplicativos de dispositivo. As chaves são codificadas em UTF-8, diferenciam maiúsculas de minúsculas e têm até 1KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores são objetos JSON, de até 4KB de comprimento. |
| version |
integer |
A versão do dispositivo gêmeo, incluindo marcas e propriedades desejadas |
| x509Thumbprint |
A impressão digital X509 do dispositivo. |
TwinProperties
As propriedades desejadas e relatadas do gêmeo. A profundidade máxima do objeto é 10.
| Nome | Tipo | Description |
|---|---|---|
| desired |
object |
A coleção de pares chave-valor de propriedade desejados. As chaves são codificadas em UTF-8, diferenciam maiúsculas de minúsculas e têm até 1KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores de porperty desejados são objetos JSON, de até 4KB de comprimento. |
| reported |
object |
A coleção de pares chave-valor de propriedade relatados. As chaves são codificadas em UTF-8, diferenciam maiúsculas de minúsculas e têm até 1KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores de propriedade relatados são objetos JSON, de até 4KB de comprimento. |
X509Thumbprint
| Nome | Tipo | Description |
|---|---|---|
| primaryThumbprint |
string |
A impressão digital primária do certificado do cliente X509. |
| secondaryThumbprint |
string |
A impressão digital secundária do certificado do cliente X509. |