Dps Certificate - Verify Certificate

Servizio:

IoT Hub Device Provisioning Service

Versione API:

2022-12-12

Verificare il possesso della chiave privata del certificato.
Verifica il possesso della chiave privata del certificato fornendo il certificato foglia rilasciato dal certificato precaricati.

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

Con parametri facoltativi:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify?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	Descrivere 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.

Corpo della richiesta

Nome	Tipo	Descrizione
certificate	string	rappresentazione in base 64 del certificato X509 .cer file o semplicemente contenuto di file pem.

Risposte

Nome	Tipo	Descrizione
200 OK	CertificateResponse	Va bene
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

DPSVerifyCertificate

Esempio di richiesta

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/certificates/cert/verify?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


{
  "certificate": "#####################################"
}

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
CertificateProperties	Descrizione di un certificato della CA X509.
CertificatePurpose	Descrivere lo scopo del certificato.
CertificateResponse	Certificato X509.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorDetails	Dettagli errore.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
VerificationCodeRequest	Certificato foglia serializzato JSON

CertificateProperties

Object

Descrizione di un certificato della CA X509.

Nome	Tipo	Descrizione
certificate	string (byte)	rappresentazione in base 64 del certificato X509 .cer file o semplicemente contenuto di file pem.
created	string (date-time-rfc1123)	Data e ora di creazione del certificato.
expiry	string (date-time-rfc1123)	Data e ora di scadenza del certificato.
isVerified	boolean	Determina se il certificato è stato verificato.
subject	string	Nome soggetto del certificato.
thumbprint	string	Identificazione personale del certificato.
updated	string (date-time-rfc1123)	Data e ora dell'ultimo aggiornamento del certificato.

CertificatePurpose

Enumerazione

Descrivere lo scopo del certificato.

Valore	Descrizione
clientAuthentication
serverAuthentication

CertificateResponse

Object

Certificato X509.

Nome	Tipo	Descrizione
etag	string	Tag di entità.
id	string	Identificatore della risorsa.
name	string	Nome del certificato.
properties	CertificateProperties	proprietà di un certificato
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
type	string	Tipo di risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

ErrorDetails

Object

Dettagli errore.

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

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

VerificationCodeRequest

Object

Certificato foglia serializzato JSON

Nome	Tipo	Descrizione
certificate	string	rappresentazione in base 64 del certificato X509 .cer file o semplicemente contenuto di file pem.