Individual Enrollment - Get

서비스:: IoT Hub Device Provisioning Service

API 버전:: 2021-10-01

디바이스 등록 레코드를 가져옵니다.

GET https://{dpsName}.azure-devices-provisioning.net/enrollments/{id}?api-version=2021-10-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
dpsName	path	True	string	DPS 인스턴스 호스트네임입니다.
id	path	True	string	이 ID는 등록의 장치 등록을 고유하게 식별하는 데 사용됩니다. 대소문자 구분 없는 문자열(최대 128자)과 특정 특수 문자로 구성됩니다: . _ -. 시작과 끝에 특수 문자는 허용되지 않습니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
Authorization	True	string

응답

Name	형식	Description
200 OK	IndividualEnrollment	요청이 성공했습니다.
Other Status Codes	ProvisioningServiceErrorDetails	예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string

Name

형식

Description

200 OK

IndividualEnrollment

요청이 성공했습니다.

Other Status Codes

ProvisioningServiceErrorDetails

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

헤더

x-ms-error-code: string

보안

Authorization

형식: apiKey
In(다음 안에): header

예제

IndividualEnrollment_Get_MaximumSet_Gen

IndividualEnrollment_Get_MinimumSet_Gen

IndividualEnrollment_Get_MaximumSet_Gen

샘플 요청

HTTP

GET https://{dpsName}.azure-devices-provisioning.net/enrollments/dtpdffweofjygnjxjegvvvzhpc?api-version=2021-10-01

샘플 응답

상태 코드:: 200

{
  "allocationPolicy": "hashed",
  "attestation": {
    "type": "none",
    "symmetricKey": {
      "primaryKey": "tdoshkmlo",
      "secondaryKey": "lmajoyzuojahffcmdlcwjhntqzyqzk"
    },
    "tpm": {
      "endorsementKey": "naoofgjbxiulcitlysusxdvagyucgn",
      "storageRootKey": "tdgkgcvptrsw"
    },
    "x509": {
      "caReferences": {
        "primary": "efbkbboxkvrsdl",
        "secondary": "vckhuzqgbcinighxwyuyd"
      },
      "clientCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      },
      "signingCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      }
    }
  },
  "capabilities": {
    "iotEdge": true
  },
  "createdDateTimeUtc": "2025-10-01T17:42:04.760Z",
  "customAllocationDefinition": {
    "apiVersion": "gbannxdstouqrfonxdxfurv",
    "webhookUrl": "todqbubyxeumrtvhsscedwrkz"
  },
  "deviceId": "wfgzhrgpvmwddrknnmcggbae",
  "etag": "ngtrmhcikthymtknva",
  "initialTwin": {
    "properties": {
      "desired": {
        "count": 16,
        "key2428": {},
        "metadata": {
          "lastUpdated": "2025-10-01T17:42:04.760Z",
          "lastUpdatedVersion": 19
        },
        "version": 9
      }
    },
    "tags": {
      "count": 16,
      "key2428": {},
      "metadata": {
        "lastUpdated": "2025-10-01T17:42:04.760Z",
        "lastUpdatedVersion": 19
      },
      "version": 9
    }
  },
  "iotHubHostName": "vtewercilhukfboi",
  "iotHubs": [
    "lwgwrfdherfrbowfdbrdhvnragwrs"
  ],
  "lastUpdatedDateTimeUtc": "2025-10-01T17:42:04.760Z",
  "optionalDeviceInformation": {
    "count": 16,
    "key2428": {},
    "metadata": {
      "lastUpdated": "2025-10-01T17:42:04.760Z",
      "lastUpdatedVersion": 19
    },
    "version": 9
  },
  "provisioningStatus": "enabled",
  "registrationId": "kz",
  "registrationState": {
    "assignedHub": "oasugtinnefgfklhldjhibq",
    "createdDateTimeUtc": "2025-10-01T17:42:04.759Z",
    "deviceId": "ttnhaugyyh",
    "errorCode": 2,
    "errorMessage": "ufqpjjmbiphiynoijjbocvl",
    "etag": "ctquvtjyhnomcmtddscxwjk",
    "lastUpdatedDateTimeUtc": "2025-10-01T17:42:04.759Z",
    "payload": {},
    "registrationId": "czvnrxvbka",
    "status": "unassigned",
    "substatus": "initialAssignment"
  },
  "reprovisionPolicy": {
    "migrateDeviceData": true,
    "updateHubAssignment": true
  }
}

