Individual Enrollment - Run Bulk Operation

Ссылка

Служба:: IoT Hub Device Provisioning Service

Версия API:: 2021-10-01

Операция массовой регистрации устройств с максимальным числом регистраций не более 10.

POST https://your-dps.azure-devices-provisioning.net/enrollments?api-version=2021-10-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
api-version	query	True	string	Версия API, используемая для запроса. Поддерживаемые версии: 2021-10-01

Текст запроса

Имя	Обязательно	Тип	Описание
enrollments	True	IndividualEnrollment[]	Элементы регистрации
mode	True	enum: create update updateIfMatchETag delete	Режим работы.

Ответы

Имя	Тип	Описание
200 OK	BulkEnrollmentOperationResult	Успех
Other Status Codes	ProvisioningServiceErrorDetails	Ответ на ошибку Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

BulkEnrollmentOperationResult

Успех

Other Status Codes

ProvisioningServiceErrorDetails

Ответ на ошибку

Заголовки

x-ms-error-code: string

Определения

Имя	Описание
AttestationMechanism	Механизм аттестации для отдельныхenrollment, а также для регистрацииGroup.
BulkEnrollmentOperation	Операция массовой регистрации.
BulkEnrollmentOperationError	Ошибка операции массовой регистрации
BulkEnrollmentOperationResult	Результаты операции массовой регистрации
CustomAllocationDefinition	Это сообщает DPS, какой веб-перехватчик будет вызывать при использовании пользовательского выделения.
DeviceCapabilities	Возможности устройств.
DeviceRegistrationState	Состояние регистрации устройства.
IndividualEnrollment	Запись регистрации устройства.
InitialTwin	Исходный двойник устройства. Содержит подмножество свойств Twin.
InitialTwinProperties	Представляет начальные свойства, которые будут заданы в двойниках устройства.
Metadata	Метаданные для TwinCollection
ProvisioningServiceErrorDetails	Содержит свойства ошибки, возвращаемой службой подготовки Центра Интернета вещей Azure.
ReprovisionPolicy	Поведение службы при повторной подготовке устройства в Центр Интернета вещей.
SymmetricKeyAttestation	Аттестация через SymmetricKey.
TpmAttestation	Аттестация через TPM.
TwinCollection	Представляет коллекцию свойств в двойниках
X509Attestation	Аттестация через X509.
X509CAReferences	Ссылки на первичный и вторичный ЦС.
X509CertificateInfo	Сведения о сертификате X509.
X509Certificates	Первичные и вторичные сертификаты
X509CertificateWithInfo	Сведения о сертификате и сертификате

AttestationMechanism

Object

Механизм аттестации для отдельныхenrollment, а также для регистрацииGroup.

Имя	Тип	Описание
symmetricKey	SymmetricKeyAttestation	Аттестация через SymmetricKey.
tpm	TpmAttestation	Аттестация через TPM.
type	enum: none symmetricKey tpm x509	Тип аттестации.
x509	X509Attestation	Аттестация через X509.

BulkEnrollmentOperation

Object

Операция массовой регистрации.

Имя	Тип	Описание
enrollments	IndividualEnrollment[]	Элементы регистрации
mode	enum: create delete update updateIfMatchETag	Режим работы.

BulkEnrollmentOperationError

Object

Ошибка операции массовой регистрации

Имя	Тип	Описание
errorCode	integer (int32)	Код ошибки
errorStatus	string minLength: 1	Состояние ошибки.
registrationId	string minLength: 1	Этот идентификатор используется для уникальной идентификации регистрации устройства. Строка без учета регистра (до 128 символов длиной) буквенно-цифровых символов, а также некоторые специальные символы: . _ -. Специальные символы не допускаются в начале или конце.

BulkEnrollmentOperationResult

Object

Результаты операции массовой регистрации

Имя	Тип	Описание
errors	BulkEnrollmentOperationError[]	Ошибки регистрации
isSuccessful	boolean	Указывает, была ли операция успешно выполнена в целом.

CustomAllocationDefinition

Object

Это сообщает DPS, какой веб-перехватчик будет вызывать при использовании пользовательского выделения.

Имя	Тип	Описание
apiVersion	string minLength: 1	Версия API типов служб подготовки (например, IndividualEnrollment), отправляемая в пользовательском запросе на выделение. Минимальная поддерживаемая версия: "2018-09-01-preview".
webhookUrl	string minLength: 1	URL-адрес веб-перехватчика, используемый для запросов на выделение.

DeviceCapabilities

Object

Возможности устройств.

Имя	Тип	Default value	Описание
iotEdge	boolean	False	Если задано значение true, это устройство IoTEdge.

DeviceRegistrationState

Object

Состояние регистрации устройства.

Имя	Тип	Описание
assignedHub	string	Назначен Центр Интернета вещей Azure.
createdDateTimeUtc	string (date-time)	Время создания регистрации (в формате UTC).
deviceId	string	Идентификатор устройства.
errorCode	integer (int32)	Код ошибки.
errorMessage	string	Сообщение об ошибке.
etag	string	Тег сущности, связанный с ресурсом.
lastUpdatedDateTimeUtc	string (date-time)	Последнее обновление даты (в формате UTC).
payload	object
registrationId	string	Этот идентификатор используется для уникальной идентификации регистрации устройства. Строка без учета регистра (до 128 символов длиной) буквенно-цифровых символов, а также некоторые специальные символы: . _ -. Специальные символы не допускаются в начале или конце.
status	enum: assigned assigning disabled failed unassigned	Состояние регистрации.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	Подстатус для устройств "Назначено". Возможные значения включают в себя : initialAssignment: устройство было назначено Центру Интернета вещей впервые, "deviceDataMigrated": устройство было назначено другому Центру Интернета вещей и его данные устройства были перенесены из ранее назначенного Центра Интернета вещей. Данные устройства были удалены из ранее назначенного центра Интернета вещей , "deviceDataReset": устройство было назначено другому центру Интернета вещей, а его данные устройства были заполнены из начального состояния, хранящегося в регистрации. Данные устройства были удалены из ранее назначенного Центра Интернета вещей , "reprovisionedToInitialAssignment": устройство было повторно подготовлено к ранее назначенному Центру Интернета вещей.