다음을 통해 공유

Individual Enrollment - Query

  • 참조
서비스:
IoT Hub Device Provisioning Service
API 버전:
2021-10-01

디바이스 등록 레코드를 쿼리합니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
api-version
 query True

string

요청에 사용할 API 버전입니다. 지원되는 버전은 2021-10-01입니다.

요청 헤더

Name 필수 형식 Description
x-ms-max-item-count

integer

int32

페이지 크기
x-ms-continuation

string

Continuation token(연속 토큰)

요청 본문

Name 필수 형식 Description
query True

string

응답

Name 형식 Description
200 OK

IndividualEnrollment[]

Success

헤더

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

ProvisioningServiceErrorDetails

오류 응답

헤더

x-ms-error-code: string

정의

Name Description
AttestationMechanism

등록 그룹뿐만 아니라 individualEnrollment에 대한 증명 메커니즘입니다.
CustomAllocationDefinition

그러면 사용자 지정 할당을 사용할 때 호출할 웹후크를 DPS에 알립니다.
DeviceCapabilities

디바이스 기능.
DeviceRegistrationState

디바이스 등록 상태입니다.
IndividualEnrollment

디바이스 등록 레코드입니다.
InitialTwin

초기 디바이스 쌍. 트윈 속성의 하위 집합을 포함합니다.
InitialTwinProperties

디바이스 쌍에서 설정할 초기 속성을 나타냅니다.
Metadata

TwinCollection에 대한 메타데이터
ProvisioningServiceErrorDetails

Azure IoT Hub Provisioning Service에서 반환한 오류의 속성을 포함합니다.
QuerySpecification
ReprovisionPolicy

디바이스가 IoT Hub에 다시 프로비전될 때의 서비스 동작입니다.
SymmetricKeyAttestation

SymmetricKey를 통한 증명.
TpmAttestation

TPM을 통한 증명.
TwinCollection

트윈 내의 속성 컬렉션을 나타냅니다.
X509Attestation

X509를 통한 증명.
X509CAReferences

기본 및 보조 CA 참조.
X509CertificateInfo

X509 인증서 정보입니다.
X509Certificates

기본 및 보조 인증서
X509CertificateWithInfo

인증서 및 인증서 정보

AttestationMechanism

등록 그룹뿐만 아니라 individualEnrollment에 대한 증명 메커니즘입니다.

Name 형식 Description
symmetricKey

SymmetricKeyAttestation

SymmetricKey를 통한 증명.
tpm

TpmAttestation

TPM을 통한 증명.
type enum:
  • none
  • symmetricKey
  • tpm
  • x509

증명 유형입니다.
x509

X509Attestation

X509를 통한 증명.

CustomAllocationDefinition

그러면 사용자 지정 할당을 사용할 때 호출할 웹후크를 DPS에 알립니다.

Name 형식 Description
apiVersion

string

사용자 지정 할당 요청에서 전송된 프로비저닝 서비스 유형의 API 버전(예: IndividualEnrollment)입니다. 지원되는 최소 버전: "2018-09-01-preview".
webhookUrl

string

할당 요청에 사용되는 웹후크 URL입니다.

DeviceCapabilities

디바이스 기능.

Name 형식 Default value Description
iotEdge

boolean

False

true로 설정하면 이 디바이스는 IoTEdge 디바이스입니다.

DeviceRegistrationState

디바이스 등록 상태입니다.

Name 형식 Description
assignedHub

string

할당된 Azure IoT Hub.
createdDateTimeUtc

string

등록 생성 날짜 시간(UTC)입니다.
deviceId

string

Device ID
errorCode

integer

오류 코드
errorMessage

string

오류 메시지입니다.
etag

string

리소스와 연결된 엔터티 태그입니다.
lastUpdatedDateTimeUtc

string

마지막으로 업데이트된 날짜 시간(UTC)입니다.
payload

object

registrationId

string

