Dps Certificate - Verify Certificate

Odwołanie

Usługa:: IoT Hub Device Provisioning Service

Wersja interfejsu API:: 2022-12-12

Sprawdź posiadanie klucza prywatnego certyfikatu.
Weryfikuje posiadanie klucza prywatnego certyfikatu, podając certyfikat liścia wystawiony przez weryfikowanie wstępnie przekazanego certyfikatu.

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

Z parametrami opcjonalnymi:

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

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	Opisz przeznaczenie certyfikatu.
certificate.rawBytes	query		string byte	Nieprzetworzone dane certyfikatu.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-Match	True	string	ETag certyfikatu.

Treść żądania

Nazwa	Typ	Opis
certificate	string	base-64 reprezentacja certyfikatu X509 .cer pliku lub tylko zawartość pliku pem.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CertificateResponse	OK
Other Status Codes	ErrorDetails	Domyślna odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

DPSVerifyCertificate

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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="
}

Definicje

Nazwa	Opis
CertificateProperties	Opis certyfikatu urzędu certyfikacji X509.
CertificatePurpose	Opisz przeznaczenie certyfikatu.
CertificateResponse	Certyfikat X509.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorDetails	Szczegóły błędu.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
VerificationCodeRequest	Certyfikat liścia serializowanego w formacie JSON

CertificateProperties

Opis certyfikatu urzędu certyfikacji X509.

Nazwa	Typ	Opis
certificate	string	base-64 reprezentacja certyfikatu X509 .cer pliku lub tylko zawartość pliku pem.
created	string	Data i godzina utworzenia certyfikatu.
expiry	string	Data i godzina wygaśnięcia certyfikatu.
isVerified	boolean	Określa, czy certyfikat został zweryfikowany.
subject	string	Nazwa podmiotu certyfikatu.
thumbprint	string	Odcisk palca certyfikatu.
updated	string	Data i godzina ostatniej aktualizacji certyfikatu.

CertificatePurpose

Opisz przeznaczenie certyfikatu.

Nazwa	Typ	Opis
clientAuthentication	string
serverAuthentication	string

CertificateResponse

Certyfikat X509.

Nazwa	Typ	Opis
etag	string	Tag jednostki.
id	string	Identyfikator zasobu.
name	string	Nazwa certyfikatu.
properties	CertificateProperties	właściwości certyfikatu
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
type	string	Typ zasobu.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	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.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

VerificationCodeRequest

Certyfikat liścia serializowanego w formacie JSON

Nazwa	Typ	Opis
certificate	string	base-64 reprezentacja certyfikatu X509 .cer pliku lub tylko zawartość pliku pem.

Udostępnij za pośrednictwem