Enrollment Group - Create Or Update

Layanan:

IoT Hub Device Provisioning Service

Versi API:

2021-10-01

Create atau perbarui grup pendaftaran perangkat.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
id	path	True	string	ID grup pendaftaran.
api-version	query	True	string	Versi API yang digunakan untuk permintaan. Versi yang didukung meliputi: 2021-10-01

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-Match		string	ETag catatan pendaftaran.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
attestation	True	AttestationMechanism	Mekanisme pengesahan untuk individualEnrollment serta enrollmentGroup.
enrollmentGroupId	True	string	ID Grup Pendaftaran.
allocationPolicy		enum: hashed geoLatency static custom	Kebijakan alokasi sumber daya ini. Kebijakan ini mengambil alih kebijakan alokasi tingkat penyewa untuk grup pendaftaran atau pendaftaran individu ini. Nilai yang mungkin termasuk 'hashed': Hub IoT yang ditautkan kemungkinan sama-sama memiliki perangkat yang disediakan untuk mereka, 'geoLatency': Perangkat diprovisikan ke hub IoT dengan latensi terendah ke perangkat. Jika beberapa hub IoT yang ditautkan akan memberikan latensi terendah yang sama, layanan provisi hash perangkat di seluruh hub tersebut, 'statis' : Spesifikasi hub IoT yang diinginkan dalam daftar pendaftaran lebih diprioritaskan daripada kebijakan alokasi tingkat layanan, 'kustom': Perangkat diprovisikan 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.
capabilities		DeviceCapabilities	Kemampuan perangkat.
customAllocationDefinition		CustomAllocationDefinition	Ini memberi tahu DPS webhook mana yang akan dipanggil saat menggunakan alokasi kustom.
etag		string	Tag entitas yang terkait dengan sumber daya.
initialTwin		InitialTwin	Perangkat kembar awal. Berisi subset properti Twin.
iotHubHostName		string	Nama host Iot Hub.
iotHubs		string[]	Daftar IoT Hub nama host perangkat dalam sumber daya ini dapat dialokasikan. Harus merupakan subset daftar tingkat penyewa hub IoT.
provisioningStatus		enum: enabled disabled	Status provisi.
reprovisionPolicy		ReprovisionPolicy	Perilaku layanan saat perangkat diprovisikan ulang ke hub IoT.

Respons

Nama	Jenis	Deskripsi
200 OK	EnrollmentGroup	Berhasil
Other Status Codes	ProvisioningServiceErrorDetails	Respons kesalahan Header x-ms-error-code: string

Definisi

Nama	Deskripsi
AttestationMechanism	Mekanisme pengesahan untuk individualEnrollment serta enrollmentGroup.
CustomAllocationDefinition	Ini memberi tahu DPS webhook mana yang akan dipanggil saat menggunakan alokasi kustom.
DeviceCapabilities	Kemampuan perangkat.
EnrollmentGroup	Rekaman grup pendaftaran.
InitialTwin	Perangkat kembar awal. Berisi subset properti Twin.
InitialTwinProperties	Mewakili properti awal yang akan diatur pada perangkat kembar.
Metadata	Metadata untuk TwinCollection
ProvisioningServiceErrorDetails	Berisi properti kesalahan yang dikembalikan oleh Layanan Provisi Azure IoT Hub.
ReprovisionPolicy	Perilaku layanan saat perangkat diprovisikan ulang ke hub IoT.
SymmetricKeyAttestation	Pengesahan melalui SymmetricKey.
TpmAttestation	Pengesahan melalui TPM.
TwinCollection	Mewakili kumpulan properti dalam Kembar
X509Attestation	Pengesahan melalui X509.
X509CAReferences	Referensi CA primer dan sekunder.
X509CertificateInfo	Info sertifikat X509.
X509Certificates	Sertifikat primer dan sekunder
X509CertificateWithInfo	Info Sertifikat dan Sertifikat

AttestationMechanism

Mekanisme pengesahan untuk individualEnrollment serta enrollmentGroup.

Nama	Jenis	Deskripsi
symmetricKey	SymmetricKeyAttestation	Pengesahan melalui SymmetricKey.
tpm	TpmAttestation	Pengesahan melalui TPM.
type	enum: none symmetricKey tpm x509	Jenis Pengesahan.
x509	X509Attestation	Pengesahan melalui X509.

CustomAllocationDefinition

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

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

