Condividi tramite

Enrollment Group - Get

  • Riferimento
Servizio:
IoT Hub Device Provisioning Service
Versione API:
2021-10-01

Ottenere un gruppo di registrazione dispositivi.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
id
 path True

string

ID gruppo di registrazione.
api-version
 query True

string

Versione dell'API da usare per la richiesta. Le versioni supportate includono: 2021-10-01

Risposte

Nome Tipo Descrizione
200 OK

EnrollmentGroup

Successo
Other Status Codes

ProvisioningServiceErrorDetails

Risposta di errore

Intestazioni

x-ms-error-code: string

Definizioni

Nome Descrizione
AttestationMechanism

Meccanismo di attestazione per individualEnrollment e enrollmentGroup.
CustomAllocationDefinition

Questo indica al servizio Device Provisioning quale webhook chiamare quando si usa l'allocazione personalizzata.
DeviceCapabilities

Funzionalità del dispositivo.
EnrollmentGroup

Record del gruppo di registrazioni.
InitialTwin

Dispositivo gemello iniziale. Contiene un subset delle proprietà di Twin.
InitialTwinProperties

Rappresenta le proprietà iniziali che verranno impostate nel dispositivo gemello.
Metadata

Metadati per TwinCollection
ProvisioningServiceErrorDetails

Contiene le proprietà di un errore restituito dal servizio provisioning dell'hub IoT di Azure.
ReprovisionPolicy

Comportamento del servizio quando viene eseguito di nuovo il provisioning di un dispositivo in un hub IoT.
SymmetricKeyAttestation

Attestazione tramite SymmetricKey.
TpmAttestation

Attestazione tramite TPM.
TwinCollection

Rappresenta una raccolta di proprietà all'interno di un gemello
X509Attestation

Attestazione tramite X509.
X509CAReferences

Riferimenti ca primari e secondari.
X509CertificateInfo

Informazioni sul certificato X509.
X509Certificates

Certificati primari e secondari
X509CertificateWithInfo

Informazioni su certificato e certificato

AttestationMechanism

Object

Meccanismo di attestazione per individualEnrollment e enrollmentGroup.

Nome Tipo Descrizione
symmetricKey

SymmetricKeyAttestation

Attestazione tramite SymmetricKey.
tpm

TpmAttestation

Attestazione tramite TPM.
type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Tipo di attestazione.
x509

X509Attestation

Attestazione tramite X509.

CustomAllocationDefinition

Object

Questo indica al servizio Device Provisioning quale webhook chiamare quando si usa l'allocazione personalizzata.

Nome Tipo Descrizione
apiVersion

string

minLength: 1

Versione API dei tipi di servizio di provisioning (ad esempio IndividualEnrollment) inviata nella richiesta di allocazione personalizzata. Versione minima supportata: "2018-09-01-preview".
webhookUrl

string

minLength: 1

URL del webhook usato per le richieste di allocazione.

DeviceCapabilities

Object

Funzionalità del dispositivo.

Nome Tipo Valore predefinito Descrizione
iotEdge

boolean

False

Se impostato su true, questo dispositivo è un dispositivo IoTEdge.

EnrollmentGroup

Object

Record del gruppo di registrazioni.

Nome Tipo Valore predefinito Descrizione
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

Criteri di allocazione di questa risorsa. Questo criterio sostituisce i criteri di allocazione a livello di tenant per questa singola registrazione o gruppo di registrazione. I valori possibili includono 'hashed': gli hub IoT collegati sono altrettanto probabili per cui è stato effettuato il provisioning dei dispositivi, 'geoLatency': viene effettuato il provisioning dei dispositivi in un hub IoT con la latenza più bassa per il dispositivo. Se più hub IoT collegati forniscono la stessa latenza più bassa, il servizio di provisioning esegue l'hashing dei dispositivi in tali hub, 'statico': la specifica dell'hub IoT desiderato nell'elenco di registrazioni assume la priorità rispetto ai criteri di allocazione a livello di servizio, 'custom': viene effettuato il provisioning dei dispositivi in un hub IoT in base alla logica personalizzata. Il servizio di provisioning passa informazioni sul dispositivo alla logica e la logica restituisce l'hub IoT desiderato e la configurazione iniziale desiderata. È consigliabile usare Funzioni di Azure per ospitare la logica.
attestation

AttestationMechanism

Meccanismo di attestazione per individualEnrollment e enrollmentGroup.
capabilities

DeviceCapabilities

Funzionalità del dispositivo.
createdDateTimeUtc

string (date-time)

Data/ora di creazione della risorsa.
customAllocationDefinition

CustomAllocationDefinition

