Enrollment Group - Get

Layanan:: IoT Hub Device Provisioning Service

Versi API:: 2021-10-01

Dapatkan grup pendaftaran perangkat.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
dpsName	path	True	string	Nama host instans DPS.
id	path	True	string	ID grup pendaftaran.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Authorization	True	string

Respons

Nama	Jenis	Deskripsi
200 OK	EnrollmentGroup	Permintaan telah berhasil.
Other Status Codes	ProvisioningServiceErrorDetails	Respons kesalahan tak terduga. Header x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

EnrollmentGroup

Permintaan telah berhasil.

Other Status Codes

ProvisioningServiceErrorDetails

Respons kesalahan tak terduga.

Header

x-ms-error-code: string

Keamanan

Authorization

Jenis: apiKey
Dalam: header

Contoh

EnrollmentGroup_Get_MaximumSet_Gen

EnrollmentGroup_Get_MinimumSet_Gen

EnrollmentGroup_Get_MaximumSet_Gen

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 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:05.495Z",
  "customAllocationDefinition": {
    "apiVersion": "gbannxdstouqrfonxdxfurv",
    "webhookUrl": "todqbubyxeumrtvhsscedwrkz"
  },
  "enrollmentGroupId": "sfsevlobqfdnqmghunj",
  "etag": "kmvtdrkjyfzj",
  "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": "dey",
  "iotHubs": [
    "ehqilokxpijrvaigiaf"
  ],
  "lastUpdatedDateTimeUtc": "2025-10-01T17:42:05.495Z",
  "provisioningStatus": "enabled",
  "reprovisionPolicy": {
    "migrateDeviceData": true,
    "updateHubAssignment": true
  }
}

EnrollmentGroup_Get_MinimumSet_Gen

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

{
  "attestation": {
    "type": "none"
  },
  "enrollmentGroupId": "sfsevlobqfdnqmghunj"
}

Definisi

Nama	Deskripsi
AllocationPolicy	Kebijakan alokasi sumber daya ini. Kebijakan ini menggantikan kebijakan alokasi tingkat penyewa untuk pendaftaran individu atau grup pendaftaran ini. Nilai yang mungkin termasuk 'hashed': Hub IoT tertaut sama-sama mungkin memiliki perangkat yang disediakan untuk mereka, 'geoLatency': Perangkat disediakan ke hub IoT dengan latensi terendah ke perangkat. Jika beberapa hub IoT tertaut akan memberikan latensi terendah yang sama, layanan provisi melakukan hash perangkat di seluruh hub tersebut, 'statis' : Spesifikasi hub IoT yang diinginkan dalam daftar pendaftaran diprioritaskan atas kebijakan alokasi tingkat layanan, 'kustom': Perangkat disediakan ke hub IoT berdasarkan logika kustom Anda sendiri. Layanan provisi meneruskan informasi tentang perangkat ke logika, dan logika mengembalikan hub IoT yang diinginkan serta konfigurasi awal yang diinginkan. Sebaiknya gunakan Azure Functions untuk menghosting logika Anda.
AttestationMechanism	Mekanisme pengesahan untuk individuPendaftaran serta pendaftaranGroup.
AttestationType	Jenis Pengesahan.
CustomAllocationDefinition	Ini memberi tahu DPS webhook mana yang akan dipanggil saat menggunakan alokasi khusus.
DeviceCapabilities	Kemampuan perangkat.
EnrollmentGroup	Catatan grup pendaftaran.
InitialTwin	Perangkat awal kembar. Berisi bagian dari properti Twin.
InitialTwinProperties	Mewakili properti awal yang akan diatur pada perangkat kembar.
Metadata	Metadata untuk TwinCollection
ProvisioningServiceErrorDetails	Berisi properti kesalahan yang dikembalikan oleh Azure IoT Hub Provisioning Service.
ProvisioningStatus	Status penyediaan.
ReprovisionPolicy	Perilaku layanan saat perangkat disediakan ulang ke hub IoT.
SymmetricKeyAttestation	Pengesahan melalui SymmetricKey.
TpmAttestation	Pengesahan melalui TPM.
TwinCollection	Mewakili kumpulan properti dalam Twin
X509Attestation	Pengesahan melalui X509.
X509CAReferences	Referensi CA primer dan sekunder.
X509CertificateInfo	Info sertifikat X509.
X509Certificates	Sertifikat primer dan sekunder
X509CertificateWithInfo	Info sertifikat dan sertifikat

AllocationPolicy

Enumerasi