IndividualEnrollment_Get_MinimumSet_Gen

샘플 요청

HTTP

GET https://{dpsName}.azure-devices-provisioning.net/enrollments/aro?api-version=2021-10-01

샘플 응답

상태 코드:: 200

{
  "attestation": {
    "type": "none"
  },
  "registrationId": "kz"
}

정의

Name	Description
AllocationPolicy	이 자원의 배분 정책. 이 정책은 이 개별 등록 또는 등록 그룹에 대한 임차인 수준 할당 정책을 우선시합니다. 가능한 값으로는 '해시드'(연결된 IoT 허브는 동일하게 프로비저닝된 장치), 'geoLatency'(기기가 가장 낮은 지연 시간을 가진 IoT 허브에 프로비저닝됨)가 있습니다. 여러 개의 연결된 IoT 허브가 동일한 최소 지연 시간을 제공한다면, 프로비저닝 서비스는 해당 허브 간 기기 해시를 '정적' : 등록 목록에서 원하는 IoT 허브 명세가 서비스 수준 할당 정책보다 우선합니다. 'custom': 기기가 사용자 맞춤형 로직에 따라 IoT 허브에 할당됩니다. 프로비저닝 서비스는 장치에 대한 정보를 로직에 전달하고, 로직은 원하는 IoT 허브와 원하는 초기 구성을 반환합니다. 로직을 호스팅할 때 Azure Functions를 사용하는 것을 권장합니다.
AssignedDeviceSubstatus	'할당된' 장치의 하위 상태. 가능한 값은 다음과 같습니다 - 'initialAssignment': 디바이스가 처음으로 IoT 허브에 할당됨, 'deviceDataMigrated': 디바이스가 다른 IoT 허브에 할당되었고, 기기 데이터가 이전에 할당된 IoT 허브에서 이전되었습니다. 기기 데이터가 이전에 할당된 IoT 허브인 'deviceDataReset'에서 제거되었습니다: 기기가 다른 IoT 허브에 할당되었고, 등록 시 저장된 초기 상태에서 기기 데이터가 채워졌습니다. 기기 데이터가 이전에 할당된 IoT 허브 'reprovisionedToInitialAssignment'에서 제거되었습니다: 기기가 이전에 할당된 IoT 허브로 재구성되었습니다.
AttestationMechanism	개인등록과 등록그룹을 위한 인증 메커니즘.
AttestationType	증명 유형.
CustomAllocationDefinition	이 기능은 DPS가 커스텀 할당을 사용할 때 어떤 웹훅을 호출해야 하는지 알려줍니다.
DeviceCapabilities	기기 기능.
DeviceRegistrationState	기기 등록 상태.
EnrollmentStatus	등록 상태.
IndividualEnrollment	기기 등록 기록입니다.
InitialTwin	초기 장치 쌍둥이. Twin의 성질의 부분집합을 포함합니다.
InitialTwinProperties	장치 쌍둥이에 설정될 초기 속성들을 나타냅니다.
Metadata	트윈컬렉션의 메타데이터
ProvisioningServiceErrorDetails	Azure IoT 허브 프로비저닝 서비스에서 반환된 오류의 속성을 포함합니다.
ProvisioningStatus	프로비저닝 상태.
ReprovisionPolicy	장치가 IoT 허브로 재구성될 때 서비스의 동작.
SymmetricKeyAttestation	SymmetricKey를 통한 증명.
TpmAttestation	TPM을 통한 인증.
TwinCollection	쌍둥이 내의 속성 집합을 나타냅니다
X509Attestation	X509를 통한 증명.
X509CAReferences	주요 및 2차 CA 참고인.
X509CertificateInfo	X509 증명서 정보.
X509Certificates	초등 및 중등 수료증
X509CertificateWithInfo	증명서 및 증명서 정보

AllocationPolicy

열거형

