Bulk Registry - Update Registry

Több eszköz identitásait hozza létre, frissíti vagy törli a IoT Hub identitásjegyzékből. Az eszközidentitás csak egyszer adható meg a listában. Különböző eszközökön különböző műveletek (létrehozás, frissítés, törlés) engedélyezettek. Hívásonként legfeljebb 100 eszköz adható meg. Nagy léptékű műveletekhez használja az importálási funkciót a Blob Storage (https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities) használatával.

POST https://fully-qualified-iothubname.azure-devices.net/devices?api-version=2020-05-31-preview

URI-paraméterek

Name In Required Type Description
api-version
query True
  • string

Az API verziója.

Kérelem törzse

Name Type Description
devices

A végrehajtandó beállításjegyzék-műveletek.

Válaszok

Name Type Description
200 OK

OK gombra.

400 Bad Request

Rossz kérés.

Definíciók

AuthenticationMechanism
BulkRegistryOperationResult

A tömeges beállításjegyzék-művelet eredménye.

DeviceCapabilities

Az eszközön engedélyezett képességek állapota.

DeviceRegistryOperationError

Az eszközregisztrációs adatbázis műveletének hibaadatai.

DeviceRegistryOperationWarning

Az eszközregisztrációs adatbázis műveletére vonatkozó figyelmeztetés részletei.

ExportImportDevice
PropertyContainer

Az ikerpéldány kívánt és jelentett tulajdonságai. Az objektum maximális mélysége 10.

SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name Type Description
symmetricKey

Az SAS-alapú hitelesítéshez használt elsődleges és másodlagos kulcsok.

type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

A szolgáltatáshoz való csatlakozáshoz használt hitelesítés típusa.

x509Thumbprint

Az x509-alapú hitelesítéshez használt elsődleges és másodlagos x509 ujjlenyomatok.

BulkRegistryOperationResult

A tömeges beállításjegyzék-művelet eredménye.

Name Type Description
errors

Az eszközregisztrációs adatbázis műveleti hibái.

isSuccessful
  • boolean

A művelet eredménye.

warnings

Az eszközregisztrációs adatbázis műveletére vonatkozó figyelmeztetések.

DeviceCapabilities

Az eszközön engedélyezett képességek állapota.

Name Type Description
iotEdge
  • boolean

Az a tulajdonság, amely meghatározza, hogy az eszköz peremeszköz-e.

DeviceRegistryOperationError

Az eszközregisztrációs adatbázis műveletének hibaadatai.

Name Type Description
deviceId
  • string

Az eszköz egyedi azonosítója.

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
  • 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

A hibakód.

errorStatus
  • string

A hiba részletei.

moduleId
  • string

A modul egyedi azonosítója, ha van.

operation
  • string

A sikertelen művelet típusa.

DeviceRegistryOperationWarning

Az eszközregisztrációs adatbázis műveletére vonatkozó figyelmeztetés részletei.

Name Type Description
deviceId
  • string

Az eszköz egyedi azonosítója.

warningCode enum:
  • DeviceRegisteredWithoutTwin

A figyelmeztető kód.

warningStatus
  • string

A figyelmeztetés részletei.

ExportImportDevice

Name Type Description
authentication

A modul által használt hitelesítési mechanizmus. Ez a paraméter nem kötelező, és ha nincs megadva, alapértelmezés szerint SAS-t ad meg. Ebben az esetben az elsődleges/másodlagos hozzáférési kulcsok automatikusan létre lesznek hozva.

capabilities

Az eszközön engedélyezett képességek állapota.

deviceScope
  • string

Az eszköz hatóköre.

eTag
  • string

Az RFC7232 eszköz gyenge ETag-jének sztringje. Az érték csak akkor használatos, ha az importálási mód updateIfMatchETag, ebben az esetben az importálási művelet csak akkor lesz végrehajtva, ha ez az ETag megegyezik a kiszolgáló által fenntartott értékkel.

id
  • string

Az eszköz egyedi azonosítója.

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

A beállításjegyzék-művelet típusa és az ETag-beállítások.

moduleId
  • string

A modul egyedi azonosítója, ha van.

properties

Az eszköz kívánt és jelentett tulajdonságai.

status enum:
  • disabled
  • enabled

A modul állapota. Ha le van tiltva, a modul nem tud csatlakozni a szolgáltatáshoz.

statusReason
  • string

Az eszközidentitás állapotának okát tároló 128 karakter hosszú sztring. Minden UTF-8 karakter megengedett.

tags
  • object

A megoldás háttérrendszere által beolvasott és írt JSON-dokumentum. A címkék nem láthatók az eszközalkalmazások számára.

twinETag
  • string

Az Ikereszköz RFC7232 gyenge ETag-jének sztringje. Az érték csak akkor használatos, ha az importálási mód updateIfMatchETag, ebben az esetben az importálási művelet csak akkor lesz végrehajtva, ha ez az ETag megegyezik a kiszolgáló által fenntartott értékkel.

PropertyContainer

Az ikerpéldány kívánt és jelentett tulajdonságai. Az objektum maximális mélysége 10.

Name Type Description
desired
  • object

A kívánt tulajdonságkulcs-érték párok gyűjteménye. A kulcsok UTF-8 kódolásúak, megkülönböztetik a kis- és nagybetűket, és akár 1 KB hosszúak is. Az engedélyezett karakterek nem tartalmazzák a UNICODE-vezérlőkaraktereket (C0 és C1 szegmens), a ".", a "$" és a szóközt. A kívánt porperty értékek JSON-objektumok, legfeljebb 4 KB hosszúságúak.

reported
  • object

A jelentett tulajdonságkulcs-érték párok gyűjteménye. A kulcsok UTF-8 kódolásúak, megkülönböztetik a kis- és nagybetűket, és akár 1 KB hosszúak is. Az engedélyezett karakterek nem tartalmazzák a UNICODE-vezérlőkaraktereket (C0 és C1 szegmens), a ".", a "$" és a szóközt. A jelentett tulajdonságértékek JSON-objektumok, legfeljebb 4 KB hosszúságúak.

SymmetricKey

Name Type Description
primaryKey
  • string

Az eszköz base64 kódolású elsődleges kulcsa.

secondaryKey
  • string

Az eszköz Base64 kódolású másodlagos kulcsa.

X509Thumbprint

Name Type Description
primaryThumbprint
  • string

Az X509-ügyféltanúsítvány elsődleges ujjlenyomata.

secondaryThumbprint
  • string

Az X509 ügyféltanúsítvány másodlagos ujjlenyomata.