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

AttestationMechanism

Механизм аттестации для individualEnrollment и enrollmentGroup.

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

BulkEnrollmentOperation

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

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

BulkEnrollmentOperationError

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

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

BulkEnrollmentOperationResult

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

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

CustomAllocationDefinition

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

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

DeviceCapabilities

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

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

DeviceRegistrationState

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

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