Поделиться через

Enrollment Group - Query

  • Ссылка
Служба:
IoT Hub Device Provisioning Service
Версия API:
2021-10-01

Запрос групп регистрации устройств.

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

Параметры URI

Имя В Обязательно Тип Описание
api-version
 query True

string

Версия API, используемая для запроса. Поддерживаемые версии: 2021-10-01

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-max-item-count

integer (int32)

Размер страницы
x-ms-continuation

string

Маркер продолжения

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

Имя Обязательно Тип Описание
query True

string

Ответы

Имя Тип Описание
200 OK

EnrollmentGroup[]

Успех

Заголовки

  • x-ms-continuation: string
  • x-ms-max-item-count: integer
  • x-ms-item-type: string
Other Status Codes

ProvisioningServiceErrorDetails

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

Заголовки

x-ms-error-code: string

Определения

Имя Описание
AttestationMechanism

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

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

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

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

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

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

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

Содержит свойства ошибки, возвращаемой службой подготовки Центра Интернета вещей Azure.
QuerySpecification
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.

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.

EnrollmentGroup

Object

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

Имя Тип Default value Описание
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

Политика выделения этого ресурса. Эта политика переопределяет политику распределения на уровне клиента для этой отдельной группы регистрации или регистрации. Возможные значения включают "хэшированные": связанные центры Интернета вещей также могут иметь устройства, подготовленные для них, "geoLatency": устройства подготавливаются к центру Интернета вещей с наименьшей задержкой на устройстве. Если несколько связанных центров Интернета вещей обеспечивают ту же самую низкую задержку, службы подготовки хэшируют устройства в этих центрах, "статический": спецификация нужного Центра Интернета вещей в списке регистрации имеет приоритет над политикой выделения уровня обслуживания, "custom": устройства подготавливаются к центру Интернета вещей на основе собственной пользовательской логики. Служба подготовки передает сведения об устройстве в логику, а логика возвращает нужный центр Интернета вещей, а также нужную начальную конфигурацию. Мы рекомендуем использовать Функции Azure для размещения логики.
attestation

AttestationMechanism

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

DeviceCapabilities

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

string (date-time)

Был создан ресурс DateTime.
customAllocationDefinition

CustomAllocationDefinition

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

string

minLength: 1

Идентификатор группы регистрации.
etag

string

Тег сущности, связанный с ресурсом.
initialTwin

InitialTwin

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

string

Имя узла Центра Интернета вещей.
iotHubs

string[]

Список узлов Центра Интернета вещей, для которых можно выделить устройства в этом ресурсе. Должен быть подмножеством списка центров Интернета вещей на уровне клиента.
lastUpdatedDateTimeUtc

string (date-time)

Дата и время последнего обновления ресурса.
provisioningStatus enum:
  • disabled
  • enabled
enabled

Состояние подготовки.
reprovisionPolicy

ReprovisionPolicy

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

InitialTwin

Object

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

Имя Тип Описание
properties

InitialTwinProperties

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

TwinCollection

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

InitialTwinProperties

Object

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

Имя Тип Описание
desired

TwinCollection

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

Metadata

Object

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

Имя Тип Описание
lastUpdated

string (date-time)

Последнее обновление TwinCollection
lastUpdatedVersion

integer (int64)

Это значение NULL для метаданных сообщаемых свойств и не имеет значения NULL для требуемых метаданных свойств.

ProvisioningServiceErrorDetails

Object

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

Имя Тип Описание
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

QuerySpecification

Object
Имя Тип Описание
query

string

ReprovisionPolicy

Object

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

Имя Тип Default value Описание
migrateDeviceData

boolean

True

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

boolean

True

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

SymmetricKeyAttestation

Object

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

Имя Тип Описание
primaryKey

string

Первичный симметричный ключ.
secondaryKey

string

Вторичный симметричный ключ.

TpmAttestation

Object

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

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

string

storageRootKey

string

TwinCollection

Object

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

Имя Тип Описание
count

integer

Количество свойств в TwinCollection
metadata

Metadata

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

integer (int64)

Версия TwinCollection

X509Attestation

Object

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

Имя Тип Описание
caReferences

X509CAReferences

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

X509Certificates

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

X509Certificates

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

X509CAReferences

Object

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

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

string

secondary

string

X509CertificateInfo

Object

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

Имя Тип Описание
issuerName

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

X509Certificates

Object

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

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

X509CertificateWithInfo

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

X509CertificateWithInfo

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

X509CertificateWithInfo

Object

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

Имя Тип Описание
certificate

string

info

X509CertificateInfo

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