이 ID는 등록의 디바이스 등록을 고유하게 식별하는 데 사용됩니다. 영숫자 문자와 특정 특수 문자인 의 대/소문자를 구분하지 않는 문자열(최대 128자 길이)입니다. _ -. 시작 또는 끝에서 특수 문자가 허용되지 않습니다.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

등록 상태.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

'할당된' 디바이스에 대한 하위 상태입니다. 가능한 값으로는 'initialAssignment': 디바이스가 처음으로 IoT Hub에 할당되었습니다. 'deviceDataMigrated': 디바이스가 다른 IoT Hub에 할당되었으며 디바이스 데이터가 이전에 할당된 IoT Hub에서 마이그레이션되었습니다. 디바이스 데이터가 이전에 할당된 IoT Hub 'deviceDataReset'에서 제거되었습니다. 디바이스가 다른 IoT Hub에 할당되었으며 해당 디바이스 데이터가 등록에 저장된 초기 상태에서 채워졌습니다. 디바이스 데이터가 이전에 할당된 IoT Hub 'reprovisionedToInitialAssignment'에서 제거되었습니다. 디바이스가 이전에 할당된 IoT Hub로 다시 프로비전되었습니다.

IndividualEnrollment

디바이스 등록 레코드입니다.

Name 형식 Default value Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

이 리소스의 할당 정책입니다. 이 정책은 이 개별 등록 또는 등록 그룹에 대한 테넌트 수준 할당 정책을 재정의합니다. 가능한 값으로는 '해시됨'이 포함됩니다. 연결된 IoT Hub는 디바이스가 프로비전될 가능성이 높습니다. 'geoLatency': 디바이스의 대기 시간이 가장 짧은 IoT Hub에 디바이스가 프로비전됩니다. 연결된 여러 IoT Hub가 동일한 최저 대기 시간을 제공하는 경우 프로비전 서비스는 해당 허브에서 디바이스를 해시합니다. 'static' : 등록 목록에서 원하는 IoT Hub의 사양은 서비스 수준 할당 정책인 'custom': 디바이스가 사용자 고유의 사용자 지정 논리에 따라 IoT Hub에 프로비전됩니다. 프로비저닝 서비스는 디바이스에 대한 정보를 논리에 전달하고 논리는 원하는 IoT 허브와 원하는 초기 구성을 반환합니다. Azure Functions 사용하여 논리를 호스트하는 것이 좋습니다.
attestation

AttestationMechanism

등록 그룹뿐만 아니라 individualEnrollment에 대한 증명 메커니즘입니다.
capabilities

DeviceCapabilities

디바이스 기능.
createdDateTimeUtc

string

이 리소스가 만들어진 DateTime입니다.
customAllocationDefinition

CustomAllocationDefinition

그러면 사용자 지정 할당을 사용할 때 호출할 웹후크를 DPS에 알립니다.
deviceId

string

원하는 IoT Hub 디바이스 ID(선택 사항)입니다.
etag

string

리소스와 연결된 엔터티 태그입니다.
initialTwin

InitialTwin

초기 디바이스 쌍. 트윈 속성의 하위 집합을 포함합니다.
iotHubHostName

string

IoT Hub 호스트 이름입니다.
iotHubs

string[]

이 리소스의 디바이스를 할당할 수 있는 IoT Hub 호스트 이름 목록입니다. IoT Hub의 테넌트 수준 목록의 하위 집합이어야 합니다.
lastUpdatedDateTimeUtc

string

이 리소스가 마지막으로 업데이트된 DateTime입니다.
optionalDeviceInformation

TwinCollection

트윈 내의 속성 컬렉션을 나타냅니다.
provisioningStatus enum:
  • disabled
  • enabled
enabled

프로비전 상태.
registrationId

string

