Dps Certificate - Generate Verification Code

Odwołanie

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Generowanie kodu weryfikacyjnego na potrzeby weryfikacji posiadania.

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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
certificateName	path	True	string	Obowiązkowa nazwa logiczna certyfikatu używana przez usługę aprowizacji do uzyskiwania dostępu.
provisioningServiceName	path	True	string	Nazwa usługi aprowizacji.
resourceGroupName	path	True	string	nazwa grupy zasobów.
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API.
certificate.created	query		string date-time	Czas tworzenia certyfikatu.
certificate.hasPrivateKey	query		boolean	Wskazuje, czy certyfikat zawiera klucz prywatny.
certificate.isVerified	query		boolean	Wskazuje, czy certyfikat został zweryfikowany przez właściciela klucza prywatnego.
certificate.lastUpdated	query		string date-time	Czas ostatniej aktualizacji certyfikatu.
certificate.name	query		string	Nazwa pospolita certyfikatu.
certificate.nonce	query		string	Liczba losowa wygenerowana w celu wskazania dowodu posiadania.
certificate.purpose	query		CertificatePurpose	Opis przedstawiający przeznaczenie certyfikatu.
certificate.rawBytes	query		string byte	Nieprzetworzone dane certyfikatu.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-Match	True	string	ETag certyfikatu. Jest to wymagane do zaktualizowania istniejącego certyfikatu i zignorowane podczas tworzenia zupełnie nowego certyfikatu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	VerificationCodeResponse	Wygenerowany kod weryfikacyjny dla tego certyfikatu jest zwracany.
Other Status Codes	ErrorDetails	Domyślna odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
CertificatePurpose	Opis przedstawiający przeznaczenie certyfikatu.
ErrorDetails	Szczegóły błędu.
Properties
VerificationCodeResponse	Opis odpowiedzi kodu weryfikacyjnego.

CertificatePurpose

Opis przedstawiający przeznaczenie certyfikatu.

Nazwa	Typ	Opis
clientAuthentication	string
serverAuthentication	string

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	integer	Kod błędu.
details	string	Szczegóły błędu.
httpStatusCode	string	Kod stanu HTTP.
message	string	Komunikat o błędzie.

Properties

Nazwa	Typ	Opis
certificate	string	base-64 reprezentacja certyfikatu X509 .cer pliku lub tylko zawartość pliku pem.
created	string	Czas utworzenia certyfikatu.
expiry	string	Wygaśnięcie kodu.
isVerified	boolean	Określ, czy certyfikat został zweryfikowany przez właściciela klucza prywatnego.
subject	string	Podmiot certyfikatu.
thumbprint	string	Odcisk palca certyfikatu.
updated	string	Czas aktualizacji certyfikatu.
verificationCode	string	Kod weryfikacyjny.

VerificationCodeResponse

Opis odpowiedzi kodu weryfikacyjnego.

Nazwa	Typ	Opis
etag	string	Żądanie etagu.
id	string	Identyfikator zasobu.
name	string	Nazwa certyfikatu.
properties	Properties
type	string	Typ zasobu.