Dela via


Bulk Registry - Update Registry

Skapar, uppdaterar eller tar bort identiteterna för flera enheter från IoT Hub identitetsregistret. En enhetsidentitet kan bara anges en gång i listan. Olika åtgärder (skapa, uppdatera, ta bort) på olika enheter tillåts. Högst 100 enheter kan anges per anrop. För storskaliga åtgärder använder du importfunktionen med bloblagring (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-12

URI-parametrar

Name I Obligatorisk Typ Description
api-version
query True

string

Version av API:et.

Begärandetext

Name Typ Description
devices

ExportImportDevice[]

De registeråtgärder som ska utföras.

Svar

Name Typ Description
200 OK

BulkRegistryOperationResult

OK.

400 Bad Request

BulkRegistryOperationResult

Felaktig begäran.

Definitioner

Name Description
AuthenticationMechanism
BulkRegistryOperationResult

Resultatet av massregistreringsåtgärden.

DeviceCapabilities

Status för funktioner som är aktiverade på enheten.

DeviceRegistryOperationError

Information om enhetsregistrets åtgärdsfel.

DeviceRegistryOperationWarning

Varningsinformation om enhetsregistrets åtgärd.

ExportImportDevice
PropertyContainer

Önskade och rapporterade egenskaper för tvillingen. Objektets maximala djup är 10.

SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name Typ Description
symmetricKey

SymmetricKey

De primära och sekundära nycklarna som används för SAS-baserad autentisering.

type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Den typ av autentisering som används för att ansluta till tjänsten.

x509Thumbprint

X509Thumbprint

De primära och sekundära x509-tumavtrycken som används för x509-baserad autentisering.

BulkRegistryOperationResult

Resultatet av massregistreringsåtgärden.

Name Typ Description
errors

DeviceRegistryOperationError[]

Enhetsregistrets åtgärdsfel.

isSuccessful

boolean

Åtgärdsresultatet.

warnings

DeviceRegistryOperationWarning[]

Varningarna om enhetsregistrets åtgärd.

DeviceCapabilities

Status för funktioner som är aktiverade på enheten.

Name Typ Description
iotEdge

boolean

Egenskapen som avgör om enheten är en gränsenhet eller inte.

DeviceRegistryOperationError

Information om enhetsregistrets åtgärdsfel.

Name Typ Description
deviceId

string

Enhetens unika identifierare.

errorCode enum:
  • AmqpAddressNotFound
  • ApplyConfigurationAlreadyInProgressOnDevice
  • ArgumentInvalid
  • ArgumentNull
  • AsyncOperationNotFound
  • AzureStorageTimeout
  • AzureTableStoreError
  • AzureTableStoreNotFound
  • BackupTimedOut
  • BlobContainerValidationError
  • BulkAddDevicesNotSupported
  • BulkRegistryOperationFailure
  • CallbackSubscriptionConflict
  • CannotModifyImmutableConfigurationContent
  • CannotRegisterModuleToModule
  • CertificateAuthorityConflict
  • CertificateAuthorityNotFound
  • CertificateNotFound
  • CheckpointStoreNotFound
  • ClientClosedRequest
  • ConfigReadFailed
  • ConfigurationAlreadyExists
  • ConfigurationCountLimitExceeded
  • ConfigurationNotAvailable
  • ConfigurationNotFound
  • ConnectionForcefullyClosed
  • ConnectionForcefullyClosedOnFaultInjection
  • ConnectionForcefullyClosedOnNewConnection
  • ConnectionRejectedOnFaultInjection
  • ConnectionUnavailable
  • CustomAllocationFailed
  • CustomAllocationIotHubNotSpecified
  • CustomAllocationUnauthorizedAccess
  • DefaultStorageEndpointNotConfigured
  • DeserializationError
  • DeviceAlreadyExists
  • DeviceConnectionClosedRemotely
  • DeviceDefinedMultipleTimes
  • DeviceDisabled
  • DeviceGroupConflict
  • DeviceGroupNotFound
  • DeviceInvalidResultCount
  • DeviceJobAlreadyExists
  • DeviceLocked
  • DeviceMaximumActiveFileUploadLimitExceeded
  • DeviceMaximumQueueDepthExceeded
  • DeviceMaximumQueueSizeExceeded
  • DeviceMessageLockLost
  • DeviceModelMaxIndexablePropertiesExceeded
  • DeviceModelMaxPropertiesExceeded
  • DeviceNotFound
  • DeviceNotOnline
  • DeviceRecordConflict
  • DeviceRecordNotFound
  • DeviceRegistrationNotFound
  • DeviceStorageEntitySerializationError
  • DeviceThrottlingLimitExceeded
  • DeviceUnavailable
  • DigitalTwinInterfaceNotFound
  • DigitalTwinModelAlreadyExists
  • DigitalTwinModelCountLimitExceeded
  • DigitalTwinModelExistsWithOtherModelType
  • DigitalTwinModelNotFound
  • DocumentDbInvalidReturnValue
  • ElasticPoolNotFound
  • ElasticPoolTenantHubNotFound
  • EnrollmentConflict
  • EnrollmentGroupConflict
  • EnrollmentGroupNotFound
  • EnrollmentNotFound
  • EtagDoesNotMatch
  • EventHubLinkAlreadyClosed
  • ExpiredFileUploadCorrelationId
  • FeatureNotSupported
  • GatewayTimeout
  • GenericBadGateway
  • GenericBadRequest
  • GenericConflict
  • GenericForbidden
  • GenericGatewayTimeout
  • GenericMethodNotAllowed
  • GenericNotFound
  • GenericPreconditionFailed
  • GenericRequestEntityTooLarge
  • GenericServerError
  • GenericServiceUnavailable
  • GenericTimeout
  • GenericTooManyRequests
  • GenericUnauthorized
  • GenericUnsupportedMediaType
  • GroupNotAvailable
  • GroupNotFound
  • GroupRecordConflict
  • GroupRecordNotFound
  • HostingServiceNotAvailable
  • ImportDevicesNotSupported
  • ImportWarningExistsError
  • IncompatibleDataType
  • InflightMessagesInLink
  • InterfaceNameCompressionModelCountLimitExceeded
  • InterfaceNameModelAlreadyExists
  • InterfaceNameModelNotFound
  • InvalidBlobState
  • InvalidConfigurationContent
  • InvalidConfigurationCustomMetricsQuery
  • InvalidConfigurationTargetCondition
  • InvalidContainerReceiveLink
  • InvalidContentEncodingOrType
  • InvalidDeviceScope
  • InvalidDigitalTwinJsonPatch
  • InvalidDigitalTwinPatch
  • InvalidDigitalTwinPatchPath
  • InvalidDigitalTwinPayload
  • InvalidEndorsementKey
  • InvalidEndpointAuthenticationType
  • InvalidEnrollmentGroupId
  • InvalidErrorCode
  • InvalidFileUploadCompletionStatus
  • InvalidFileUploadCorrelationId
  • InvalidMessageExpiryTime
  • InvalidMessagingEndpoint
  • InvalidOperation
  • InvalidPartitionEpoch
  • InvalidPnPDesiredProperties
  • InvalidPnPInterfaceDefinition
  • InvalidPnPReportedProperties
  • InvalidPnPWritableReportedProperties
  • InvalidProtocolVersion
  • InvalidRegistrationId
  • InvalidResponseWhileProxying
  • InvalidRouteTestInput
  • InvalidSchemaVersion
  • InvalidSourceOnRoute
  • InvalidStorageEndpoint
  • InvalidStorageEndpointOrBlob
  • InvalidStorageEndpointProperty
  • InvalidStorageRootKey
  • InvalidThrottleParameter
  • IotDpsSuspended
  • IotDpsSuspending
  • IotHubActivationFailed
  • IotHubFailingOver
  • IotHubFormatError
  • IotHubMaxCbsTokenExceeded
  • IotHubNotFound
  • IotHubQuotaExceeded
  • IotHubRestoring
  • IotHubSuspended
  • IotHubUnauthorized
  • IotHubUnauthorizedAccess
  • JobAlreadyExists
  • JobCancelled
  • JobNotFound
  • JobQuotaExceeded
  • JobRunPreconditionFailed
  • KeyEncryptionKeyRevoked
  • LinkCreationConflict
  • LinkedHubConflict
  • LinkedHubNotFound
  • ManagedIdentityNotEnabled
  • MessageTooLarge
  • ModelAlreadyExists
  • ModelRepoEndpointError
  • ModuleAlreadyExistsOnDevice
  • ModuleNotFound
  • NullMessage
  • OperationNotAllowedInCurrentState
  • OperationNotAvailableInCurrentTier
  • OrchestrationOperationFailed
  • OrphanDiscoveryDocument
  • PartitionNotFound
  • PreconditionFailed
  • ProvisioningRecordConflict
  • ProvisioningRecordNotFound
  • ProvisioningSettingsConflict
  • ProvisioningSettingsNotFound
  • QueryStoreClusterNotFound
  • QuotaMetricNotFound
  • ReceiveLinkOpensThrottled
  • RegistrationIdDefinedMultipleTimes
  • RegistrationStatusConflict
  • ReliableBlobStoreError
  • ReliableBlobStoreTimeoutError
  • ReliableDocDbStoreStoreError
  • RequestCanceled
  • RequestTimedOut
  • ResolutionError
  • RestoreTimedOut
  • RetryAttemptsExhausted
  • RoutingEndpointResponseForbidden
  • RoutingEndpointResponseNotFound
  • RoutingNotEnabled
  • SerializationError
  • ServerBusy
  • ServerError
  • ServiceUnavailable
  • StatisticsRetrievalError
  • StreamReservationFailure
  • SystemModuleModifyUnauthorizedAccess
  • SystemPropertyNotFound
  • TenantHubRoutingNotEnabled
  • ThrottleBacklogLimitExceeded
  • ThrottlingBacklogTimeout
  • ThrottlingException
  • ThrottlingMaxActiveJobCountExceeded
  • TooManyDevices
  • TooManyEnrollments
  • TooManyModulesOnDevice
  • UnableToCompressComponentInfo
  • UnableToCompressDiscoveryInfo
  • UnableToExpandComponentInfo
  • UnableToExpandDiscoveryInfo
  • UnableToFetchCredentials
  • UnableToFetchTenantInfo
  • UnableToShareIdentity
  • UnexpectedPropertyValue
  • UnsupportedOperationOnReplica

Felkoden.

errorStatus

string

Information om felet.

moduleId

string

Den unika identifieraren för modulen, om tillämpligt.

operation

string

Typen av åtgärd som misslyckades.

DeviceRegistryOperationWarning

Varningsinformation om enhetsregistrets åtgärd.

Name Typ Description
deviceId

string

Enhetens unika identifierare.

warningCode enum:

DeviceRegisteredWithoutTwin

Varningskoden.

warningStatus

string

Information om varningen.

ExportImportDevice

Name Typ Description
authentication

AuthenticationMechanism

Autentiseringsmekanismen som används av modulen. Den här parametern är valfri och har standardinställningen SAS om den inte anges. I så fall genereras primära/sekundära åtkomstnycklar automatiskt.

capabilities

DeviceCapabilities

Status för funktioner som är aktiverade på enheten.

deviceScope

string

Enhetens omfång.

eTag

string

Strängen som representerar en svag ETag för enheten RFC7232. Värdet används endast om importläget är updateIfMatchETag, i så fall utförs importåtgärden endast om denna ETag matchar det värde som upprätthålls av servern.

id

string

Enhetens unika identifierare.

importMode enum:
  • create
  • delete
  • deleteIfMatchETag
  • update
  • updateIfMatchETag
  • updateTwin
  • updateTwinIfMatchETag

Typ av registeråtgärd och ETag-inställningar.

moduleId

string

Den unika identifieraren för modulen, om tillämpligt.

parentScopes

string[]

Omfången för gränsenheterna på den övre nivån om tillämpligt. Endast tillgängligt för gränsenheter.

properties

PropertyContainer

Önskade och rapporterade egenskaper för enheten.

status enum:
  • disabled
  • enabled

Status för modulen. Om modulen är inaktiverad kan den inte ansluta till tjänsten.

statusReason

string

Den 128 tecken långa strängen som lagrar orsaken till enhetens identitetsstatus. Alla UTF-8 tecken tillåts.

tags

object

JSON-dokumentet lästes och skrevs av lösningens serverdel. Taggarna är inte synliga för enhetsappar.

twinETag

string

Strängen som representerar en svag ETag för enhetstvillingen RFC7232. Värdet används endast om importläget är updateIfMatchETag, i så fall utförs importåtgärden endast om denna ETag matchar det värde som upprätthålls av servern.

PropertyContainer

Önskade och rapporterade egenskaper för tvillingen. Objektets maximala djup är 10.

Name Typ Description
desired

object

Samlingen med nyckel/värde-par för önskad egenskap. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 kB långa. Tillåtna tecken utesluter UNICODE-kontrolltecken (segmenten C0 och C1), ".", "$" och blanksteg. Önskade porperty-värden är JSON-objekt med en längd på upp till 4 KB.

reported

object

Samlingen av nyckel/värde-par för rapporterade egenskaper. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 kB långa. Tillåtna tecken utesluter UNICODE-kontrolltecken (segmenten C0 och C1), ".", "$" och blanksteg. De rapporterade egenskapsvärdena är JSON-objekt med en längd på upp till 4 KB.

SymmetricKey

Name Typ Description
primaryKey

string

Enhetens base64-kodade primärnyckel.

secondaryKey

string

Enhetens base64-kodade sekundära nyckel.

X509Thumbprint

Name Typ Description
primaryThumbprint

string

X509-klientcertifikatets primära tumavtryck.

secondaryThumbprint

string

Det sekundära tumavtrycket för X509-klientcertifikatet.