Dps Certificate - Generate Verification Code

Referencia

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Generar código de verificación para Prueba de posesión.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
certificateName	path	True	string	Nombre lógico obligatorio del certificado, que el servicio de aprovisionamiento usa para acceder.
provisioningServiceName	path	True	string	Nombre del servicio de aprovisionamiento.
resourceGroupName	path	True	string	nombre del grupo de recursos.
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	La versión de la API.
certificate.created	query		string date-time	Hora de creación del certificado.
certificate.hasPrivateKey	query		boolean	Indica si el certificado contiene una clave privada.
certificate.isVerified	query		boolean	Indica si el propietario de la clave privada ha comprobado el certificado.
certificate.lastUpdated	query		string date-time	Hora de la última actualización del certificado.
certificate.name	query		string	Nombre común del certificado.
certificate.nonce	query		string	Número aleatorio generado para indicar la prueba de posesión.
certificate.purpose	query		CertificatePurpose	Descripción que menciona el propósito del certificado.
certificate.rawBytes	query		string byte	Datos sin procesar del certificado.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-Match	True	string	ETag del certificado. Esto es necesario para actualizar un certificado existente y se omite al crear un certificado nuevo.

Respuestas

Nombre	Tipo	Description
200 OK	VerificationCodeResponse	Se devuelve el código de verificación generado para ese certificado.
Other Status Codes	ErrorDetails	Respuesta de error predeterminada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
CertificatePurpose	Descripción que menciona el propósito del certificado.
ErrorDetails	Detalles del error.
Properties
VerificationCodeResponse	Descripción de la respuesta del código de verificación.

CertificatePurpose

Descripción que menciona el propósito del certificado.

Nombre	Tipo	Description
clientAuthentication	string
serverAuthentication	string

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	integer	Código de error.
details	string	Los detalles del error.
httpStatusCode	string	El código de estado HTTP.
message	string	El mensaje de error.

Properties

Nombre	Tipo	Description
certificate	string	representación base 64 del certificado X509 .cer archivo o solo contenido del archivo .pem.
created	string	Hora de creación del certificado.
expiry	string	Expiración del código.
isVerified	boolean	Indique si el propietario de la clave privada comprueba el certificado.
subject	string	Asunto del certificado.
thumbprint	string	Huella digital del certificado.
updated	string	Hora de actualización del certificado.
verificationCode	string	Código de verificación.

VerificationCodeResponse

Descripción de la respuesta del código de verificación.

Nombre	Tipo	Description
etag	string	Solicitar etag.
id	string	Identificador del recurso.
name	string	Nombre del certificado.
properties	Properties
type	string	El tipo de recurso.