Kemampuan perangkat.

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

EnrollmentGroup

Rekaman grup pendaftaran.

Nama	Jenis	Nilai default	Deskripsi
allocationPolicy	enum: custom geoLatency hashed static		Kebijakan alokasi sumber daya ini. Kebijakan ini mengambil alih kebijakan alokasi tingkat penyewa untuk grup pendaftaran atau pendaftaran individu ini. Nilai yang mungkin termasuk 'hashed': Hub IoT yang ditautkan kemungkinan sama-sama memiliki perangkat yang disediakan untuk mereka, 'geoLatency': Perangkat diprovisikan ke hub IoT dengan latensi terendah ke perangkat. Jika beberapa hub IoT yang ditautkan akan memberikan latensi terendah yang sama, layanan provisi hash perangkat di seluruh hub tersebut, 'statis' : Spesifikasi hub IoT yang diinginkan dalam daftar pendaftaran lebih diprioritaskan daripada kebijakan alokasi tingkat layanan, 'kustom': Perangkat diprovisikan 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		Mekanisme pengesahan untuk individualEnrollment serta enrollmentGroup.
capabilities	DeviceCapabilities		Kemampuan perangkat.
createdDateTimeUtc	string		DateTime sumber daya ini dibuat.
customAllocationDefinition	CustomAllocationDefinition		Ini memberi tahu DPS webhook mana yang akan dipanggil saat menggunakan alokasi kustom.
enrollmentGroupId	string		ID Grup Pendaftaran.
etag	string		Tag entitas yang terkait dengan sumber daya.
initialTwin	InitialTwin		Perangkat kembar awal. Berisi subset properti Twin.
iotHubHostName	string		Nama host Iot Hub.
iotHubs	string[]		Daftar IoT Hub nama host perangkat dalam sumber daya ini dapat dialokasikan. Harus merupakan subset daftar tingkat penyewa hub IoT.
lastUpdatedDateTimeUtc	string		DateTime sumber daya ini terakhir diperbarui.
provisioningStatus	enum: disabled enabled	enabled	Status provisi.
reprovisionPolicy	ReprovisionPolicy		Perilaku layanan saat perangkat diprovisikan ulang ke hub IoT.

InitialTwin

Perangkat kembar awal. Berisi subset properti Twin.

Nama	Jenis	Deskripsi
properties	InitialTwinProperties	Mewakili properti awal yang akan diatur pada perangkat kembar.
tags	TwinCollection	Mewakili kumpulan properti dalam Kembar

InitialTwinProperties

Mewakili properti awal yang akan diatur pada perangkat kembar.

Nama	Jenis	Deskripsi
desired	TwinCollection	Mewakili kumpulan properti dalam Kembar

Metadata

Metadata untuk TwinCollection

Nama	Jenis	Deskripsi
lastUpdated	string	Terakhir kali TwinCollection diperbarui
lastUpdatedVersion	integer	Ini null untuk metadata properti yang dilaporkan dan tidak null untuk metadata properti yang diinginkan.

ProvisioningServiceErrorDetails

Berisi properti kesalahan yang dikembalikan oleh Layanan Provisi Azure IoT Hub.

Nama	Jenis	Deskripsi
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

ReprovisionPolicy

Perilaku layanan saat perangkat diprovisikan ulang ke hub IoT.

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

SymmetricKeyAttestation

Pengesahan melalui SymmetricKey.

Nama	Jenis	Deskripsi
primaryKey	string	Kunci konten utama.
secondaryKey	string	Kunci konten sekunder.

TpmAttestation

Pengesahan melalui TPM.

Nama	Jenis	Deskripsi
endorsementKey	string
storageRootKey	string

TwinCollection

Mewakili kumpulan properti dalam Kembar

Nama	Jenis	Deskripsi
count	integer	Jumlah properti dalam TwinCollection
metadata	Metadata	Metadata untuk TwinCollection
version	integer	Versi TwinCollection

X509Attestation

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

Referensi CA primer dan sekunder.

Nama	Jenis	Deskripsi
primary	string
secondary	string

X509CertificateInfo

Info sertifikat X509.

Nama	Jenis	Deskripsi
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509Certificates

Sertifikat primer dan sekunder

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

X509CertificateWithInfo

Info Sertifikat dan Sertifikat

Nama	Jenis	Deskripsi
certificate	string
info	X509CertificateInfo	Info sertifikat X509.