Dps Certificate - Generate Verification Code

Reference

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Vygenerujte ověřovací kód pro doklad o vlastnictví.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
certificateName	path	True	string	Povinný logický název certifikátu, který služba zřizování používá pro přístup.
provisioningServiceName	path	True	string	Název služby zřizování
resourceGroupName	path	True	string	název skupiny prostředků.
subscriptionId	path	True	string	Identifikátor předplatného.
api-version	query	True	string	Verze rozhraní API
certificate.created	query		string date-time	Čas vytvoření certifikátu.
certificate.hasPrivateKey	query		boolean	Označuje, jestli certifikát obsahuje privátní klíč.
certificate.isVerified	query		boolean	Označuje, jestli byl certifikát ověřen vlastníkem privátního klíče.
certificate.lastUpdated	query		string date-time	Čas poslední aktualizace certifikátu
certificate.name	query		string	Běžný název certifikátu.
certificate.nonce	query		string	Náhodné číslo vygenerované pro označení dokladu o vlastnictví.
certificate.purpose	query		CertificatePurpose	Popis zmiňující účel certifikátu.
certificate.rawBytes	query		string byte	Nezpracovaná data certifikátu.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match	True	string	Značka ETag certifikátu. To se vyžaduje k aktualizaci existujícího certifikátu a při vytváření úplně nového certifikátu se ignoruje.

Odpovědi

Name	Typ	Description
200 OK	VerificationCodeResponse	Vrátí se vygenerovaný ověřovací kód pro tento certifikát.
Other Status Codes	ErrorDetails	Výchozí odpověď na chybu.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
CertificatePurpose	Popis zmiňující účel certifikátu.
ErrorDetails	Podrobnosti o chybě.
Properties
VerificationCodeResponse	Popis odpovědi ověřovacího kódu

CertificatePurpose

Popis zmiňující účel certifikátu.

Name	Typ	Description
clientAuthentication	string
serverAuthentication	string

ErrorDetails

Podrobnosti o chybě.

Name	Typ	Description
code	integer	Kód chyby
details	string	Podrobnosti o chybě
httpStatusCode	string	Stavový kód HTTP
message	string	Chybová zpráva

Properties

Name	Typ	Description
certificate	string	base-64 reprezentace certifikátu X509 .cer souboru nebo jenom obsahu souboru .pem.
created	string	Čas vytvoření certifikátu
expiry	string	Vypršení platnosti kódu.
isVerified	boolean	Uveďte, jestli je certifikát ověřený vlastníkem privátního klíče.
subject	string	Předmět certifikátu.
thumbprint	string	Kryptografický otisk certifikátu.
updated	string	Čas aktualizace certifikátu
verificationCode	string	Ověřovací kód.

VerificationCodeResponse

Popis odpovědi ověřovacího kódu

Name	Typ	Description
etag	string	Vyžádat etag.
id	string	Identifikátor prostředku.
name	string	Název certifikátu.
properties	Properties
type	string	Typ prostředku.

Share via