Kebijakan alokasi sumber daya ini. Kebijakan ini menggantikan kebijakan alokasi tingkat penyewa untuk pendaftaran individu atau grup pendaftaran ini. Nilai yang mungkin termasuk 'hashed': Hub IoT tertaut sama-sama mungkin memiliki perangkat yang disediakan untuk mereka, 'geoLatency': Perangkat disediakan ke hub IoT dengan latensi terendah ke perangkat. Jika beberapa hub IoT tertaut akan memberikan latensi terendah yang sama, layanan provisi melakukan hash perangkat di seluruh hub tersebut, 'statis' : Spesifikasi hub IoT yang diinginkan dalam daftar pendaftaran diprioritaskan atas kebijakan alokasi tingkat layanan, 'kustom': Perangkat disediakan ke hub IoT berdasarkan logika kustom Anda sendiri. Layanan provisi meneruskan informasi tentang perangkat ke logika, dan logika mengembalikan hub IoT yang diinginkan serta konfigurasi awal yang diinginkan. Sebaiknya gunakan Azure Functions untuk menghosting logika Anda.

Nilai	Deskripsi
hashed	dicincang
geoLatency	geoLatency
static	statik
custom	custom

AttestationMechanism

Objek

Mekanisme pengesahan untuk individuPendaftaran serta pendaftaranGroup.

Nama	Jenis	Deskripsi
symmetricKey	SymmetricKeyAttestation	Metode pengesahan kunci simetris.
tpm	TpmAttestation	Metode pengesahan TPM.
type	AttestationType	Jenis Pengesahan.
x509	X509Attestation	Metode pengesahan X509.

AttestationType

Enumerasi

Jenis Pengesahan.

Nilai	Deskripsi
none	Tidak ada
tpm	Tpm
x509	x509
symmetricKey	kunci simetris

CustomAllocationDefinition

Objek

Ini memberi tahu DPS webhook mana yang akan dipanggil saat menggunakan alokasi khusus.

Nama	Jenis	Deskripsi
apiVersion	string	Versi API dari jenis layanan provisi (seperti IndividualEnrollment) yang dikirim dalam permintaan alokasi kustom. Versi minimum yang didukung: "2018-09-01-preview".
webhookUrl	string	URL webhook yang digunakan untuk permintaan alokasi.

DeviceCapabilities

Objek

Kemampuan perangkat.

Nama	Jenis	Nilai default	Deskripsi
iotEdge	boolean	False	Jika diatur ke true, perangkat ini adalah perangkat IoTEdge.

EnrollmentGroup

Objek

Catatan grup pendaftaran.

Nama	Jenis	Nilai default	Deskripsi
allocationPolicy	AllocationPolicy		Kebijakan alokasi sumber daya ini. Kebijakan ini menggantikan kebijakan alokasi tingkat penyewa untuk pendaftaran individu atau grup pendaftaran ini. Nilai yang mungkin termasuk 'hashed': Hub IoT tertaut sama-sama mungkin memiliki perangkat yang disediakan untuk mereka, 'geoLatency': Perangkat disediakan ke hub IoT dengan latensi terendah ke perangkat. Jika beberapa hub IoT tertaut akan memberikan latensi terendah yang sama, layanan provisi melakukan hash perangkat di seluruh hub tersebut, 'statis' : Spesifikasi hub IoT yang diinginkan dalam daftar pendaftaran diprioritaskan atas kebijakan alokasi tingkat layanan, 'kustom': Perangkat disediakan ke hub IoT berdasarkan logika kustom Anda sendiri. Layanan provisi meneruskan informasi tentang perangkat ke logika, dan logika mengembalikan hub IoT yang diinginkan serta konfigurasi awal yang diinginkan. Sebaiknya gunakan Azure Functions untuk menghosting logika Anda.
attestation	AttestationMechanism		Metode pengesahan yang digunakan oleh perangkat.
capabilities	DeviceCapabilities		Kemampuan perangkat.
createdDateTimeUtc	string (date-time)		DateTime resource ini dibuat.
customAllocationDefinition	CustomAllocationDefinition		Ini memberi tahu DPS webhook mana yang akan dipanggil saat menggunakan alokasi khusus.
enrollmentGroupId	string		ID Grup Pendaftaran.
etag	string		Tag entitas yang terkait dengan sumber daya.
initialTwin	InitialTwin		Perangkat awal kembar.
iotHubHostName	string		Nama host IoT Hub.
iotHubs	string[]		Daftar nama host IoT Hub yang dapat dialokasikan perangkat dalam sumber daya ini. Harus menjadi bagian dari daftar hub IoT tingkat penyewa.
lastUpdatedDateTimeUtc	string (date-time)		DateTime resource ini terakhir diperbarui.
provisioningStatus	ProvisioningStatus	enabled	Status penyediaan.
reprovisionPolicy	ReprovisionPolicy		Perilaku saat perangkat disediakan ulang ke hub IoT.

InitialTwin

Objek

Perangkat awal kembar. Berisi bagian dari properti Twin.