이 자원의 배분 정책. 이 정책은 이 개별 등록 또는 등록 그룹에 대한 임차인 수준 할당 정책을 우선시합니다. 가능한 값으로는 '해시드'(연결된 IoT 허브는 동일하게 프로비저닝된 장치), 'geoLatency'(기기가 가장 낮은 지연 시간을 가진 IoT 허브에 프로비저닝됨)가 있습니다. 여러 개의 연결된 IoT 허브가 동일한 최소 지연 시간을 제공한다면, 프로비저닝 서비스는 해당 허브 간 기기 해시를 '정적' : 등록 목록에서 원하는 IoT 허브 명세가 서비스 수준 할당 정책보다 우선합니다. 'custom': 기기가 사용자 맞춤형 로직에 따라 IoT 허브에 할당됩니다. 프로비저닝 서비스는 장치에 대한 정보를 로직에 전달하고, 로직은 원하는 IoT 허브와 원하는 초기 구성을 반환합니다. 로직을 호스팅할 때 Azure Functions를 사용하는 것을 권장합니다.

값	Description
hashed	해시드
geoLatency	지오레이시(geoLatency)
static	정적
custom	custom

AssignedDeviceSubstatus

열거형

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

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

AttestationMechanism

Object

개인등록과 등록그룹을 위한 인증 메커니즘.

Name	형식	Description
symmetricKey	SymmetricKeyAttestation	대칭키 증명 방법.
tpm	TpmAttestation	TPM 증명 방법.
type	AttestationType	증명 유형.
x509	X509Attestation	X509 증명 방법.

AttestationType

열거형

증명 유형.

값	Description
none	없음
tpm	tpm
x509	x509
symmetricKey	symmetricKey

CustomAllocationDefinition

Object

이 기능은 DPS가 커스텀 할당을 사용할 때 어떤 웹훅을 호출해야 하는지 알려줍니다.

Name	형식	Description
apiVersion	string	맞춤형 할당 요청에서 보내진 프로비저닝 서비스 유형(예: IndividualEnrollment)의 API 버전입니다. 최소 지원 버전: "2018-09-01-preview".
webhookUrl	string	할당 요청에 사용되는 웹훅 URL.

DeviceCapabilities

Object

기기 기능.

Name	형식	Default value	Description
iotEdge	boolean	False	true로 설정하면 이 장치는 IoTEdge 장치입니다.

DeviceRegistrationState

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 허브로 재구성되었습니다.

EnrollmentStatus

열거형

등록 상태.

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

IndividualEnrollment

Object

기기 등록 기록입니다.

Name	형식	Default value	Description
allocationPolicy	AllocationPolicy		이 자원의 배분 정책. 이 정책은 이 개별 등록 또는 등록 그룹에 대한 임차인 수준 할당 정책을 우선시합니다. 가능한 값으로는 '해시드'(연결된 IoT 허브는 동일하게 프로비저닝된 장치), 'geoLatency'(기기가 가장 낮은 지연 시간을 가진 IoT 허브에 프로비저닝됨)가 있습니다. 여러 개의 연결된 IoT 허브가 동일한 최소 지연 시간을 제공한다면, 프로비저닝 서비스는 해당 허브 간 기기 해시를 '정적' : 등록 목록에서 원하는 IoT 허브 명세가 서비스 수준 할당 정책보다 우선합니다. 'custom': 기기가 사용자 맞춤형 로직에 따라 IoT 허브에 할당됩니다. 프로비저닝 서비스는 장치에 대한 정보를 로직에 전달하고, 로직은 원하는 IoT 허브와 원하는 초기 구성을 반환합니다. 로직을 호스팅할 때 Azure Functions를 사용하는 것을 권장합니다.
attestation	AttestationMechanism		기기에서 사용하는 인증(attestation) 방식입니다.
capabilities	DeviceCapabilities		기기의 기능.
createdDateTimeUtc	string (date-time)		이 자료는 DateTime에서 만들어졌습니다.
customAllocationDefinition	CustomAllocationDefinition		이 기능은 DPS가 커스텀 할당을 사용할 때 어떤 웹훅을 호출해야 하는지 알려줍니다.
deviceId	string		원하는 IoT 허브 장치 ID (선택 사항).
etag	string		자원과 연관된 엔터티 태그입니다.
initialTwin	InitialTwin		초기 장치 쌍둥이.
iotHubHostName	string		Iot Hub 호스트 이름입니다.
iotHubs	string[]		이 리소스 내 장치들이 할당될 수 있는 IoT 허브 호스트네임 목록입니다. 테넌트 레벨 IoT 허브 목록의 일부일 겁니다.
lastUpdatedDateTimeUtc	string (date-time)		이 자료가 마지막으로 업데이트된 날짜 시간입니다.
optionalDeviceInformation	TwinCollection		선택 장치 정보.
provisioningStatus	ProvisioningStatus	enabled	프로비저닝 상태.
registrationId	string		이 ID는 등록의 장치 등록을 고유하게 식별하는 데 사용됩니다. 대소문자 구분 없는 문자열(최대 128자)과 특정 특수 문자로 구성됩니다: . _ -. 시작과 끝에 특수 문자는 허용되지 않습니다.
registrationState	DeviceRegistrationState		현재 등록 상태.
reprovisionPolicy	ReprovisionPolicy		장치가 IoT 허브로 재구성될 때의 동작입니다.

