Dps Certificate - Generate Verification Code

Referência

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Gerar código de verificação para Prova de Posse.

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 URI

Nome	Em	Obrigatório	Tipo	Description
certificateName	path	True	string	O nome lógico obrigatório do certificado que o serviço de provisionamento usa para acessar.
provisioningServiceName	path	True	string	Nome do serviço de provisionamento.
resourceGroupName	path	True	string	nome do grupo de recursos.
subscriptionId	path	True	string	O identificador da assinatura.
api-version	query	True	string	A versão da API.
certificate.created	query		string date-time	Hora de criação do certificado.
certificate.hasPrivateKey	query		boolean	Indica se o certificado contém chave privada.
certificate.isVerified	query		boolean	Indica se o certificado foi verificado pelo proprietário da chave privada.
certificate.lastUpdated	query		string date-time	Hora da última atualização do certificado.
certificate.name	query		string	Nome Comum para o certificado.
certificate.nonce	query		string	Número aleatório gerado para indicar Prova de Posse.
certificate.purpose	query		CertificatePurpose	Descrição mencionando a finalidade do certificado.
certificate.rawBytes	query		string byte	Dados brutos do certificado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
If-Match	True	string	ETag do certificado. Isso é necessário para atualizar um certificado existente e ignorado ao criar um novo certificado.

Respostas

Nome	Tipo	Description
200 OK	VerificationCodeResponse	O código de verificação gerado para esse certificado é retornado.
Other Status Codes	ErrorDetails	Resposta de erro padrão.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
CertificatePurpose	Descrição mencionando a finalidade do certificado.
ErrorDetails	Detalhes do erro.
Properties
VerificationCodeResponse	Descrição da resposta do código de verificação.

CertificatePurpose

Descrição mencionando a finalidade do certificado.

Nome	Tipo	Description
clientAuthentication	string
serverAuthentication	string

ErrorDetails

Detalhes do erro.

Nome	Tipo	Description
code	integer	O código de erro.
details	string	Os detalhes do erro.
httpStatusCode	string	O código de status do HTTP.
message	string	A mensagem de erro.

Properties

Nome	Tipo	Description
certificate	string	representação base-64 do certificado X509 .cer arquivo ou apenas o conteúdo do arquivo .pem.
created	string	Tempo de criação do certificado.
expiry	string	Expiração do código.
isVerified	boolean	Indique se o certificado é verificado pelo proprietário da chave privada.
subject	string	Entidade do certificado.
thumbprint	string	Impressão digital do certificado.
updated	string	Tempo de atualização do certificado.
verificationCode	string	Código de verificação.

VerificationCodeResponse

Descrição da resposta do código de verificação.

Nome	Tipo	Description
etag	string	Solicitar etag.
id	string	O identificador do recurso.
name	string	Nome do certificado.
properties	Properties
type	string	O tipo de recurso.