다음을 통해 공유

Device Registration State - Query

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

이 enrollmentGroup에 있는 디바이스의 등록 상태를 가져옵니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
id
 path True

string

등록 그룹 ID입니다.
api-version
 query True

string

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

요청 헤더

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

integer

int32

pageSize
x-ms-continuation

string

연속 토큰

응답

Name 형식 Description
200 OK

DeviceRegistrationState[]

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
DeviceRegistrationState

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

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

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로 다시 프로비전되었습니다.

ProvisioningServiceErrorDetails

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

Name 형식 Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string