Runtime Registration - Register Device

서비스:: IoT Hub Device Provisioning Service

API 버전:: 2021-10-01

기기를 등록합니다.

PUT https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}/register?api-version=2021-10-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
idScope	path	True	string	DPS 인스턴스의 범위.
registrationId	path	True	string	등록 ID는 영숫자, 소문자 형식이며 하이픈을 포함할 수 있습니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
payload		모든 개체
registrationId	string	등록 ID는 대문자 구분 없는 문자열(최대 128자)로, 영숫자 문자와 특정 특수 문자로 구성됩니다: . _ -. 시작과 끝에 특수 문자는 허용되지 않습니다.
tpm	TpmAttestation	TPM을 통한 인증.

응답

Name	형식	Description
200 OK	RegistrationOperationStatus	요청이 성공했습니다.
202 Accepted	RegistrationOperationStatus	처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다. 헤더 Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string

Name

형식

Description

200 OK

RegistrationOperationStatus

요청이 성공했습니다.

202 Accepted

RegistrationOperationStatus

처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

헤더

Location: string
retry-after: integer

Other Status Codes

ProvisioningServiceErrorDetails

예기치 않은 오류 응답입니다.

헤더

x-ms-error-code: string

예제

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

샘플 요청

HTTP

PUT https://global.azure-devices-provisioning.net/ofvgihmgllfsmm/registrations/macgmlbhpb/register?api-version=2021-10-01

{
  "payload": {},
  "registrationId": "qypnuerjeunzogqdezhjgisfr",
  "tpm": {
    "endorsementKey": "sbvvzftylrpsetexcmnijtdezppq",
    "storageRootKey": "juohyrayid"
  }
}

샘플 응답

상태 코드:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi",
  "registrationState": {
    "assignedHub": "ljexps",
    "createdDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "deviceId": "hjvdlwpugzlk",
    "errorCode": 13,
    "errorMessage": "zpctqazbkbiqjkwosis",
    "etag": "hjtelksspyfzhmet",
    "lastUpdatedDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "payload": {},
    "registrationId": "urejrffpkqneou",
    "status": "unassigned",
    "substatus": "initialAssignment",
    "symmetricKey": {
      "enrollmentGroupId": "w"
    },
    "tpm": {
      "authenticationKey": "sofbxakhjrxpiyysjjxkx"
    },
    "x509": {
      "certificateInfo": {
        "issuerName": "pvpbipnhcahytrcq",
        "notAfterUtc": "2025-10-01T17:41:56.534Z",
        "notBeforeUtc": "2025-10-01T17:41:56.534Z",
        "serialNumber": "jjvdijgwgpagrjdi",
        "sha1Thumbprint": "guqltcfgusf",
        "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
        "subjectName": "jtsfqnbcmmott",
        "version": 20
      },
      "enrollmentGroupId": "qbw",
      "signingCertificateInfo": {
        "issuerName": "pvpbipnhcahytrcq",
        "notAfterUtc": "2025-10-01T17:41:56.534Z",
        "notBeforeUtc": "2025-10-01T17:41:56.534Z",
        "serialNumber": "jjvdijgwgpagrjdi",
        "sha1Thumbprint": "guqltcfgusf",
        "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
        "subjectName": "jtsfqnbcmmott",
        "version": 20
      }
    }
  },
  "status": "unassigned"
}

상태 코드:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi",
  "registrationState": {
    "assignedHub": "ljexps",
    "createdDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "deviceId": "hjvdlwpugzlk",
    "errorCode": 13,
    "errorMessage": "zpctqazbkbiqjkwosis",
    "etag": "hjtelksspyfzhmet",
    "lastUpdatedDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "payload": {},
    "registrationId": "urejrffpkqneou",
    "status": "unassigned",
    "substatus": "initialAssignment",
    "symmetricKey": {
      "enrollmentGroupId": "w"
    },
    "tpm": {
      "authenticationKey": "sofbxakhjrxpiyysjjxkx"
    },
    "x509": {
      "certificateInfo": {
        "issuerName": "pvpbipnhcahytrcq",
        "notAfterUtc": "2025-10-01T17:41:56.534Z",
        "notBeforeUtc": "2025-10-01T17:41:56.534Z",
        "serialNumber": "jjvdijgwgpagrjdi",
        "sha1Thumbprint": "guqltcfgusf",
        "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
        "subjectName": "jtsfqnbcmmott",
        "version": 20
      },
      "enrollmentGroupId": "qbw",
      "signingCertificateInfo": {
        "issuerName": "pvpbipnhcahytrcq",
        "notAfterUtc": "2025-10-01T17:41:56.534Z",
        "notBeforeUtc": "2025-10-01T17:41:56.534Z",
        "serialNumber": "jjvdijgwgpagrjdi",
        "sha1Thumbprint": "guqltcfgusf",
        "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
        "subjectName": "jtsfqnbcmmott",
        "version": 20
      }
    }
  },
  "status": "unassigned"
}

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

