Dps Certificate - Generate Verification Code

リファレンス

サービス:: 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}/generateVerificationCode?api-version=2022-12-12

省略可能なパラメーターを含む:

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 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

DPSGenerateVerificationCode

要求のサンプル

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

応答のサンプル

状態コード:: 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 証明書の base-64 表現.cerファイルまたは .pem ファイルの内容のみ。
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	リソースの種類。

次の方法で共有