Dps Certificate - Generate Verification Code

Référence

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Générez le code de vérification pour la preuve de possession.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
certificateName	path	True	string	Nom logique obligatoire du certificat, que le service d’approvisionnement utilise pour accéder.
provisioningServiceName	path	True	string	Nom du service d’approvisionnement.
resourceGroupName	path	True	string	nom du groupe de ressources.
subscriptionId	path	True	string	Identificateur de l’abonnement.
api-version	query	True	string	Version de l’API.
certificate.created	query		string date-time	Heure de création du certificat.
certificate.hasPrivateKey	query		boolean	Indique si le certificat contient une clé privée.
certificate.isVerified	query		boolean	Indique si le certificat a été vérifié par le propriétaire de la clé privée.
certificate.lastUpdated	query		string date-time	Heure de la dernière mise à jour du certificat.
certificate.name	query		string	Nom commun du certificat.
certificate.nonce	query		string	Nombre aléatoire généré pour indiquer une preuve de possession.
certificate.purpose	query		CertificatePurpose	Description mentionnant l’objectif du certificat.
certificate.rawBytes	query		string byte	Données brutes du certificat.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-Match	True	string	ETag du certificat. Cela est nécessaire pour mettre à jour un certificat existant et ignoré lors de la création d’un tout nouveau certificat.

Réponses

Nom	Type	Description
200 OK	VerificationCodeResponse	Le code de vérification généré pour ce certificat est retourné.
Other Status Codes	ErrorDetails	Réponse d’erreur par défaut.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom	Description
CertificatePurpose	Description mentionnant l’objectif du certificat.
ErrorDetails	Détails de l’erreur.
Properties
VerificationCodeResponse	Description de la réponse du code de vérification.

CertificatePurpose

Description mentionnant l’objectif du certificat.

Nom	Type	Description
clientAuthentication	string
serverAuthentication	string

ErrorDetails

Détails de l’erreur.

Nom	Type	Description
code	integer	Code d'erreur.
details	string	Détails de l’erreur.
httpStatusCode	string	Code d’état HTTP.
message	string	Message d’erreur.

Properties

Nom	Type	Description
certificate	string	Représentation en base 64 du certificat X509 .cer fichier ou simplement du contenu du fichier .pem.
created	string	Heure de création du certificat.
expiry	string	Expiration du code.
isVerified	boolean	Indiquez si le certificat est vérifié par le propriétaire de la clé privée.
subject	string	Objet du certificat.
thumbprint	string	Empreinte du certificat.
updated	string	Heure de mise à jour du certificat.
verificationCode	string	Code de vérification.

VerificationCodeResponse

Description de la réponse du code de vérification.

Nom	Type	Description
etag	string	Demander l’etag.
id	string	Identificateur de ressource.
name	string	Nom du certificat.
properties	Properties
type	string	Type de ressource.