샘플 요청

HTTP

PUT https://global.azure-devices-provisioning.net/gwgyqmyyzzzjpjmxml/registrations/tuodrxicixbbekaajxfiyvoxsbe/register?api-version=2021-10-01

{}

샘플 응답

상태 코드:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

상태 코드:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

정의

Name	Description
AssignedDeviceSubstatus	'할당된' 장치의 하위 상태. 가능한 값은 다음과 같습니다 - 'initialAssignment': 디바이스가 처음으로 IoT 허브에 할당됨, 'deviceDataMigrated': 디바이스가 다른 IoT 허브에 할당되었고, 기기 데이터가 이전에 할당된 IoT 허브에서 이전되었습니다. 기기 데이터가 이전에 할당된 IoT 허브인 'deviceDataReset'에서 제거되었습니다: 기기가 다른 IoT 허브에 할당되었고, 등록 시 저장된 초기 상태에서 기기 데이터가 채워졌습니다. 기기 데이터가 이전에 할당된 IoT 허브 'reprovisionedToInitialAssignment'에서 제거되었습니다: 기기가 이전에 할당된 IoT 허브로 재구성되었습니다.
DeviceRegistration	장치 등록.
DeviceRegistrationResult	기기 등록 결과.
EnrollmentStatus	등록 상태.
ProvisioningServiceErrorDetails	Azure IoT 허브 프로비저닝 서비스에서 반환된 오류의 속성을 포함합니다.
RegistrationOperationStatus	등록 운영 상태.
SymmetricKeyRegistrationResult	SymmetricKey 증명을 사용하면 등록 결과가 반환되었습니다.
TpmAttestation	TPM을 통한 인증.
TpmRegistrationResult	TPM 등록 결과.
X509CertificateInfo	X509 증명서 정보.
X509RegistrationResult	X509 등록 결과.

AssignedDeviceSubstatus

열거형

'할당된' 장치의 하위 상태. 가능한 값은 다음과 같습니다 - 'initialAssignment': 디바이스가 처음으로 IoT 허브에 할당됨, 'deviceDataMigrated': 디바이스가 다른 IoT 허브에 할당되었고, 기기 데이터가 이전에 할당된 IoT 허브에서 이전되었습니다. 기기 데이터가 이전에 할당된 IoT 허브인 'deviceDataReset'에서 제거되었습니다: 기기가 다른 IoT 허브에 할당되었고, 등록 시 저장된 초기 상태에서 기기 데이터가 채워졌습니다. 기기 데이터가 이전에 할당된 IoT 허브 'reprovisionedToInitialAssignment'에서 제거되었습니다: 기기가 이전에 할당된 IoT 허브로 재구성되었습니다.

값	Description
initialAssignment	초기 배치
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	재프로비저닝되어 초기 할당

DeviceRegistration

Object

장치 등록.

Name	형식	Description
payload		모든 개체
registrationId	string	등록 ID는 대문자 구분 없는 문자열(최대 128자)로, 영숫자 문자와 특정 특수 문자로 구성됩니다: . _ -. 시작과 끝에 특수 문자는 허용되지 않습니다.
tpm	TpmAttestation	TPM을 통한 인증.

DeviceRegistrationResult

Object

기기 등록 결과.

