Dps Certificate - Generate Verification Code

Referenz

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Generieren Sie Überprüfungscode für den Besitznachweis.

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

With optional parameters:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode?certificate.name={certificate.name}&certificate.rawBytes={certificate.rawBytes}&certificate.isVerified={certificate.isVerified}&certificate.purpose={certificate.purpose}&certificate.created={certificate.created}&certificate.lastUpdated={certificate.lastUpdated}&certificate.hasPrivateKey={certificate.hasPrivateKey}&certificate.nonce={certificate.nonce}&api-version=2022-12-12

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
certificateName	path	True	string	Der obligatorische logische Name des Zertifikats, auf das der Bereitstellungsdienst zugreift.
provisioningServiceName	path	True	string	Name des Bereitstellungsdiensts.
resourceGroupName	path	True	string	Name der Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die Version der API.
certificate.created	query		string date-time	Zertifikaterstellungszeit.
certificate.hasPrivateKey	query		boolean	Gibt an, ob das Zertifikat einen privaten Schlüssel enthält.
certificate.isVerified	query		boolean	Gibt an, ob das Zertifikat vom Besitzer des privaten Schlüssels überprüft wurde.
certificate.lastUpdated	query		string date-time	Die Letzte Aktualisierungszeit des Zertifikats.
certificate.name	query		string	Allgemeiner Name für das Zertifikat.
certificate.nonce	query		string	Zufallszahl, die generiert wird, um den Besitznachweis anzugeben.
certificate.purpose	query		CertificatePurpose	Beschreibung, die den Zweck des Zertifikats erwähnt.
certificate.rawBytes	query		string byte	Rohdaten des Zertifikats.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match	True	string	ETag des Zertifikats. Dies ist erforderlich, um ein vorhandenes Zertifikat zu aktualisieren, und wird beim Erstellen eines brandneuen Zertifikats ignoriert.

Antworten

Name	Typ	Beschreibung
200 OK	VerificationCodeResponse	Der generierte Überprüfungscode für dieses Zertifikat wird zurückgegeben.
Other Status Codes	ErrorDetails	Standardfehlerantwort.

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	Identitätswechsel Ihres Benutzerkontos

Beispiele

DPSGenerateVerificationCode

Sample Request

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/certificates/cert/generateVerificationCode?certificate.name={certificate.name}&certificate.rawBytes={certificate.rawBytes}&certificate.isVerified={certificate.isVerified}&certificate.purpose={certificate.purpose}&certificate.created={certificate.created}&certificate.lastUpdated={certificate.lastUpdated}&certificate.hasPrivateKey={certificate.hasPrivateKey}&certificate.nonce={certificate.nonce}&api-version=2022-12-12

Sample Response

Status code:: 200

{
  "name": "cert",
  "properties": {
    "verificationCode": "##################################",
    "subject": "CN=andbucdevice1",
    "expiry": "Sat, 31 Dec 2039 23:59:59 GMT",
    "thumbprint": "##############################",
    "certificate": "MA==",
    "isVerified": false,
    "created": "Thu, 12 Oct 2017 19:23:50 GMT",
    "updated": "Thu, 12 Oct 2017 19:26:56 GMT"
  }
}

Definitionen

Name	Beschreibung
CertificatePurpose	Beschreibung, die den Zweck des Zertifikats erwähnt.
ErrorDetails	Fehlerdetails.
Properties
VerificationCodeResponse	Beschreibung der Antwort des Überprüfungscodes.

CertificatePurpose

Beschreibung, die den Zweck des Zertifikats erwähnt.

Name	Typ	Beschreibung
clientAuthentication	string
serverAuthentication	string

ErrorDetails

Fehlerdetails.

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

Properties

Name	Typ	Beschreibung
certificate	string	Base64-Darstellung des X509-Zertifikats .cer Datei oder nur PEM-Dateiinhalt.
created	string	Zertifikaterstellungszeit.
expiry	string	Codeablauf.
isVerified	boolean	Geben Sie an, ob das Zertifikat vom Besitzer des privaten Schlüssels überprüft wird.
subject	string	Zertifikatsubjekt.
thumbprint	string	Zertifikatfingerabdruck.
updated	string	Zeit der Zertifikats-Aktualisierung.
verificationCode	string	Überprüfungscode.

VerificationCodeResponse

Beschreibung der Antwort des Überprüfungscodes.

Name	Typ	Beschreibung
etag	string	Etag anfordern.
id	string	Der Ressourcenbezeichner.
name	string	Name des Zertifikats.
properties	Properties
type	string	Der Ressourcentyp.