Dps Certificate - Generate Verification Code

Riferimento

Servizio:: IoT Hub Device Provisioning Service

Versione API:: 2022-12-12

Generare il codice di verifica per la prova del possesso.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
certificateName	path	True	string	Nome logico obbligatorio del certificato usato dal servizio di provisioning per accedere.
provisioningServiceName	path	True	string	Nome del servizio di provisioning.
resourceGroupName	path	True	string	nome del gruppo di risorse.
subscriptionId	path	True	string	L'identificatore della sottoscrizione.
api-version	query	True	string	Versione dell'API.
certificate.created	query		string date-time	Ora di creazione del certificato.
certificate.hasPrivateKey	query		boolean	Indica se il certificato contiene una chiave privata.
certificate.isVerified	query		boolean	Indica se il certificato è stato verificato dal proprietario della chiave privata.
certificate.lastUpdated	query		string date-time	Ora dell'ultimo aggiornamento del certificato.
certificate.name	query		string	Nome comune per il certificato.
certificate.nonce	query		string	Numero casuale generato per indicare la prova del possesso.
certificate.purpose	query		CertificatePurpose	Descrizione che indica lo scopo del certificato.
certificate.rawBytes	query		string byte	Dati non elaborati del certificato.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match	True	string	ETag del certificato. Questa operazione è necessaria per aggiornare un certificato esistente e ignorarlo durante la creazione di un nuovo certificato.

Risposte

Nome	Tipo	Descrizione
200 OK	VerificationCodeResponse	Viene restituito il codice di verifica generato per il certificato.
Other Status Codes	ErrorDetails	Risposta di errore predefinita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

DPSGenerateVerificationCode

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
CertificatePurpose	Descrizione che indica lo scopo del certificato.
ErrorDetails	Dettagli errore.
Properties
VerificationCodeResponse	Descrizione della risposta del codice di verifica.

CertificatePurpose

Descrizione che indica lo scopo del certificato.

Nome	Tipo	Descrizione
clientAuthentication	string
serverAuthentication	string

ErrorDetails

Dettagli errore.

Nome	Tipo	Descrizione
code	integer	Codice di errore.
details	string	Dettagli dell'errore.
httpStatusCode	string	Codice di stato HTTP.
message	string	Messaggio di errore.

Properties

Nome	Tipo	Descrizione
certificate	string	rappresentazione di base 64 del certificato X509 .cer file o solo contenuto del file pem.
created	string	Ora di creazione del certificato.
expiry	string	Scadenza del codice.
isVerified	boolean	Indicare se il certificato viene verificato dal proprietario della chiave privata.
subject	string	Oggetto certificato.
thumbprint	string	Identificazione personale del certificato.
updated	string	Ora aggiornata del certificato.
verificationCode	string	Codice di verifica.

VerificationCodeResponse

Descrizione della risposta del codice di verifica.

Nome	Tipo	Descrizione
etag	string	Etag della richiesta.
id	string	Identificatore della risorsa.
name	string	Nome del certificato.
properties	Properties
type	string	Tipo di risorsa.

Condividi tramite