Nama	Jenis	Deskripsi
properties	InitialTwinProperties	Properti yang diinginkan kembar.
tags	TwinCollection	Tag kembar.

InitialTwinProperties

Objek

Mewakili properti awal yang akan diatur pada perangkat kembar.

Nama	Jenis	Deskripsi
desired	TwinCollection	Mendapatkan dan mengatur properti yang diinginkan InitialTwin.

Metadata

Objek

Metadata untuk TwinCollection

Nama	Jenis	Deskripsi
lastUpdated	string (date-time)	Terakhir kali TwinCollection diperbarui
lastUpdatedVersion	integer (int32)	Ini null untuk metadata properti yang dilaporkan dan bukan null untuk metadata properti yang diinginkan.

ProvisioningServiceErrorDetails

Objek

Berisi properti kesalahan yang dikembalikan oleh Azure IoT Hub Provisioning Service.

Nama	Jenis	Deskripsi
errorCode	integer (int32)	Kode kesalahan untuk operasi.
info	object	Kamus< string >
message	string	Pesan kesalahan yang dapat dibaca manusia.
timestampUtc	string (date-time)	Stempel waktu UTC dari kesalahan.
trackingId	string	ID pelacakan untuk kesalahan.

ProvisioningStatus

Enumerasi

Status penyediaan.

Nilai	Deskripsi
enabled	enabled
disabled	dinonaktifkan

ReprovisionPolicy

Objek

Perilaku layanan saat perangkat disediakan ulang ke hub IoT.

Nama	Jenis	Nilai default	Deskripsi
migrateDeviceData	boolean	True	Saat diatur ke true (default), Layanan Provisi Perangkat akan memigrasikan data perangkat (kembar, kemampuan perangkat, dan ID perangkat) dari satu hub IoT ke hub lain selama pembaruan penetapan hub IoT. Jika diatur ke false, Layanan Provisi Perangkat akan mengatur ulang data perangkat ke konfigurasi awal yang diinginkan yang disimpan dalam daftar pendaftaran yang sesuai.
updateHubAssignment	boolean	True	Saat diatur ke true (default), Layanan Provisi Perangkat akan mengevaluasi penetapan IoT Hub perangkat dan memperbaruinya jika perlu untuk permintaan provisi apa pun di luar yang pertama dari perangkat tertentu. Jika diatur ke false, perangkat akan tetap ditetapkan ke hub IoT saat ini.

SymmetricKeyAttestation

Objek

Pengesahan melalui SymmetricKey.

Nama	Jenis	Deskripsi
primaryKey	string	Kunci simetris primer.
secondaryKey	string	Kunci simetris sekunder.

TpmAttestation

Objek

Pengesahan melalui TPM.

Nama	Jenis	Deskripsi
endorsementKey	string	Kunci dukungan TPM.
storageRootKey	string	Kunci akar penyimpanan TPM.

TwinCollection

Objek

Mewakili kumpulan properti dalam Twin

Nama	Jenis	Deskripsi
count	integer (int32)	Jumlah properti di TwinCollection
metadata	Metadata	Metadata untuk TwinCollection
version	integer (int32)	Versi TwinCollection

X509Attestation

Objek

Pengesahan melalui X509.

Nama	Jenis	Deskripsi
caReferences	X509CAReferences	Referensi CA primer dan sekunder.
clientCertificates	X509Certificates	Sertifikat primer dan sekunder
signingCertificates	X509Certificates	Sertifikat primer dan sekunder

X509CAReferences

Objek

Referensi CA primer dan sekunder.

Nama	Jenis	Deskripsi
primary	string	Referensi CA utama.
secondary	string	Referensi CA sekunder.

X509CertificateInfo

Objek

Info sertifikat X509.

Nama	Jenis	Deskripsi
issuerName	string	Nama penerbit sertifikat.
notAfterUtc	string (date-time)	Validitas sertifikat berakhir (UTC).
notBeforeUtc	string (date-time)	Validitas sertifikat dimulai (UTC).
serialNumber	string	Nomor seri sertifikat.
sha1Thumbprint	string	Sidik jari SHA-1 sertifikat.
sha256Thumbprint	string	SHA-256 sidik jari sertifikat.
subjectName	string	Nama subjek sertifikat.
version	integer (int32)	Versi sertifikat.

X509Certificates

Objek

Sertifikat primer dan sekunder

Nama	Jenis	Deskripsi
primary	X509CertificateWithInfo	Info sertifikat dan sertifikat
secondary	X509CertificateWithInfo	Info sertifikat dan sertifikat

X509CertificateWithInfo

Objek

Info sertifikat dan sertifikat

Nama	Jenis	Deskripsi
certificate	string	String sertifikat berformat PEM.
info	X509CertificateInfo	Info sertifikat X509.