Runtime Registration - Register Device

Service:

IoT Hub Device Provisioning Service

API Version:

2021-06-01

디바이스를 등록합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
idScope	path	True	string
registrationId	path	True	string	등록 ID는 영숫자, 소문자이며 하이픈을 포함할 수 있습니다.
api-version	query	True	string	요청에 사용할 API 버전입니다. 지원되는 버전은 2021-06-01입니다.

요청 본문

Name	형식	Description
payload	object	사용자 지정 할당 페이로드.
registrationId	string	등록 ID는 영숫자 문자와 특정 특수 문자인 의 대/소문자를 구분하지 않는 문자열(최대 128자 길이)입니다. _ -. 시작 또는 종료 시 특수 문자가 허용되지 않습니다.
tpm	TpmAttestation	Tpm.

응답

Name	형식	Description
200 OK	RegistrationOperationStatus	Success
202 Accepted	RegistrationOperationStatus	성공 Headers Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	오류 응답

정의

Name	Description
DeviceRegistration	장치 등록.
DeviceRegistrationResult	디바이스 등록 결과입니다.
ProvisioningServiceErrorDetails	Azure IoT Hub Provisioning Service에서 반환된 오류의 속성을 포함합니다.
RegistrationOperationStatus	등록 작업 상태.
SymmetricKeyRegistrationResult	SymmetricKey 증명을 사용할 때 반환되는 등록 결과입니다.
TpmAttestation	TPM을 통한 증명.
TpmRegistrationResult	TPM 등록 결과입니다.
X509CertificateInfo	X509 인증서 정보입니다.
X509RegistrationResult	X509 등록 결과입니다.

DeviceRegistration

장치 등록.

Name	형식	Description
payload	object	사용자 지정 할당 페이로드.
registrationId	string	등록 ID는 영숫자 문자와 특정 특수 문자인 의 대/소문자를 구분하지 않는 문자열(최대 128자 길이)입니다. _ -. 시작 또는 종료 시 특수 문자가 허용되지 않습니다.
tpm	TpmAttestation	Tpm.

DeviceRegistrationResult

디바이스 등록 결과입니다.

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는 영숫자, 소문자이며 하이픈을 포함할 수 있습니다.
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로 다시 프로비전되었습니다.
symmetricKey	SymmetricKeyRegistrationResult	SymmetricKey 증명을 사용할 때 반환되는 등록 결과입니다.
tpm	TpmRegistrationResult	TPM 증명을 사용할 때 반환되는 등록 결과입니다.
x509	X509RegistrationResult	X509 증명을 사용할 때 반환된 등록 결과입니다.

ProvisioningServiceErrorDetails

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

Name	형식	Description
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

RegistrationOperationStatus

등록 작업 상태.

Name	형식	Description
operationId	string	작업 ID입니다.
registrationState	DeviceRegistrationResult	디바이스 등록 상태.
status	enum: assigned assigning disabled failed unassigned	디바이스 등록 상태.

SymmetricKeyRegistrationResult

SymmetricKey 증명을 사용할 때 반환되는 등록 결과입니다.

Name	형식	Description
enrollmentGroupId	string

TpmAttestation

TPM을 통한 증명.

Name	형식	Description
endorsementKey	string
storageRootKey	string

TpmRegistrationResult

TPM 등록 결과입니다.

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

X509CertificateInfo

X509 인증서 정보입니다.

Name	형식	Description
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509RegistrationResult

X509 등록 결과입니다.

Name	형식	Description
certificateInfo	X509CertificateInfo	X509 인증서 정보입니다.
enrollmentGroupId	string
signingCertificateInfo	X509CertificateInfo	X509 인증서 정보입니다.