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 參數

名稱	位於	必要	類型	Description
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	憑證的原始數據。

要求標頭

名稱	必要	類型	Description
If-Match	True	string	憑證的 ETag。這是更新現有憑證的必要專案，並在建立全新的憑證時予以忽略。

回應

名稱	類型	Description
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

名稱	Description
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"
  }
}

定義

名稱	Description
CertificatePurpose	描述提及憑證的目的。
ErrorDetails	錯誤詳細數據。
Properties
VerificationCodeResponse	驗證碼回應的描述。

CertificatePurpose

描述提及憑證的目的。

名稱	類型	Description
clientAuthentication	string
serverAuthentication	string

ErrorDetails

錯誤詳細數據。

名稱	類型	Description
code	integer	錯誤碼。
details	string	錯誤詳細資料。
httpStatusCode	string	HTTP 狀態碼。
message	string	錯誤訊息。

Properties

名稱	類型	Description
certificate	string	X509 憑證的base-64表示法.cer檔案或僅 .pem 檔案內容。
created	string	憑證建立時間。
expiry	string	程式代碼到期。
isVerified	boolean	指出憑證是否由私鑰的擁有者驗證。
subject	string	憑證主體。
thumbprint	string	憑證指紋。
updated	string	憑證更新時間。
verificationCode	string	驗證碼。

VerificationCodeResponse

驗證碼回應的描述。

名稱	類型	Description
etag	string	要求 etag。
id	string	資源標識碼。
name	string	憑證的名稱。
properties	Properties
type	string	資源類型。