Bulk Registry - Update Registry
Cria, atualiza ou elimina as identidades de vários dispositivos do Hub IoT registo de identidade. Uma identidade de dispositivo só pode ser especificada uma vez na lista. São permitidas diferentes operações (criar, atualizar, eliminar) em diferentes dispositivos. Pode especificar um máximo de 100 dispositivos por invocação. Para operações de grande escala, utilize a funcionalidade de importação com o armazenamento de blobs (https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).
POST https://fully-qualified-iothubname.azure-devices.net/devices?api-version=2021-04-12Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Versão da API. |
Corpo do Pedido
| Name | Tipo | Description |
|---|---|---|
| devices |
As operações de registo a executar. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
OK. |
|
| 400 Bad Request |
Pedido Incorreto. |
Definições
| Name | Description |
|---|---|
|
Authentication |
|
|
Bulk |
O resultado da operação de registo em massa. |
|
Device |
O estado das capacidades ativadas no dispositivo. |
|
Device |
Detalhes do erro da operação de registo do dispositivo. |
|
Device |
Os detalhes de aviso da operação de registo do dispositivo. |
|
Export |
|
|
Property |
As propriedades pretendidas e comunicadas do duplo. A profundidade máxima do objeto é 10. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Name | Tipo | Description |
|---|---|---|
| symmetricKey |
As chaves primárias e secundárias utilizadas para a autenticação baseada em SAS. |
|
| type |
enum:
|
O tipo de autenticação utilizado para ligar ao serviço. |
| x509Thumbprint |
Os thumbprints x509 primários e secundários utilizados para autenticação baseada em x509. |
BulkRegistryOperationResult
O resultado da operação de registo em massa.
| Name | Tipo | Description |
|---|---|---|
| errors |
Erros da operação de registo do dispositivo. |
|
| isSuccessful |
boolean |
O resultado da operação. |
| warnings |
Avisos da operação de registo do dispositivo. |
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. |
DeviceRegistryOperationError
Detalhes do erro da operação de registo do dispositivo.
| Name | Tipo | Description |
|---|---|---|
| deviceId |
string |
O identificador exclusivo do dispositivo. |
| errorCode |
enum:
|
O código de erro. |
| errorStatus |
string |
Os detalhes do erro. |
| moduleId |
string |
O identificador exclusivo do módulo, se aplicável. |
| operation |
string |
O tipo da operação que falhou. |
DeviceRegistryOperationWarning
Os detalhes de aviso da operação de registo do dispositivo.
| Name | Tipo | Description |
|---|---|---|
| deviceId |
string |
O identificador exclusivo do dispositivo. |
| warningCode |
enum:
Device |
O código de aviso. |
| warningStatus |
string |
Os detalhes do aviso. |
ExportImportDevice
| Name | Tipo | Description |
|---|---|---|
| authentication |
O mecanismo de autenticação utilizado pelo módulo. Este parâmetro é opcional e é predefinido para SAS se não for fornecido. Nesse caso, as chaves de acesso primárias/secundárias são geradas automaticamente. |
|
| capabilities |
O estado das capacidades ativadas no dispositivo. |
|
| deviceScope |
string |
O âmbito do dispositivo. |
| eTag |
string |
A cadeia que representa uma ETag fraca para o dispositivo RFC7232. O valor só é utilizado se o modo de importação for updateIfMatchETag. Nesse caso, a operação de importação só é efetuada se esta ETag corresponder ao valor mantido pelo servidor. |
| id |
string |
O identificador exclusivo do dispositivo. |
| importMode |
enum:
|
O tipo de operação de registo e preferências de ETag. |
| moduleId |
string |
O identificador exclusivo do módulo, se aplicável. |
| 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 dispositivo. |
|
| status |
enum:
|
O estado do módulo. Se estiver desativado, o módulo não consegue ligar ao serviço. |
| statusReason |
string |
A cadeia de carateres com 128 carateres que armazena o motivo do estado da identidade do dispositivo. Todos os carateres UTF-8 são permitidos. |
| tags |
object |
O documento JSON é lido e escrito pelo back-end da solução. As etiquetas não estão visíveis para as aplicações do dispositivo. |
| twinETag |
string |
A cadeia que representa uma ETag fraca para o dispositivo duplo RFC7232. O valor só é utilizado se o modo de importação for updateIfMatchETag. Nesse caso, a operação de importação só é efetuada se esta ETag corresponder ao valor mantido pelo servidor. |
PropertyContainer
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. |
SymmetricKey
| Name | Tipo | Description |
|---|---|---|
| primaryKey |
string |
A chave primária codificada em base64 do dispositivo. |
| secondaryKey |
string |
A chave secundária codificada base64 do dispositivo. |
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. |