Enrollment Group - Create Or Update

Služba:

IoT Hub Device Provisioning Service

Verze rozhraní API:

2021-10-01

Create nebo aktualizujte skupinu registrace zařízení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
id	path	True	string	ID skupiny registrací.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek. Mezi podporované verze patří: 2021-10-01

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match		string	Značka ETag záznamu registrace.

Text požadavku

Name	Vyžadováno	Typ	Description
attestation	True	AttestationMechanism	Mechanismus ověření identity pro individualEnrollment i enrollmentGroup.
enrollmentGroupId	True	string	ID skupiny registrací.
allocationPolicy		enum: hashed geoLatency static custom	Zásady přidělování tohoto prostředku. Tato zásada přepíše zásady přidělení na úrovni tenanta pro tuto individuální registraci nebo skupinu registrací. Mezi možné hodnoty patří hodnota hash: Propojená centra IoT mají stejnou pravděpodobnost, že budou mít zařízení zřízená pro ně, "geoLatency": Zařízení se zřizují ve službě IoT Hub s nejnižší latencí zařízení. Pokud by více propojených center IoT poskytovalo stejnou nejnižší latenci, zřizovací služba vytřiďuje hodnoty hash zařízení v těchto centrech, statická: Specifikace požadovaného centra IoT v seznamu registrací má přednost před zásadami přidělování na úrovni služeb. Vlastní: Zařízení se zřídí do centra IoT na základě vlastní logiky. Zřizovací služba předá do logiky informace o zařízení a logika vrátí požadované centrum IoT a také požadovanou počáteční konfiguraci. K hostování logiky doporučujeme použít Azure Functions.
capabilities		DeviceCapabilities	Možnosti zařízení.
customAllocationDefinition		CustomAllocationDefinition	Tím dps zjistíte, který webhook má volat při použití vlastního přidělení.
etag		string	Značka entity přidružená k prostředku.
initialTwin		InitialTwin	Počáteční dvojče zařízení. Obsahuje podmnožinu vlastností dvojčete.
iotHubHostName		string	Název hostitele služby Iot Hub.
iotHubs		string[]	Seznam IoT Hub názvů hostitelů, ke které lze zařízení v tomto prostředku přidělit. Musí být podmnožinou seznamu služeb IoT Hub na úrovni tenanta.
provisioningStatus		enum: enabled disabled	Stav zřizování.
reprovisionPolicy		ReprovisionPolicy	Chování služby při opětovném zřízení zařízení ve službě IoT Hub.

Odpovědi

Name	Typ	Description
200 OK	EnrollmentGroup	Success
Other Status Codes	ProvisioningServiceErrorDetails	Odpověď na chybu Hlavičky x-ms-error-code: string

Definice

Name	Description
AttestationMechanism	Mechanismus ověření identity pro individualEnrollment i enrollmentGroup.
CustomAllocationDefinition	Tím dps zjistíte, který webhook má volat při použití vlastního přidělení.
DeviceCapabilities	Možnosti zařízení.
EnrollmentGroup	Záznam skupiny registrací.
InitialTwin	Počáteční dvojče zařízení. Obsahuje podmnožinu vlastností dvojčete.
InitialTwinProperties	Představuje počáteční vlastnosti, které se nastaví na dvojčeti zařízení.
Metadata	Metadata pro TwinCollection
ProvisioningServiceErrorDetails	Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning.
ReprovisionPolicy	Chování služby při opětovném zřízení zařízení ve službě IoT Hub.
SymmetricKeyAttestation	Ověření identity přes SymmetricKey.
TpmAttestation	Ověření identity prostřednictvím čipu TPM.
TwinCollection	Představuje kolekci vlastností v rámci dvojčete.
X509Attestation	Ověření identity přes X509.
X509CAReferences	Odkazy na primární a sekundární certifikační autoritu.
X509CertificateInfo	Informace o certifikátu X509
X509Certificates	Primární a sekundární certifikáty
X509CertificateWithInfo	Informace o certifikátu a certifikátu

AttestationMechanism

Mechanismus ověření identity pro individualEnrollment i enrollmentGroup.

Name	Typ	Description
symmetricKey	SymmetricKeyAttestation	Ověření identity přes SymmetricKey.
tpm	TpmAttestation	Ověření identity prostřednictvím čipu TPM.
type	enum: none symmetricKey tpm x509	Typ ověření identity.
x509	X509Attestation	Ověření identity přes X509.

CustomAllocationDefinition

Tím dps zjistíte, který webhook má volat při použití vlastního přidělení.

Name	Typ	Description
apiVersion	string	Verze rozhraní API typů služby zřizování (například IndividualEnrollment) odeslaná ve vlastní žádosti o přidělení Minimální podporovaná verze: "2018-09-01-preview".
webhookUrl	string	Adresa URL webhooku používaná pro žádosti o přidělení

DeviceCapabilities

Možnosti zařízení.

Name	Typ	Default value	Description
iotEdge	boolean	False	Pokud je nastavená hodnota true, jedná se o zařízení IoTEdge.

EnrollmentGroup

Záznam skupiny registrací.

