Dps Certificate - Verify Certificate

參考

服務:: IoT Hub Device Provisioning Service

API 版本:: 2022-12-12

確認憑證的私鑰擁有權。
提供驗證預先上傳憑證所簽發的分葉憑證，以驗證憑證的私鑰擁有權。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify?api-version=2022-12-12

含選擇性參數:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify?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
certificate	string	X509 憑證的base-64表示法.cer檔案或僅 .pem 檔案內容。

回應

名稱	類型	Description
200 OK	CertificateResponse	確定
Other Status Codes	ErrorDetails	默認錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

DPSVerifyCertificate

範例要求

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/certificates/cert/verify?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


{
  "certificate": "#####################################"
}

範例回覆

狀態碼:: 200

{
  "properties": {
    "subject": "CN=andbucdevice1",
    "expiry": "Sat, 31 Dec 2039 23:59:59 GMT",
    "certificate": "MA==",
    "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25",
    "isVerified": true,
    "created": "Thu, 12 Oct 2017 19:23:50 GMT",
    "updated": "Thu, 12 Oct 2017 19:26:56 GMT"
  },
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/certificates/cert",
  "name": "cert",
  "type": "Microsoft.Devices/ProvisioningServices/Certificates",
  "etag": "AAAAAAExpTQ="
}

定義

名稱	Description
CertificateProperties	X509 CA 憑證的描述。
CertificatePurpose	描述憑證的用途。
CertificateResponse	X509 憑證。
createdByType	建立資源的身分識別類型。
ErrorDetails	錯誤詳細數據。
systemData	與建立和上次修改資源相關的元數據。
VerificationCodeRequest	JSON 串行化的分葉憑證

CertificateProperties

X509 CA 憑證的描述。

名稱	類型	Description
certificate	string	X509 憑證的base-64表示法.cer檔案或僅 .pem 檔案內容。
created	string	憑證的建立日期和時間。
expiry	string	憑證的到期日期和時間。
isVerified	boolean	判斷是否已驗證憑證。
subject	string	憑證的主體名稱。
thumbprint	string	憑證的指紋。
updated	string	憑證的上次更新日期和時間。

CertificatePurpose

描述憑證的用途。

名稱	類型	Description
clientAuthentication	string
serverAuthentication	string

CertificateResponse

X509 憑證。

名稱	類型	Description
etag	string	實體標記。
id	string	資源標識碼。
name	string	憑證的名稱。
properties	CertificateProperties	憑證的屬性
systemData	systemData	與建立和上次修改資源相關的元數據。
type	string	資源類型。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

錯誤詳細數據。

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

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

VerificationCodeRequest

JSON 串行化的分葉憑證

名稱	類型	Description
certificate	string	X509 憑證的base-64表示法.cer檔案或僅 .pem 檔案內容。

共用方式為