Partilhar via

Devices - Replace Twin

Serviço:
IoT Hub
Versão da API:
2021-04-12

Substitui as tags e as propriedades desejadas de um gêmeo de dispositivo. 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-12

Parâmetros do URI

Name Em Necessário Tipo Description
id
 path True

string

O identificador exclusivo do dispositivo.
api-version
 query True

string

Versão da Api.

Cabeçalho do Pedido

Name Necessário Tipo Description
If-Match

string

A cadeia de caracteres que representa um ETag fraco para o gêmeo do dispositivo, conforme RFC7232. Ele determina se a operação de substituição deve ser realizada.

Corpo do Pedido

Name Tipo Description
authenticationType enum:
  • sas
  • selfSigned
  • certificateAuthority
  • none

O tipo de autenticação usado pelo dispositivo.
capabilities

DeviceCapabilities

O status dos recursos habilitados no dispositivo.
cloudToDeviceMessageCount

integer (int32)

O número de mensagens da nuvem para o dispositivo enviadas.
connectionState enum:
  • Disconnected
  • Connected

O estado de conexão do dispositivo.
deviceEtag

string

A cadeia de caracteres que representa um ETag para o dispositivo, conforme 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 um ETag para o gêmeo do dispositivo, conforme RFC7232.
lastActivityTime

string (date-time)

A data e a hora em que o dispositivo se conectou ou recebeu ou enviou uma mensagem pela última vez. A data e a hora são separadas no formato datetime ISO8601 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

TwinProperties

As propriedades desejadas e relatadas do gêmeo.
status enum:
  • enabled
  • disabled

O status ativado do dispositivo. Se desativado, o dispositivo não pode se conectar ao serviço.
statusReason

string

A razão para o status atual do dispositivo, se houver.
statusUpdateTime

string (date-time)

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 lidos e gravados 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 up-to 1 KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores são objetos JSON, up-to de 4 KB de comprimento.
version

integer (int64)

A versão para o dispositivo gêmeo, incluindo tags e propriedades desejadas
x509Thumbprint

X509Thumbprint

A impressão digital X509 do dispositivo.

Respostas

Name Tipo Description
200 OK

Twin

OK.

Definições

Name Description
DeviceCapabilities

O status dos recursos habilitados no dispositivo.
Twin

As informações de estado de um dispositivo ou módulo. Isso é implicitamente criado e excluído quando a identidade do dispositivo/módulo correspondente é criada ou excluída no Hub IoT.
TwinProperties

As propriedades desejadas e relatadas do gêmeo. A profundidade máxima do objeto é 10.
X509Thumbprint

DeviceCapabilities

Object

O status dos recursos habilitados no dispositivo.

Name Tipo Description
iotEdge

boolean

A propriedade que determina se o dispositivo é um dispositivo de borda ou não.

Twin

Object

As informações de estado de um dispositivo ou módulo. Isso é implicitamente criado e excluído quando a identidade do dispositivo/módulo correspondente é criada ou excluída no Hub IoT.

Name Tipo Description
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

O tipo de autenticação usado pelo dispositivo.
capabilities

DeviceCapabilities

O status dos recursos habilitados no dispositivo.
cloudToDeviceMessageCount

integer (int32)

O número de mensagens da nuvem para o dispositivo enviadas.
connectionState enum:
  • Connected
  • Disconnected

O estado de conexão do dispositivo.
deviceEtag

string

A cadeia de caracteres que representa um ETag para o dispositivo, conforme 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 um ETag para o gêmeo do dispositivo, conforme RFC7232.
lastActivityTime

string (date-time)

A data e a hora em que o dispositivo se conectou ou recebeu ou enviou uma mensagem pela última vez. A data e a hora são separadas no formato datetime ISO8601 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

TwinProperties

As propriedades desejadas e relatadas do gêmeo.
status enum:
  • disabled
  • enabled

O status ativado do dispositivo. Se desativado, o dispositivo não pode se conectar ao serviço.
statusReason

string

A razão para o status atual do dispositivo, se houver.
statusUpdateTime

string (date-time)

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 lidos e gravados 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 up-to 1 KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores são objetos JSON, up-to de 4 KB de comprimento.
version

integer (int64)

A versão para o dispositivo gêmeo, incluindo tags e propriedades desejadas
x509Thumbprint

X509Thumbprint

A impressão digital X509 do dispositivo.

TwinProperties

Object

As propriedades desejadas e relatadas do gêmeo. A profundidade máxima do objeto é 10.

Name 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 up-to de 1 KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores porperty desejados são objetos JSON, up-to 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 up-to de 1 KB 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 up-to 4 KB de comprimento.

X509Thumbprint

Object
Name 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.