Enrollment Group - Run Bulk Operation

Service:

IoT Hub Device Provisioning Service

API Version:

2021-10-01

Массовая операция группы регистрации устройств с максимум 10 группами.

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

Параметры URI

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

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

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

Ответы

Имя	Тип	Описание
200 OK	BulkEnrollmentGroupOperationResult	Успешное завершение
Other Status Codes	ProvisioningServiceErrorDetails	Сообщение об ошибке Headers x-ms-error-code: string

Определения

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

AttestationMechanism

Механизм аттестации для индивидуальной регистрации, а также enrollmentGroup.

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

BulkEnrollmentGroupOperation

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

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

BulkEnrollmentGroupOperationError

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

Имя	Тип	Описание
enrollmentGroupId	string	Идентификатор группы регистрации.
errorCode	integer	Код ошибки
errorStatus	string	Состояние ошибки.

BulkEnrollmentGroupOperationResult

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

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

CustomAllocationDefinition

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

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

DeviceCapabilities

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

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

EnrollmentGroup

Запись группы регистрации.

Имя	Тип	Значение по умолчанию	Описание
allocationPolicy	enum: custom geoLatency hashed static		Политика выделения этого ресурса. Эта политика переопределяет политику распределения на уровне клиента для этой отдельной регистрации или группы регистрации. Возможные значения: hashed. Связанные центры Интернета вещей, скорее всего, будут подготовлены устройства. GeoLatency: устройства подготавливаются в Центре Интернета вещей с наименьшей задержкой на устройстве. Если несколько связанных центров Интернета вещей обеспечивают одинаковую наименьшую задержку, служба подготовки хэширует устройства в этих центрах, "статический": спецификация нужного Центра Интернета вещей в списке регистрации имеет приоритет над политикой выделения на уровне служб. "Пользовательский" : устройства подготавливаются в Центре Интернета вещей на основе вашей собственной пользовательской логики. Служба подготовки передает сведения об устройстве в логику, а логика возвращает нужный Центр Интернета вещей, а также нужную начальную конфигурацию. Для размещения логики рекомендуется использовать Функции Azure.
attestation	AttestationMechanism		Механизм аттестации для индивидуальной регистрации, а также enrollmentGroup.
capabilities	DeviceCapabilities		Возможности устройства.
createdDateTimeUtc	string		Дата и время создания этого ресурса.
customAllocationDefinition	CustomAllocationDefinition		Это сообщает DPS, какой веб-перехватчик следует вызывать при использовании пользовательского выделения.
enrollmentGroupId	string		Идентификатор группы регистрации.
etag	string		Тег сущности, связанный с ресурсом.
initialTwin	InitialTwin		Исходный двойник устройства. Содержит подмножество свойств двойника.
iotHubHostName	string		Имя узла Центра Интернета вещей.
iotHubs	string[]		Список Центр Интернета вещей имен узлов, для которых можно выделить устройства в этом ресурсе. Должен быть подмножеством списка центров Интернета вещей на уровне клиента.
lastUpdatedDateTimeUtc	string		Дата и время последнего обновления этого ресурса.
provisioningStatus	enum: disabled enabled	enabled	Состояние подготовки.
reprovisionPolicy	ReprovisionPolicy		Поведение службы при повторной подготовке устройства в Центре Интернета вещей.

InitialTwin

Исходный двойник устройства. Содержит подмножество свойств двойника.

Имя	Тип	Описание
properties	InitialTwinProperties	Представляет начальные свойства, которые будут заданы для двойника устройства.
tags	TwinCollection	Представляет коллекцию свойств в двойником

InitialTwinProperties

Представляет начальные свойства, которые будут заданы для двойника устройства.

Имя	Тип	Описание
desired	TwinCollection	Представляет коллекцию свойств в двойником

Metadata

Метаданные для TwinCollection

Имя	Тип	Описание
lastUpdated	string	Время последнего обновления TwinCollection
lastUpdatedVersion	integer	Это значение равно NULL для метаданных сообщаемого свойства и не равно NULL для метаданных требуемых свойств.

ProvisioningServiceErrorDetails

Содержит свойства ошибки, возвращаемой службой подготовки Центр Интернета вещей Azure.

Имя	Тип	Описание
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

ReprovisionPolicy

Поведение службы при повторной подготовке устройства в Центре Интернета вещей.

Имя	Тип	Значение по умолчанию	Описание
migrateDeviceData	boolean	True	Если задано значение true (по умолчанию), служба подготовки устройств будет переносить данные устройства (двойник, возможности устройства и идентификатор устройства) из одного Центра Интернета вещей в другой во время обновления назначения Центра Интернета вещей. Если задано значение false, служба подготовки устройств сбросит данные устройства до начальной требуемой конфигурации, хранящейся в соответствующем списке регистрации.
updateHubAssignment	boolean	True	Если задано значение true (по умолчанию), служба подготовки устройств оценит назначение Центр Интернета вещей устройства и при необходимости обновит его для любых запросов на подготовку, кроме первого с данного устройства. Если задано значение false, устройство останется назначенным текущему Центру Интернета вещей.

SymmetricKeyAttestation

Аттестация с помощью SymmetricKey.

Имя	Тип	Описание
primaryKey	string	Первичный симметричный ключ.
secondaryKey	string	Вторичный симметричный ключ.

TpmAttestation

Аттестация с помощью доверенного платформенного модуля.

Имя	Тип	Описание
endorsementKey	string
storageRootKey	string

TwinCollection

Представляет коллекцию свойств в двойником

Имя	Тип	Описание
count	integer	Число свойств в коллекции TwinCollection
metadata	Metadata	Метаданные для TwinCollection
version	integer	Версия TwinCollection

X509Attestation

Аттестация через X509.

Имя	Тип	Описание
caReferences	X509CAReferences	Ссылки на первичный и вторичный ЦС.
clientCertificates	X509Certificates	Первичные и вторичные сертификаты
signingCertificates	X509Certificates	Первичные и вторичные сертификаты

X509CAReferences

Ссылки на первичный и вторичный ЦС.

Имя	Тип	Описание
primary	string
secondary	string

X509CertificateInfo

Сведения о сертификате X509.

Имя	Тип	Описание
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509Certificates

Первичные и вторичные сертификаты

Имя	Тип	Описание
primary	X509CertificateWithInfo	Сведения о сертификате и сертификате
secondary	X509CertificateWithInfo	Сведения о сертификате и сертификате

X509CertificateWithInfo

Сведения о сертификате и сертификате

Имя	Тип	Описание
certificate	string
info	X509CertificateInfo	Сведения о сертификате X509.