Dps Certificate - Generate Verification Code

Referência

Serviço:: IoT Hub Device Provisioning Service

Versão da API:: 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

Com parâmetros opcionais:

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 do URI

Name	Em	Necessário	Tipo	Description
certificateName	path	True	string	O nome lógico obrigatório do certificado, que o serviço de aprovisionamento utiliza para aceder.
provisioningServiceName	path	True	string	Nome do serviço de aprovisionamento.
resourceGroupName	path	True	string	nome do grupo de recursos.
subscriptionId	path	True	string	O identificador da subscrição.
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 a 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 que menciona a finalidade do certificado.
certificate.rawBytes	query		string byte	Dados não processados do certificado.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-Match	True	string	ETag do certificado. Isto é necessário para atualizar um certificado existente e ignorado ao criar um certificado novo.

Respostas

Name	Tipo	Description
200 OK	VerificationCodeResponse	É devolvido o código de verificação gerado para esse certificado.
Other Status Codes	ErrorDetails	Resposta de erro predefinida.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

DPSGenerateVerificationCode

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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

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

CertificatePurpose

Descrição que menciona a finalidade do certificado.

Name	Tipo	Description
clientAuthentication	string
serverAuthentication	string

ErrorDetails

Detalhes do erro.

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

Properties

Name	Tipo	Description
certificate	string	representação base 64 do certificado X509 .cer ficheiro ou apenas conteúdo de ficheiro .pem.
created	string	Hora 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	Assunto do certificado.
thumbprint	string	Thumbprint do certificado.
updated	string	Hora de atualização do certificado.
verificationCode	string	Código de verificação.

VerificationCodeResponse

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

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

Partilhar via