Enrollment Group - Get
Получение группы регистрации устройств.
GET https://your-dps.azure-devices-provisioning.net/enrollmentGroups/{id}?api-version=2021-10-01Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
id
|
path | True |
string |
Идентификатор группы регистрации. |
|
api-version
|
query | True |
string |
Версия API для использования в запросе. Поддерживаемые версии: 2021-10-01 |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Успешное завершение |
|
| Other Status Codes |
Сообщение об ошибке Заголовки x-ms-error-code: string |
Определения
| Имя | Описание |
|---|---|
|
Attestation |
Механизм аттестации для individualEnrollment и enrollmentGroup. |
|
Custom |
Это сообщает DPS, какой веб-перехватчик следует вызывать при использовании пользовательского выделения. |
|
Device |
Возможности устройств. |
|
Enrollment |
Запись группы регистрации. |
|
Initial |
Исходный двойник устройства. Содержит подмножество свойств двойника. |
|
Initial |
Представляет начальные свойства, которые будут заданы для двойника устройства. |
| Metadata |
Метаданные для TwinCollection |
|
Provisioning |
Содержит свойства ошибки, возвращаемые службой подготовки Центр Интернета вещей Azure. |
|
Reprovision |
Поведение службы при повторной подготовке устройства в Центре Интернета вещей. |
|
Symmetric |
Аттестация с помощью SymmetricKey. |
|
Tpm |
Аттестация через TPM. |
|
Twin |
Представляет коллекцию свойств в двойнику |
| X509Attestation |
Аттестация через X509. |
| X509CAReferences |
Ссылки на первичный и вторичный ЦС. |
|
X509Certificate |
Сведения о сертификате X509. |
| X509Certificates |
Первичные и вторичные сертификаты |
|
X509Certificate |
Сведения о сертификате и сертификате |
AttestationMechanism
Механизм аттестации для individualEnrollment и enrollmentGroup.
| Имя | Тип | Описание |
|---|---|---|
| symmetricKey |
Аттестация с помощью SymmetricKey. |
|
| tpm |
Аттестация через TPM. |
|
| type |
enum:
|
Тип аттестации. |
| x509 |
Аттестация через X509. |
CustomAllocationDefinition
Это сообщает DPS, какой веб-перехватчик следует вызывать при использовании пользовательского выделения.
| Имя | Тип | Описание |
|---|---|---|
| apiVersion |
string |
Версия API типов служб подготовки (например, IndividualEnrollment), отправленных в пользовательском запросе на выделение. Минимальная поддерживаемая версия: "2018-09-01-preview". |
| webhookUrl |
string |
URL-адрес веб-перехватчика, используемый для запросов на выделение. |
DeviceCapabilities
Возможности устройств.
| Имя | Тип | Default value | Описание |
|---|---|---|---|
| iotEdge |
boolean |
False |
Если задано значение true, это устройство является устройством IoTEdge. |
EnrollmentGroup
Запись группы регистрации.
| Имя | Тип | Default value | Описание |
|---|---|---|---|
| allocationPolicy |
enum:
|
Политика выделения этого ресурса. Эта политика переопределяет политику распределения на уровне клиента для этой отдельной регистрации или группы регистрации. Возможные значения: hashed: связанные Центры Интернета вещей с одинаковой вероятностью будут подготовлены устройства для них. GeoLatency: устройства подготавливаются к Центру Интернета вещей с наименьшей задержкой на устройстве. Если несколько связанных центров Интернета вещей обеспечивают одинаковую наименьшую задержку, служба подготовки хэширует устройства в этих центрах, "статический" . Спецификация нужного центра Интернета вещей в списке регистрации имеет приоритет над политикой выделения на уровне службы, "пользовательские". Устройства подготавливаются для Центра Интернета вещей на основе вашей собственной пользовательской логики. Служба подготовки передает сведения об устройстве в логику, а логика возвращает нужный Центр Интернета вещей, а также желаемую начальную конфигурацию. Для размещения логики рекомендуется использовать Функции Azure. |
|
| attestation |
Механизм аттестации для individualEnrollment и enrollmentGroup. |
||
| capabilities |
Возможности устройств. |
||
| createdDateTimeUtc |
string |
Дата и время создания этого ресурса. |
|
| customAllocationDefinition |
Это сообщает DPS, какой веб-перехватчик следует вызывать при использовании пользовательского выделения. |
||
| enrollmentGroupId |
string |
Идентификатор группы регистрации. |
|
| etag |
string |
Тег сущности, связанный с ресурсом. |
|
| initialTwin |
Исходный двойник устройства. Содержит подмножество свойств двойника. |
||
| iotHubHostName |
string |
Имя узла Центра Интернета вещей. |
|
| iotHubs |
string[] |
Список Центр Интернета вещей имен узлов, для которых можно выделить устройства в этом ресурсе. Должно быть подмножеством списка центров Интернета вещей на уровне клиента. |
|
| lastUpdatedDateTimeUtc |
string |
Дата и время последнего обновления ресурса. |
|
| provisioningStatus |
enum:
|
enabled |
Состояние подготовки. |
| reprovisionPolicy |
Поведение службы при повторной подготовке устройства в Центре Интернета вещей. |
InitialTwin
Исходный двойник устройства. Содержит подмножество свойств двойника.
| Имя | Тип | Описание |
|---|---|---|
| properties |
Представляет начальные свойства, которые будут заданы для двойника устройства. |
|
| tags |
Представляет коллекцию свойств в двойнику |
InitialTwinProperties
Представляет начальные свойства, которые будут заданы для двойника устройства.
| Имя | Тип | Описание |
|---|---|---|
| desired |
Представляет коллекцию свойств в двойнику |
Metadata
Метаданные для TwinCollection
| Имя | Тип | Описание |
|---|---|---|
| lastUpdated |
string |
Время последнего обновления TwinCollection |
| lastUpdatedVersion |
integer |
Это значение равно NULL для метаданных сообщаемого свойства и не равно NULL для метаданных требуемых свойств. |
ProvisioningServiceErrorDetails
Содержит свойства ошибки, возвращаемые службой подготовки Центр Интернета вещей Azure.
| Имя | Тип | Описание |
|---|---|---|
| errorCode |
integer |
|
| info |
object |
|
| message |
string |
|
| timestampUtc |
string |
|
| trackingId |
string |
ReprovisionPolicy
Поведение службы при повторной подготовке устройства в Центре Интернета вещей.
| Имя | Тип | Default value | Описание |
|---|---|---|---|
| migrateDeviceData |
boolean |
True |
Если задано значение true (по умолчанию), служба подготовки устройств будет переносить данные устройства (двойник, возможности устройства и идентификатор устройства) из одного Центра Интернета вещей в другой во время обновления назначения Центра Интернета вещей. Если задано значение false, служба подготовки устройств сбросит данные устройства до начальной требуемой конфигурации, хранящейся в соответствующем списке регистрации. |
| updateHubAssignment |
boolean |
True |
Если задано значение true (по умолчанию), служба подготовки устройств оценит назначение Центр Интернета вещей устройства и при необходимости обновит его для любых запросов на подготовку, кроме первого от данного устройства. Если задано значение false, устройство останется назначенным текущему Центру Интернета вещей. |
SymmetricKeyAttestation
Аттестация с помощью SymmetricKey.
| Имя | Тип | Описание |
|---|---|---|
| primaryKey |
string |
Первичный симметричный ключ. |
| secondaryKey |
string |
Вторичный симметричный ключ. |
TpmAttestation
Аттестация через TPM.
| Имя | Тип | Описание |
|---|---|---|
| endorsementKey |
string |
|
| storageRootKey |
string |
TwinCollection
Представляет коллекцию свойств в двойнику
| Имя | Тип | Описание |
|---|---|---|
| count |
integer |
Число свойств в Коллекции TwinCollection |
| metadata |
Метаданные для TwinCollection |
|
| version |
integer |
Версия TwinCollection |
X509Attestation
Аттестация через X509.
| Имя | Тип | Описание |
|---|---|---|
| caReferences |
Ссылки на первичный и вторичный ЦС. |
|
| clientCertificates |
Первичные и вторичные сертификаты |
|
| signingCertificates |
Первичные и вторичные сертификаты |
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 |
Сведения о сертификате и сертификате |
|
| secondary |
Сведения о сертификате и сертификате |
X509CertificateWithInfo
Сведения о сертификате и сертификате
| Имя | Тип | Описание |
|---|---|---|
| certificate |
string |
|
| info |
Сведения о сертификате X509. |