Bulk Registry - Update Registry

IoT Hub ID レジストリから複数のデバイスの ID を作成、更新、または削除します。 デバイス ID は、一覧で 1 回だけ指定できます。 デバイスごとに異なる操作 (作成、更新、削除) が許可されます。 呼び出しごとに最大 100 台のデバイスを指定できます。 大規模な操作の場合は、BLOB ストレージ (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=2020-05-31-preview

URI パラメーター

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

Api のバージョン。

要求本文

Name Type Description
devices

実行するレジストリ操作。

応答

Name Type Description
200 OK

OK です。

400 Bad Request

正しくない要求。

定義

AuthenticationMechanism
BulkRegistryOperationResult

一括レジストリ操作の結果。

DeviceCapabilities

デバイスで有効になっている機能の状態。

DeviceRegistryOperationError

デバイス レジストリ操作エラーの詳細。

DeviceRegistryOperationWarning

デバイス レジストリ操作の警告の詳細。

ExportImportDevice
PropertyContainer

ツインの必要なプロパティと報告されるプロパティ。 オブジェクトの最大深度は 10 です。

SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name Type Description
symmetricKey

SAS ベースの認証に使用されるプライマリ キーとセカンダリ キー。

type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

サービスへの接続に使用される認証の種類。

x509Thumbprint

x509 ベースの認証に使用されるプライマリとセカンダリの x509 拇印。

BulkRegistryOperationResult

一括レジストリ操作の結果。

Name Type Description
errors

デバイス レジストリ操作エラー。

isSuccessful
  • boolean

操作結果。

warnings

デバイス レジストリ操作の警告。

DeviceCapabilities

デバイスで有効になっている機能の状態。

Name Type Description
iotEdge
  • boolean

デバイスがエッジ デバイスかどうかを決定するプロパティ。

DeviceRegistryOperationError

デバイス レジストリ操作エラーの詳細。

Name Type Description
deviceId
  • string

デバイスの一意識別子。

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

エラー コード。

errorStatus
  • string

エラーの詳細。

moduleId
  • string

該当する場合は、モジュールの一意の識別子。

operation
  • string

失敗した操作の種類。

DeviceRegistryOperationWarning

デバイス レジストリ操作の警告の詳細。

Name Type Description
deviceId
  • string

デバイスの一意識別子。

warningCode enum:
  • DeviceRegisteredWithoutTwin

警告コード。

warningStatus
  • string

警告の詳細。

ExportImportDevice

Name Type Description
authentication

モジュールによって使用される認証メカニズム。 このパラメーターは省略可能で、指定されていない場合は既定で SAS になります。 その場合、プライマリ/セカンダリ アクセス キーが自動生成されます。

capabilities

デバイスで有効になっている機能の状態。

deviceScope
  • string

デバイスのスコープ。

eTag
  • string

デバイス RFC7232 の脆弱な ETag を表す文字列。 この値は、インポート モードが updateIfMatchETag の場合にのみ使用されます。その場合、インポート操作は、この ETag がサーバーによって保持されている値と一致する場合にのみ実行されます。

id
  • string

デバイスの一意識別子。

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

レジストリ操作の種類と ETag の基本設定。

moduleId
  • string

該当する場合は、モジュールの一意の識別子。

properties

デバイスの必要なプロパティと報告されるプロパティ。

status enum:
  • disabled
  • enabled

モジュールの状態。 無効にした場合、モジュールはサービスに接続できません。

statusReason
  • string

デバイス ID の状態の理由を格納する 128 文字の文字列。 すべての UTF-8 文字を使用できます。

tags
  • object

ソリューション バックエンドによって読み取られ、書き込まれた JSON ドキュメント。 タグはデバイス アプリには表示されません。

twinETag
  • string

デバイス ツイン RFC7232 の弱い ETag を表す文字列。 この値は、インポート モードが updateIfMatchETag の場合にのみ使用されます。その場合、インポート操作は、この ETag がサーバーによって保持されている値と一致する場合にのみ実行されます。

PropertyContainer

ツインの必要なプロパティと報告されるプロパティ。 オブジェクトの最大深度は 10 です。

Name Type Description
desired
  • object

目的のプロパティ キーと値のペアのコレクション。 キーは UTF-8 でエンコードされ、大文字と小文字が区別され、最大 1 KB の長さです。 使用できる文字は、UNICODE 制御文字 (セグメント C0 および C1)、'.'、'$'、およびスペースを除外します。 目的の値は JSON オブジェクトで、最大 4 KB の長さです。

reported
  • object

報告されるプロパティのキーと値のペアのコレクション。 キーは UTF-8 でエンコードされ、大文字と小文字が区別され、最大 1 KB の長さです。 使用できる文字は、UNICODE 制御文字 (セグメント C0 および C1)、'.'、'$'、およびスペースを除外します。 報告されるプロパティ値は JSON オブジェクトで、最大 4 KB の長さです。

SymmetricKey

Name Type Description
primaryKey
  • string

デバイスの base64 でエンコードされた主キー。

secondaryKey
  • string

デバイスの base64 でエンコードされたセカンダリ キー。

X509Thumbprint

Name Type Description
primaryThumbprint
  • string

X509 クライアント証明書のプライマリ拇印。

secondaryThumbprint
  • string

X509 クライアント証明書のセカンダリ拇印。