Enrollment Groups - Get X509

Service:

IoT Central

API Version:

2022-07-31

Abrufen des primären oder sekundären x509-Zertifikats einer Registrierungsgruppe
Erhalten Sie Details zum primären oder sekundären x509-Zertifikat einer Registrierungsgruppe, sofern vorhanden.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
baseDomain	path	True	string	Die Basisdomäne für alle Azure IoT Central-Dienstanforderungen.
enrollmentGroupId	path	True	string	Eindeutige ID der Registrierungsgruppe. Regex pattern: ^[a-zA-Z0-9-]*$
entry	path	True	CertificateEntry	Die Eingabe des Zertifikats unterstützt nur primäre und sekundäre.
subdomain	path	True	string	Die Anwendungsunterdomäne.
api-version	query	True	string	Die Version der aufgerufenen API.

Antworten

Name	Typ	Beschreibung
200 OK	SigningX509Certificate	Erfolg
Other Status Codes	Error	Eine Vom IoT Central Service empfangene Fehlerantwort. Headers x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Annehmen der Identität Ihres Benutzerkontos

Beispiele

Get primary or secondary X509

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "verified": true,
  "info": {
    "sha1Thumbprint": "644543467786B60C14DFE6B7C968A1990CF63EAC"
  },
  "etag": "IjE3MDAwODNhLTAwMDAtMDcwMC0wMDAwLTYyNjFmNzk0MDAwMCI="
}

Definitionen

Name	Beschreibung
CertificateEntry	Die Eingabe des Zertifikats unterstützt nur primäre und sekundäre.
Error	Die Antwortfehlerdefinition.
ErrorDetails	Die Detailinformationen des Fehlers.
SigningX509Certificate	Die X509-Zertifikatdefinition.
X509CertificateInfo	Die X509-Zertifikatinformationen.

CertificateEntry

Die Eingabe des Zertifikats unterstützt nur primäre und sekundäre.

Name	Typ	Beschreibung
primary	string	Der Eintrag des primären Zertifikats
secondary	string	Der Eintrag des sekundären Zertifikats

Error

Die Antwortfehlerdefinition.

Name	Typ	Beschreibung
error	ErrorDetails	Fehlerdetails für die aktuelle Anforderung.

ErrorDetails

Die Detailinformationen des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldungsdetails.
requestId	string	Korrelations-ID für die aktuelle Anforderung.
time	string	Der Zeitpunkt, zu dem die Fehleranforderung fehlgeschlagen ist.

SigningX509Certificate

Die X509-Zertifikatdefinition.

Name	Typ	Standardwert	Beschreibung
certificate	string		Die Zeichenfolgendarstellung dieses Zertifikats.
etag	string		ETag zur Vermeidung von Konflikten über mehrere Updates hinweg
info	X509CertificateInfo		Informationen zu diesem Zertifikat.
verified	boolean	False	Ob das Zertifikat überprüft wurde.

X509CertificateInfo

Die X509-Zertifikatinformationen.

Name	Typ	Beschreibung
sha1Thumbprint	string	Der SHA-1-Hashwert des Zertifikats.