Dps Certificate - Generate Verification Code

Service:

IoT Hub Device Provisioning Service

API-versie:

2022-12-12

Genereer verificatiecode voor Proof of Possession.

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

Met optionele 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-parameters

Name	In	Vereist	Type	Description
certificateName	path	True	string	De verplichte logische naam van het certificaat, die door de inrichtingsservice wordt gebruikt voor toegang.
provisioningServiceName	path	True	string	De naam van de inrichtingsservice.
resourceGroupName	path	True	string	naam van resourcegroep.
subscriptionId	path	True	string	De abonnement-ID.
api-version	query	True	string	De versie van de API.
certificate.created	query		string (date-time)	Tijd voor het maken van certificaten.
certificate.hasPrivateKey	query		boolean	Geeft aan of het certificaat een persoonlijke sleutel bevat.
certificate.isVerified	query		boolean	Geeft aan of het certificaat is geverifieerd door de eigenaar van de persoonlijke sleutel.
certificate.lastUpdated	query		string (date-time)	Het certificaat is voor het laatst bijgewerkt.
certificate.name	query		string	Algemene naam voor het certificaat.
certificate.nonce	query		string	Willekeurig getal gegenereerd om bewijs van bezit aan te geven.
certificate.purpose	query		CertificatePurpose	Beschrijving waarin het doel van het certificaat wordt vermeld.
certificate.rawBytes	query		string (byte)	Onbewerkte gegevens van het certificaat.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match	True	string	ETag van het certificaat. Dit is vereist om een bestaand certificaat bij te werken en genegeerd tijdens het maken van een gloednieuw certificaat.

Antwoorden

Name	Type	Description
200 OK	VerificationCodeResponse	Gegenereerde verificatiecode voor dat certificaat wordt geretourneerd.
Other Status Codes	ErrorDetails	Standaardfoutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

DPSGenerateVerificationCode

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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"
  }
}

Definities

Name	Description
CertificatePurpose	Beschrijving waarin het doel van het certificaat wordt vermeld.
ErrorDetails	Foutdetails.
Properties
VerificationCodeResponse	Beschrijving van het antwoord van de verificatiecode.

CertificatePurpose

Inventarisatie

Beschrijving waarin het doel van het certificaat wordt vermeld.

Waarde	Description
clientAuthentication
serverAuthentication

ErrorDetails

Object

Foutdetails.

Name	Type	Description
code	integer (int32)	De foutcode.
details	string	De foutdetails.
httpStatusCode	string	De HTTP-statuscode.
message	string	Het foutbericht.

Properties

Object

Name	Type	Description
certificate	string (byte)	base-64-weergave van X509-certificaat .cer bestand of alleen PEM-bestandsinhoud.
created	string	De tijd waarop het certificaat is gemaakt.
expiry	string	Verlopen van code.
isVerified	boolean	Geef aan of het certificaat is geverifieerd door de eigenaar van de persoonlijke sleutel.
subject	string	Certificaatonderwerp.
thumbprint	string	Vingerafdruk van certificaat.
updated	string	Het bijgewerkte tijdstip van het certificaat.
verificationCode	string	Verificatiecode.

VerificationCodeResponse

Object

Beschrijving van het antwoord van de verificatiecode.

Name	Type	Description
etag	string	Etag aanvragen.
id	string	De resource-id.
name	string	Naam van het certificaat.
properties	Properties
type	string	Het resourcetype.