Dps Certificate - Generate Verification Code

Tjänst:

IoT Hub Device Provisioning Service

API-version:

2022-12-12

Generera verifieringskod för bevis på innehav.

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

Med valfria parametrar:

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-parametrar

Name	I	Obligatorisk	Typ	Description
certificateName	path	True	string	Det obligatoriska logiska namnet på certifikatet som etableringstjänsten använder för åtkomst.
provisioningServiceName	path	True	string	Namnet på etableringstjänsten.
resourceGroupName	path	True	string	namnet på resursgruppen.
subscriptionId	path	True	string	Prenumerationsidentifieraren.
api-version	query	True	string	Versionen av API:et.
certificate.created	query		string (date-time)	Tiden då certifikatet skapades.
certificate.hasPrivateKey	query		boolean	Anger om certifikatet innehåller en privat nyckel.
certificate.isVerified	query		boolean	Anger om certifikatet har verifierats av ägaren av den privata nyckeln.
certificate.lastUpdated	query		string (date-time)	Certifikatet uppdaterades senast.
certificate.name	query		string	Eget namn för certifikatet.
certificate.nonce	query		string	Slumptal som genereras för att indikera bevis på innehav.
certificate.purpose	query		CertificatePurpose	Beskrivning som anger syftet med certifikatet.
certificate.rawBytes	query		string (byte)	Rådata för certifikat.

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-Match	True	string	ETag för certifikatet. Detta krävs för att uppdatera ett befintligt certifikat och ignoreras när du skapar ett helt nytt certifikat.

Svar

Name	Typ	Description
200 OK	VerificationCodeResponse	Genererad verifieringskod för certifikatet returneras.
Other Status Codes	ErrorDetails	Standardfelsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

DPSGenerateVerificationCode

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
CertificatePurpose	Beskrivning som anger syftet med certifikatet.
ErrorDetails	Felinformation.
Properties
VerificationCodeResponse	Beskrivning av verifieringskodens svar.

CertificatePurpose

Uppräkning

Beskrivning som anger syftet med certifikatet.

Värde	Description
clientAuthentication
serverAuthentication

ErrorDetails

Objekt

Felinformation.

Name	Typ	Description
code	integer (int32)	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.

Properties

Objekt

Name	Typ	Description
certificate	string (byte)	base-64-representation av X509-certifikat .cer fil eller bara .pem-filinnehåll.
created	string	Tiden då certifikatet skapades.
expiry	string	Koden upphör att gälla.
isVerified	boolean	Ange om certifikatet har verifierats av ägaren av den privata nyckeln.
subject	string	Certifikatmottagare.
thumbprint	string	Certifikatets tumavtryck.
updated	string	Certifikatets uppdaterade tid.
verificationCode	string	Verifieringskod.

VerificationCodeResponse

Objekt

Beskrivning av verifieringskodens svar.

Name	Typ	Description
etag	string	Begär etag.
id	string	Resursidentifieraren.
name	string	Certifikatets namn.
properties	Properties
type	string	Resurstypen.