Share via


DeviceProvisioningServicesCertificateResource.VerifyCertificateAsync Method

Definition

Overloads

VerifyCertificateAsync(DeviceProvisioningServicesCertificateResourceVerifyCertificateOptions, CancellationToken)

Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify
  • Operation Id: DpsCertificate_VerifyCertificate
VerifyCertificateAsync(String, CertificateVerificationCodeContent, String, Byte[], Nullable<Boolean>, Nullable<DeviceProvisioningServicesCertificatePurpose>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Boolean>, String, CancellationToken)

Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify
  • Operation Id: DpsCertificate_VerifyCertificate

VerifyCertificateAsync(DeviceProvisioningServicesCertificateResourceVerifyCertificateOptions, CancellationToken)

Source:
DeviceProvisioningServicesCertificateResource.cs
Source:
DeviceProvisioningServicesCertificateResource.cs

Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify
  • Operation Id: DpsCertificate_VerifyCertificate
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DeviceProvisioningServices.DeviceProvisioningServicesCertificateResource>> VerifyCertificateAsync (Azure.ResourceManager.DeviceProvisioningServices.Models.DeviceProvisioningServicesCertificateResourceVerifyCertificateOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member VerifyCertificateAsync : Azure.ResourceManager.DeviceProvisioningServices.Models.DeviceProvisioningServicesCertificateResourceVerifyCertificateOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DeviceProvisioningServices.DeviceProvisioningServicesCertificateResource>>
override this.VerifyCertificateAsync : Azure.ResourceManager.DeviceProvisioningServices.Models.DeviceProvisioningServicesCertificateResourceVerifyCertificateOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DeviceProvisioningServices.DeviceProvisioningServicesCertificateResource>>
Public Overridable Function VerifyCertificateAsync (options As DeviceProvisioningServicesCertificateResourceVerifyCertificateOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DeviceProvisioningServicesCertificateResource))

Parameters

options
DeviceProvisioningServicesCertificateResourceVerifyCertificateOptions

A property bag which contains all the parameters of this method except the LRO qualifier and request context parameter.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

options is null.

Applies to

VerifyCertificateAsync(String, CertificateVerificationCodeContent, String, Byte[], Nullable<Boolean>, Nullable<DeviceProvisioningServicesCertificatePurpose>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Boolean>, String, CancellationToken)

Source:
DeviceProvisioningServicesCertificateResource.cs
Source:
DeviceProvisioningServicesCertificateResource.cs

Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify
  • Operation Id: DpsCertificate_VerifyCertificate
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DeviceProvisioningServices.DeviceProvisioningServicesCertificateResource>> VerifyCertificateAsync (string ifMatch, Azure.ResourceManager.DeviceProvisioningServices.Models.CertificateVerificationCodeContent content, string certificateCommonName = default, byte[] certificateRawBytes = default, bool? certificateIsVerified = default, Azure.ResourceManager.DeviceProvisioningServices.Models.DeviceProvisioningServicesCertificatePurpose? certificatePurpose = default, DateTimeOffset? certificateCreatedOn = default, DateTimeOffset? certificateLastUpdatedOn = default, bool? certificateHasPrivateKey = default, string certificateNonce = default, System.Threading.CancellationToken cancellationToken = default);
abstract member VerifyCertificateAsync : string * Azure.ResourceManager.DeviceProvisioningServices.Models.CertificateVerificationCodeContent * string * byte[] * Nullable<bool> * Nullable<Azure.ResourceManager.DeviceProvisioningServices.Models.DeviceProvisioningServicesCertificatePurpose> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DeviceProvisioningServices.DeviceProvisioningServicesCertificateResource>>
override this.VerifyCertificateAsync : string * Azure.ResourceManager.DeviceProvisioningServices.Models.CertificateVerificationCodeContent * string * byte[] * Nullable<bool> * Nullable<Azure.ResourceManager.DeviceProvisioningServices.Models.DeviceProvisioningServicesCertificatePurpose> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DeviceProvisioningServices.DeviceProvisioningServicesCertificateResource>>
Public Overridable Function VerifyCertificateAsync (ifMatch As String, content As CertificateVerificationCodeContent, Optional certificateCommonName As String = Nothing, Optional certificateRawBytes As Byte() = Nothing, Optional certificateIsVerified As Nullable(Of Boolean) = Nothing, Optional certificatePurpose As Nullable(Of DeviceProvisioningServicesCertificatePurpose) = Nothing, Optional certificateCreatedOn As Nullable(Of DateTimeOffset) = Nothing, Optional certificateLastUpdatedOn As Nullable(Of DateTimeOffset) = Nothing, Optional certificateHasPrivateKey As Nullable(Of Boolean) = Nothing, Optional certificateNonce As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DeviceProvisioningServicesCertificateResource))

Parameters

ifMatch
String

ETag of the certificate.

content
CertificateVerificationCodeContent

The name of the certificate.

certificateCommonName
String

Common Name for the certificate.

certificateRawBytes
Byte[]

Raw data of certificate.

certificateIsVerified
Nullable<Boolean>

Indicates if the certificate has been verified by owner of the private key.

certificatePurpose
Nullable<DeviceProvisioningServicesCertificatePurpose>

Describe the purpose of the certificate.

certificateCreatedOn
Nullable<DateTimeOffset>

Certificate creation time.

certificateLastUpdatedOn
Nullable<DateTimeOffset>

Certificate last updated time.

certificateHasPrivateKey
Nullable<Boolean>

Indicates if the certificate contains private key.

certificateNonce
String

Random number generated to indicate Proof of Possession.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

ifMatch or content is null.

Applies to