Questo indica al servizio Device Provisioning quale webhook chiamare quando si usa l'allocazione personalizzata.
enrollmentGroupId

string

minLength: 1

ID gruppo di registrazione.
etag

string

Tag di entità associato alla risorsa.
initialTwin

InitialTwin

Dispositivo gemello iniziale. Contiene un subset delle proprietà di Twin.
iotHubHostName

string

Nome host dell'hub Iot.
iotHubs

string[]

L'elenco dei nomi host dell'hub IoT a cui possono essere allocati i dispositivi in questa risorsa. Deve essere un subset dell'elenco a livello di tenant degli hub IoT.
lastUpdatedDateTimeUtc

string (date-time)

Data/ora dell'ultimo aggiornamento della risorsa.
provisioningStatus enum:
  • disabled
  • enabled
enabled

Stato del provisioning.
reprovisionPolicy

ReprovisionPolicy

Comportamento del servizio quando viene eseguito di nuovo il provisioning di un dispositivo in un hub IoT.

InitialTwin

Object

Dispositivo gemello iniziale. Contiene un subset delle proprietà di Twin.

Nome Tipo Descrizione
properties

InitialTwinProperties

Rappresenta le proprietà iniziali che verranno impostate nel dispositivo gemello.
tags

TwinCollection

Rappresenta una raccolta di proprietà all'interno di un gemello

InitialTwinProperties

Object

Rappresenta le proprietà iniziali che verranno impostate nel dispositivo gemello.

Nome Tipo Descrizione
desired

TwinCollection

Rappresenta una raccolta di proprietà all'interno di un gemello

Metadata

Object

Metadati per TwinCollection

Nome Tipo Descrizione
lastUpdated

string (date-time)

Ultima volta che TwinCollection è stato aggiornato
lastUpdatedVersion

integer (int64)

Questo valore è Null per i metadati delle proprietà segnalate e non è Null per i metadati delle proprietà desiderate.

ProvisioningServiceErrorDetails

Object

Contiene le proprietà di un errore restituito dal servizio provisioning dell'hub IoT di Azure.

Nome Tipo Descrizione
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

ReprovisionPolicy

Object

Comportamento del servizio quando viene eseguito di nuovo il provisioning di un dispositivo in un hub IoT.

Nome Tipo Valore predefinito Descrizione
migrateDeviceData

boolean

True

Se impostato su true (impostazione predefinita), il servizio Device Provisioning eseguirà la migrazione dei dati del dispositivo (gemello, funzionalità del dispositivo e ID dispositivo) da un hub IoT a un altro durante un aggiornamento dell'assegnazione dell'hub IoT. Se impostato su false, il servizio Device Provisioning reimposta i dati del dispositivo sulla configurazione iniziale desiderata archiviata nell'elenco di registrazioni corrispondente.
updateHubAssignment

boolean

True

Se impostato su true (impostazione predefinita), il servizio Device Provisioning valuterà l'assegnazione dell'hub IoT del dispositivo e la aggiornerà se necessario per le richieste di provisioning oltre il primo da un determinato dispositivo. Se impostato su false, il dispositivo rimarrà assegnato all'hub IoT corrente.

SymmetricKeyAttestation

Object

Attestazione tramite SymmetricKey.

Nome Tipo Descrizione
primaryKey

string

Chiave simmetrica primaria.
secondaryKey

string

Chiave simmetrica secondaria.

TpmAttestation

Object

Attestazione tramite TPM.

Nome Tipo Descrizione
endorsementKey

string

storageRootKey

string

TwinCollection

Object

Rappresenta una raccolta di proprietà all'interno di un gemello

Nome Tipo Descrizione
count

integer

Numero di proprietà in TwinCollection
metadata

Metadata

Metadati per TwinCollection
version

integer (int64)

Versione di TwinCollection

X509Attestation

Object

Attestazione tramite X509.

Nome Tipo Descrizione
caReferences

X509CAReferences

Riferimenti ca primari e secondari.
clientCertificates

X509Certificates

Certificati primari e secondari
signingCertificates

X509Certificates

Certificati primari e secondari

X509CAReferences

Object

Riferimenti ca primari e secondari.

Nome Tipo Descrizione
primary

string

secondary

string

X509CertificateInfo

Object

Informazioni sul certificato X509.

Nome Tipo Descrizione
issuerName

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

X509Certificates

Object

Certificati primari e secondari

Nome Tipo Descrizione
primary

X509CertificateWithInfo

Informazioni su certificato e certificato
secondary

X509CertificateWithInfo

Informazioni su certificato e certificato

X509CertificateWithInfo

Object

Informazioni su certificato e certificato

Nome Tipo Descrizione
certificate

string

info

X509CertificateInfo

Informazioni sul certificato X509.