Name	Typ	Default value	Description
allocationPolicy	enum: custom geoLatency hashed static		Zásady přidělování tohoto prostředku. Tato zásada přepíše zásady přidělení na úrovni tenanta pro tuto individuální registraci nebo skupinu registrací. Mezi možné hodnoty patří hodnota hash: Propojená centra IoT mají stejnou pravděpodobnost, že budou mít zařízení zřízená pro ně, "geoLatency": Zařízení se zřizují ve službě IoT Hub s nejnižší latencí zařízení. Pokud by více propojených center IoT poskytovalo stejnou nejnižší latenci, zřizovací služba vytřiďuje hodnoty hash zařízení v těchto centrech, statická: Specifikace požadovaného centra IoT v seznamu registrací má přednost před zásadami přidělování na úrovni služeb. Vlastní: Zařízení se zřídí do centra IoT na základě vlastní logiky. Zřizovací služba předá do logiky informace o zařízení a logika vrátí požadované centrum IoT a také požadovanou počáteční konfiguraci. K hostování logiky doporučujeme použít Azure Functions.
attestation	AttestationMechanism		Mechanismus ověření identity pro individualEnrollment i enrollmentGroup.
capabilities	DeviceCapabilities		Možnosti zařízení.
createdDateTimeUtc	string		DateTime byl tento prostředek vytvořen.
customAllocationDefinition	CustomAllocationDefinition		Tím dps zjistíte, který webhook má volat při použití vlastního přidělení.
enrollmentGroupId	string		ID skupiny registrací.
etag	string		Značka entity přidružená k prostředku.
initialTwin	InitialTwin		Počáteční dvojče zařízení. Obsahuje podmnožinu vlastností dvojčete.
iotHubHostName	string		Název hostitele služby Iot Hub.
iotHubs	string[]		Seznam IoT Hub názvů hostitelů, ke které lze zařízení v tomto prostředku přidělit. Musí být podmnožinou seznamu služeb IoT Hub na úrovni tenanta.
lastUpdatedDateTimeUtc	string		Datum a čas byl tento prostředek naposledy aktualizován.
provisioningStatus	enum: disabled enabled	enabled	Stav zřizování.
reprovisionPolicy	ReprovisionPolicy		Chování služby při opětovném zřízení zařízení ve službě IoT Hub.

InitialTwin

Počáteční dvojče zařízení. Obsahuje podmnožinu vlastností dvojčete.

Name	Typ	Description
properties	InitialTwinProperties	Představuje počáteční vlastnosti, které se nastaví na dvojčeti zařízení.
tags	TwinCollection	Představuje kolekci vlastností v rámci dvojčete.

InitialTwinProperties

Představuje počáteční vlastnosti, které se nastaví na dvojčeti zařízení.

Name	Typ	Description
desired	TwinCollection	Představuje kolekci vlastností v rámci dvojčete.

Metadata

Metadata pro TwinCollection

Name	Typ	Description
lastUpdated	string	Čas poslední aktualizace TwinCollection
lastUpdatedVersion	integer	Tato hodnota je null pro metadata ohlášených vlastností a není null pro metadata požadovaných vlastností.

ProvisioningServiceErrorDetails

Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning.

Name	Typ	Description
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

ReprovisionPolicy

Chování služby při opětovném zřízení zařízení ve službě IoT Hub.

Name	Typ	Default value	Description
migrateDeviceData	boolean	True	Pokud je nastavená hodnota true (výchozí), služba Device Provisioning během aktualizace přiřazení centra IoT migruje data zařízení (dvojče, možnosti zařízení a ID zařízení) z jednoho centra IoT do jiného. Pokud je nastavená hodnota false, služba Device Provisioning resetuje data zařízení na počáteční požadovanou konfiguraci uloženou v odpovídajícím seznamu registrací.
updateHubAssignment	boolean	True	Pokud je nastavená hodnota true (výchozí), služba Device Provisioning vyhodnotí přiřazení IoT Hub zařízení a v případě potřeby ho aktualizuje pro jakékoli žádosti o zřízení nad rámec prvního z daného zařízení. Pokud je nastavená hodnota false, zařízení zůstane přiřazené k aktuálnímu centru IoT.

SymmetricKeyAttestation

Ověření identity přes SymmetricKey.

Name	Typ	Description
primaryKey	string	Primární symetrický klíč.
secondaryKey	string	Sekundární symetrický klíč.

TpmAttestation

Ověření identity prostřednictvím čipu TPM.

Name	Typ	Description
endorsementKey	string
storageRootKey	string

TwinCollection

Představuje kolekci vlastností v rámci dvojčete.

Name	Typ	Description
count	integer	Počet vlastností v TwinCollection
metadata	Metadata	Metadata pro TwinCollection
version	integer	Verze TwinCollection

X509Attestation

Ověření identity přes X509.

Name	Typ	Description
caReferences	X509CAReferences	Odkazy na primární a sekundární certifikační autoritu.
clientCertificates	X509Certificates	Primární a sekundární certifikáty
signingCertificates	X509Certificates	Primární a sekundární certifikáty

X509CAReferences

Odkazy na primární a sekundární certifikační autoritu.

Name	Typ	Description
primary	string
secondary	string

X509CertificateInfo

Informace o certifikátu X509

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

X509Certificates

Primární a sekundární certifikáty

Name	Typ	Description
primary	X509CertificateWithInfo	Informace o certifikátu a certifikátu
secondary	X509CertificateWithInfo	Informace o certifikátu a certifikátu

X509CertificateWithInfo

Informace o certifikátu a certifikátu

Name	Typ	Description
certificate	string
info	X509CertificateInfo	Informace o certifikátu X509