Name	형식	Description
assignedHub	string	Assigned Azure IoT Hub.
createdDateTimeUtc	string (date-time)	등록 생성일, 시간(UTC).
deviceId	string	디바이스 ID입니다.
errorCode	integer (int32)	오류 코드입니다.
errorMessage	string	오류 메시지입니다.
etag	string	자원과 연관된 엔터티 태그입니다.
lastUpdatedDateTimeUtc	string (date-time)	마지막 업데이트 날짜 시간(UTC 기준).
payload		모든 개체
registrationId	string	이 ID는 등록의 장치 등록을 고유하게 식별하는 데 사용됩니다. 대소문자 구분 없는 문자열(최대 128자)과 특정 특수 문자로 구성됩니다: . _ -. 시작과 끝에 특수 문자는 허용되지 않습니다.
status	EnrollmentStatus	등록 상태.
substatus	AssignedDeviceSubstatus	'할당된' 장치의 하위 상태. 가능한 값은 다음과 같습니다 - 'initialAssignment': 디바이스가 처음으로 IoT 허브에 할당됨, 'deviceDataMigrated': 디바이스가 다른 IoT 허브에 할당되었고, 기기 데이터가 이전에 할당된 IoT 허브에서 이전되었습니다. 기기 데이터가 이전에 할당된 IoT 허브인 'deviceDataReset'에서 제거되었습니다: 기기가 다른 IoT 허브에 할당되었고, 등록 시 저장된 초기 상태에서 기기 데이터가 채워졌습니다. 기기 데이터가 이전에 할당된 IoT 허브 'reprovisionedToInitialAssignment'에서 제거되었습니다: 기기가 이전에 할당된 IoT 허브로 재구성되었습니다.
symmetricKey	SymmetricKeyRegistrationResult	SymmetricKey 증명을 사용하면 등록 결과가 반환되었습니다.
tpm	TpmRegistrationResult	TPM 등록 결과.
x509	X509RegistrationResult	X509 등록 결과.

EnrollmentStatus

열거형

등록 상태.

값	Description
unassigned	할당되지 않음
assigning	할당
assigned	할당됨
failed	실패
disabled	비활성화됨

ProvisioningServiceErrorDetails

Object

Azure IoT 허브 프로비저닝 서비스에서 반환된 오류의 속성을 포함합니다.

Name	형식	Description
errorCode	integer (int32)	숫자 오류 코드입니다.
info	object	문자열 사전 <>
message	string	오류 메시지입니다.
timestampUtc	string (date-time)	오류 타임스탬프 (UTC).
trackingId	string	오류 추적 ID.

RegistrationOperationStatus

Object

등록 운영 상태.

Name	형식	Description
operationId	string minLength: 1	작업 ID입니다.
registrationState	DeviceRegistrationResult	기기 등록 결과.
status	EnrollmentStatus	기기 등록 상태.

SymmetricKeyRegistrationResult

Object

SymmetricKey 증명을 사용하면 등록 결과가 반환되었습니다.

Name	형식	Description
enrollmentGroupId	string	등록 그룹 ID입니다.

TpmAttestation

Object

TPM을 통한 인증.

Name	형식	Description
endorsementKey	string	TPM 추천 키.
storageRootKey	string	TPM 저장소 루트 키.

TpmRegistrationResult

Object

TPM 등록 결과.

Name	형식	Description
authenticationKey	string	암호화된 인증 키.

X509CertificateInfo

Object

X509 증명서 정보.

Name	형식	Description
issuerName	string	인증서 발급자 이름입니다.
notAfterUtc	string (date-time)	인증서 만료일(UTC).
notBeforeUtc	string (date-time)	인증서 유효성 시작일(UTC).
serialNumber	string	증명서 일련번호.
sha1Thumbprint	string	SHA-1 자격증 지문입니다.
sha256Thumbprint	string	증명서의 SHA-256 지문입니다.
subjectName	string	수료증 주제명.
version	integer (int32)	인증서 버전입니다.

X509RegistrationResult

Object

X509 등록 결과.

Name	형식	Description
certificateInfo	X509CertificateInfo	X509 증명서 정보.
enrollmentGroupId	string	등록 그룹 ID입니다.
signingCertificateInfo	X509CertificateInfo	X509 증명서 정보.