Enrollment Groups - Get

Servizio:

IoT Central

Versione API:

2022-07-31

Ottenere un gruppo di registrazione in base all'ID
Ottenere informazioni dettagliate su un gruppo di registrazioni in base all'ID.

GET https://{subdomain}.{baseDomain}/api/enrollmentGroups/{enrollmentGroupId}?api-version=2022-07-31

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
baseDomain	path	True	string	Dominio di base per tutte le richieste del servizio Azure IoT Central.
enrollmentGroupId	path	True	string maxLength: 255 pattern: ^[a-zA-Z0-9-]*$	ID univoco del gruppo di registrazione.
subdomain	path	True	string	Sottodominio dell'applicazione.
api-version	query	True	string	Versione dell'API chiamata.

Risposte

Nome	Tipo	Descrizione
200 OK	EnrollmentGroup	Successo
Other Status Codes	Error	Risposta di errore ricevuta dal servizio IoT Central. Intestazioni x-ms-error-code: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get an enrollment group by ID

Esempio di richiesta

HTTP

GET https://appsubdomain.azureiotcentral.com/api/enrollmentGroups/myEnrollmentGroupId?api-version=2022-07-31

Risposta di esempio

Codice di stato:

200

{
  "id": "myEnrollmentGroupId",
  "displayName": "My group",
  "enabled": true,
  "type": "iot",
  "attestation": {
    "type": "symmetricKey",
    "symmetricKey": {
      "primaryKey": "<primary-symmetric-key>",
      "secondaryKey": "<secondary-symmetric-key>"
    }
  },
  "etag": "IjA4MDUwMTJiLTAwMDAtMDcwMC0wMDAwLTYyODJhOWVjMDAwMCI="
}

Definizioni

Nome	Descrizione
EnrollmentGroup	Definizione del gruppo di registrazione.
EnrollmentGroupType	Tipo di dispositivi che si connettono tramite il gruppo.
Error	Definizione dell'errore di risposta.
ErrorDetails	Informazioni dettagliate sull'errore.
GroupSymmetricKeyAttestation	Definizione di attestazione della chiave simmetrica.
GroupX509Attestation	Definizione di attestazione X509.
SigningX509	Definizione X509.
SigningX509Certificate	Definizione del certificato X509.
SigningX509Certificates	Definizione dei certificati X509.
SymmetricKey	Definizione della chiave simmetrica.
X509CertificateInfo	Informazioni sul certificato X509.

EnrollmentGroup

Object

Definizione del gruppo di registrazione.

Nome	Tipo	Valore predefinito	Descrizione
attestation	GroupAttestation: GroupSymmetricKeyAttestation GroupX509Attestation		Meccanismo di attestazione per il gruppo di registrazioni.
displayName	string		Nome visualizzato del gruppo di registrazione.
enabled	boolean	True	Indica se i dispositivi che usano il gruppo possono connettersi a IoT Central.
etag	string		ETag usato per evitare conflitti negli aggiornamenti del gruppo di registrazione.
id	string		ID univoco del gruppo di registrazione.
type	EnrollmentGroupType		Tipo di dispositivi che si connettono tramite il gruppo.

EnrollmentGroupType

Enumerazione

Tipo di dispositivi che si connettono tramite il gruppo.

Valore	Descrizione
iot	Dispositivi IoT normali (non Edge)
iotEdge	Dispositivi IoT Edge

Error

Object

Definizione dell'errore di risposta.

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore per la richiesta corrente.

ErrorDetails

Object

Informazioni dettagliate sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Dettagli del messaggio di errore.
requestId	string	ID correlazione per la richiesta corrente.
time	string (date-time-rfc1123)	Ora in cui la richiesta di errore non è riuscita.

GroupSymmetricKeyAttestation

Object

Definizione di attestazione della chiave simmetrica.

Nome	Tipo	Descrizione
symmetricKey	SymmetricKey	Credenziali della chiave simmetrica per questa attestazione.
type	string: symmetricKey	Tipo dell'attestazione.

GroupX509Attestation

Object

Definizione di attestazione X509.

Nome	Tipo	Descrizione
type	string: x509	Tipo dell'attestazione.
x509	SigningX509	Credenziali X.509 per questa attestazione.

SigningX509

Object

Definizione X509.

Nome	Tipo	Descrizione
signingCertificates	SigningX509Certificates	Certificati di firma X.509 per questa credenziale.

SigningX509Certificate

Object

Definizione del certificato X509.

Nome	Tipo	Valore predefinito	Descrizione
certificate	string		Rappresentazione di stringa del certificato.
etag	string		ETag usato per evitare conflitti tra più aggiornamenti
info	X509CertificateInfo		Informazioni su questo certificato.
verified	boolean	False	Indica se il certificato è stato verificato.

SigningX509Certificates

Object

Definizione dei certificati X509.

Nome	Tipo	Descrizione
primary	SigningX509Certificate	Certificato X.509 primario per questa credenziale.
secondary	SigningX509Certificate	Certificato X.509 secondario per questa credenziale.

SymmetricKey

Object

Definizione della chiave simmetrica.

Nome	Tipo	Descrizione
primaryKey	string	Chiave primaria per questa credenziale.
secondaryKey	string	Chiave secondaria per questa credenziale.

X509CertificateInfo

Object

Informazioni sul certificato X509.

Nome	Tipo	Descrizione
sha1Thumbprint	string	Valore hash SHA-1 del certificato.