Dps Certificate - Create Or Update

Dienst:

IoT Hub Device Provisioning Service

API-Version:

2022-12-12

Laden Sie das Zertifikat in den Bereitstellungsdienst hoch.
Fügen Sie ein neues Zertifikat hinzu, oder aktualisieren Sie ein vorhandenes Zertifikat.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}?api-version=2022-12-12

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
certificateName	path	True	string maxLength: 256	Der Name des Zertifikats, das erstellt oder aktualisiert wird.
provisioningServiceName	path	True	string	Der Name des Bereitstellungsdiensts.
resourceGroupName	path	True	string	Ressourcengruppenbezeichner.
subscriptionId	path	True	string	Der Abonnementbezeichner.
api-version	query	True	string	Die Version der API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	ETag des Zertifikats. Dies ist erforderlich, um ein vorhandenes Zertifikat zu aktualisieren und beim Erstellen eines völlig neuen Zertifikats ignoriert zu werden.

Anforderungstext

Name	Typ	Beschreibung
properties	CertificateProperties	Eigenschaften eines Zertifikats

Antworten

Name	Typ	Beschreibung
200 OK	CertificateResponse	Wenn das Zertifikat bereits vorhanden ist und die Aktualisierung erfolgreich war, gibt der Vorgang den HTTP-Statuscode 201 (OK) zurück.
Other Status Codes	ErrorDetails	Standardfehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

DPSCreateOrUpdateCertificate

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/certificates/cert?api-version=2022-12-12

{
  "properties": {
    "certificate": "MA=="
  }
}

Beispiel für eine Antwort

Statuscode:

200

{
  "properties": {
    "subject": "CN=testdevice1",
    "expiry": "Sat, 31 Dec 2039 23:59:59 GMT",
    "certificate": "MA==",
    "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25",
    "isVerified": false,
    "created": "Thu, 12 Oct 2017 19:23:50 GMT",
    "updated": "Thu, 12 Oct 2017 19:23:50 GMT"
  },
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert",
  "name": "cert",
  "type": "Microsoft.Devices/ProvisioningServices/Certificates",
  "etag": "AAAAAAExpNs="
}

Definitionen

Name	Beschreibung
CertificateProperties	Die Beschreibung eines X509-Zertifizierungsstellenzertifikats.
CertificateResponse	Das X509-Zertifikat.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorDetails	Fehlerdetails.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CertificateProperties

Objekt

Die Beschreibung eines X509-Zertifizierungsstellenzertifikats.

Name	Typ	Beschreibung
certificate	string (byte)	Base-64-Darstellung des X509-Zertifikats .cer Datei oder nur PEM-Dateiinhalt.
created	string (date-time-rfc1123)	Das Erstellungsdatum und die Uhrzeit des Zertifikats.
expiry	string (date-time-rfc1123)	Das Ablaufdatum und die Uhrzeit des Zertifikats.
isVerified	boolean	Bestimmt, ob das Zertifikat überprüft wurde.
subject	string	Der Antragstellername des Zertifikats.
thumbprint	string	Fingerabdruck des Zertifikats.
updated	string (date-time-rfc1123)	Datum und Uhrzeit der letzten Aktualisierung des Zertifikats.

CertificateResponse

Objekt

Das X509-Zertifikat.

Name	Typ	Beschreibung
etag	string	Das Entitätstag.
id	string	Der Ressourcenbezeichner.
name	string	Der Name des Zertifikats.
properties	CertificateProperties	Eigenschaften eines Zertifikats
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	string	Der Ressourcentyp.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorDetails

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
code	integer (int32)	Der Fehlercode.
details	string	Die Fehlerdetails.
httpStatusCode	string	Der HTTP-Statuscode.
message	string	Die Fehlermeldung.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.