InitialTwin

Object

초기 장치 쌍둥이. Twin의 성질의 부분집합을 포함합니다.

Name	형식	Description
properties	InitialTwinProperties	원하는 속성을 쌍으로 만듭니다.
tags	TwinCollection	쌍 태그입니다.

InitialTwinProperties

Object

장치 쌍둥이에 설정될 초기 속성들을 나타냅니다.

Name	형식	Description
desired	TwinCollection	InitialTwin이 원하는 속성을 얻고 설정합니다.

Metadata

Object

트윈컬렉션의 메타데이터

Name	형식	Description
lastUpdated	string (date-time)	지난번 트윈컬렉션이 업데이트되었을 때
lastUpdatedVersion	integer (int32)	보고된 속성 메타데이터에는 null이며, 원하는 속성 메타데이터에는 null이 아닙니다.

ProvisioningServiceErrorDetails

Object

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

Name	형식	Description
errorCode	integer (int32)	작업 오류 코드.
info	object	문자열 사전 <>
message	string	사람이 읽을 수 있는 오류 메시지.
timestampUtc	string (date-time)	오류 발생 시 UTC 타임스탬프.
trackingId	string	오류 추적 ID입니다.

ProvisioningStatus

열거형

프로비저닝 상태.

값	Description
enabled	enabled
disabled	비활성화됨

ReprovisionPolicy

Object

장치가 IoT 허브로 재구성될 때 서비스의 동작.

Name	형식	Default value	Description
migrateDeviceData	boolean	True	기본값으로 설정하면, 디바이스 프로비저닝 서비스는 IoT 허브 할당 업데이트 시 기기의 데이터(쌍, 디바이스 기능, 디바이스 ID)를 한 IoT 허브에서 다른 허브로 이전합니다. false로 설정하면 장치 프로비저닝 서비스는 해당 등록 목록에 저장된 초기 원하는 구성으로 장치 데이터를 초기화합니다.
updateHubAssignment	boolean	True	기본값으로 설정하면 장치 프로비저닝 서비스는 장치의 IoT 허브 할당을 평가하고, 해당 장치에서 첫 번째 프로비저닝 요청 이후에 대해 필요 시 이를 업데이트합니다. false로 설정하면 기기는 현재 IoT 허브에 계속 할당됩니다.

SymmetricKeyAttestation

Object

SymmetricKey를 통한 증명.

Name	형식	Description
primaryKey	string	기본 대칭 키.
secondaryKey	string	보조 대칭 키.

TpmAttestation

Object

TPM을 통한 인증.

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

TwinCollection

Object

쌍둥이 내의 속성 집합을 나타냅니다

Name	형식	Description
count	integer (int32)	트윈컬렉션의 속성 수
metadata	Metadata	트윈컬렉션의 메타데이터
version	integer (int32)	트윈컬렉션 버전

X509Attestation

Object

X509를 통한 증명.

Name	형식	Description
caReferences	X509CAReferences	주요 및 2차 CA 참고인.
clientCertificates	X509Certificates	초등 및 중등 수료증
signingCertificates	X509Certificates	초등 및 중등 수료증

X509CAReferences

Object

주요 및 2차 CA 참고인.

Name	형식	Description
primary	string	캘리포니아 주 참고 자료입니다.
secondary	string	캘리포니아 2차 참고 자료입니다.

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)	증명서 버전.

X509Certificates

Object

초등 및 중등 수료증

Name	형식	Description
primary	X509CertificateWithInfo	증명서 및 증명서 정보
secondary	X509CertificateWithInfo	증명서 및 증명서 정보

X509CertificateWithInfo

Object

증명서 및 증명서 정보

Name	형식	Description
certificate	string	PEM 형식의 인증서 문자열.
info	X509CertificateInfo	X509 증명서 정보.