你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Dps Certificate - Generate Verification Code

参考

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

为所有权证明生成验证码。

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

URI 参数

名称	在	必需	类型	说明
certificateName	path	True	string	预配服务用于访问的证书的必需逻辑名称。
provisioningServiceName	path	True	string	预配服务的名称。
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 的版本。
certificate.created	query		string date-time	证书创建时间。
certificate.hasPrivateKey	query		boolean	指示证书是否包含私钥。
certificate.isVerified	query		boolean	指示证书是否已由私钥的所有者验证。
certificate.lastUpdated	query		string date-time	证书上次更新时间。
certificate.name	query		string	证书的公用名。
certificate.nonce	query		string	为指示所有权证明而生成的随机数。
certificate.purpose	query		CertificatePurpose	提及证书用途的说明。
certificate.rawBytes	query		string byte	证书的原始数据。

请求头

名称	必需	类型	说明
If-Match	True	string	证书的 ETag。这是更新现有证书所必需的，在创建全新的证书时将被忽略。

响应

名称	类型	说明
200 OK	VerificationCodeResponse	返回该证书的生成验证码。
Other Status Codes	ErrorDetails	默认错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

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

定义

名称	说明
CertificatePurpose	提及证书用途的说明。
ErrorDetails	错误详细信息。
Properties
VerificationCodeResponse	验证码响应的说明。

CertificatePurpose

提及证书用途的说明。

名称	类型	说明
clientAuthentication	string
serverAuthentication	string

ErrorDetails

错误详细信息。

名称	类型	说明
code	integer	错误代码。
details	string	错误详细信息。
httpStatusCode	string	HTTP 状态代码。
message	string	错误消息。

Properties

名称	类型	说明
certificate	string	x509 证书.cer文件或仅 .pem 文件内容的 base-64 表示形式。
created	string	证书创建时间。
expiry	string	代码过期。
isVerified	boolean	指示证书是否由私钥的所有者验证。
subject	string	证书使用者。
thumbprint	string	证书指纹。
updated	string	证书更新时间。
verificationCode	string	验证码。

VerificationCodeResponse

验证码响应的说明。

名称	类型	说明
etag	string	请求 etag。
id	string	资源标识符。
name	string	证书的名称。
properties	Properties
type	string	资源类型。

通过