이 ID는 등록의 디바이스 등록을 고유하게 식별하는 데 사용됩니다. 영숫자 문자와 특정 특수 문자인 의 대/소문자를 구분하지 않는 문자열(최대 128자 길이)입니다. _ -. 시작 또는 끝에서 특수 문자가 허용되지 않습니다.
registrationState

DeviceRegistrationState

디바이스 등록 상태입니다.
reprovisionPolicy

ReprovisionPolicy

디바이스가 IoT Hub에 다시 프로비전될 때의 서비스 동작입니다.

InitialTwin

초기 디바이스 쌍. 트윈 속성의 하위 집합을 포함합니다.

Name 형식 Description
properties

InitialTwinProperties

디바이스 쌍에서 설정할 초기 속성을 나타냅니다.
tags

TwinCollection

트윈 내의 속성 컬렉션을 나타냅니다.

InitialTwinProperties

디바이스 쌍에서 설정할 초기 속성을 나타냅니다.

Name 형식 Description
desired

TwinCollection

트윈 내의 속성 컬렉션을 나타냅니다.

Metadata

TwinCollection에 대한 메타데이터

Name 형식 Description
lastUpdated

string

TwinCollection이 마지막으로 업데이트된 시간
lastUpdatedVersion

integer

보고된 속성 메타데이터의 경우 null이고 원하는 속성 메타데이터의 경우 null이 아닙니다.

ProvisioningServiceErrorDetails

Azure IoT Hub Provisioning Service에서 반환한 오류의 속성을 포함합니다.

Name 형식 Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

QuerySpecification

Name 형식 Description
query

string

ReprovisionPolicy

디바이스가 IoT Hub에 다시 프로비전될 때의 서비스 동작입니다.

Name 형식 Default value Description
migrateDeviceData

boolean

True

true(기본값)로 설정하면 Device Provisioning Service는 IoT Hub 할당 업데이트 중에 디바이스의 데이터(쌍, 디바이스 기능 및 디바이스 ID)를 한 IoT Hub에서 다른 IoT Hub로 마이그레이션합니다. false로 설정하면 Device Provisioning Service는 디바이스의 데이터를 해당 등록 목록에 저장된 초기 원하는 구성으로 다시 설정합니다.
updateHubAssignment

boolean

True

true(기본값)로 설정하면 Device Provisioning Service는 디바이스의 IoT Hub 할당을 평가하고 지정된 디바이스의 첫 번째 이외의 프로비저닝 요청에 필요한 경우 업데이트합니다. false로 설정하면 디바이스가 현재 IoT Hub에 할당된 상태로 유지됩니다.

SymmetricKeyAttestation

SymmetricKey를 통한 증명.

Name 형식 Description
primaryKey

string

기본 대칭 키입니다.
secondaryKey

string

보조 대칭 키입니다.

TpmAttestation

TPM을 통한 증명.

Name 형식 Description
endorsementKey

string

storageRootKey

string

TwinCollection

트윈 내의 속성 컬렉션을 나타냅니다.

Name 형식 Description
count

integer

TwinCollection의 속성 수
metadata

Metadata

TwinCollection에 대한 메타데이터
version

integer

TwinCollection 버전

X509Attestation

X509를 통한 증명.

Name 형식 Description
caReferences

X509CAReferences

기본 및 보조 CA 참조.
clientCertificates

X509Certificates

기본 및 보조 인증서
signingCertificates

X509Certificates

기본 및 보조 인증서

X509CAReferences

기본 및 보조 CA 참조.

Name 형식 Description
primary

string

secondary

string

X509CertificateInfo

X509 인증서 정보입니다.

Name 형식 Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509Certificates

기본 및 보조 인증서

Name 형식 Description
primary

X509CertificateWithInfo

인증서 및 인증서 정보
secondary

X509CertificateWithInfo

인증서 및 인증서 정보

X509CertificateWithInfo

인증서 및 인증서 정보

Name 형식 Description
certificate

string

info

X509CertificateInfo

X509 인증서 정보입니다.