Share via


DeviceProvisioningServicesCertificateResource.GenerateVerificationCodeAsync Method

Definition

Overloads

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

Generate verification code for Proof of Possession.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode
  • Operation Id: DpsCertificate_GenerateVerificationCode
GenerateVerificationCodeAsync(DeviceProvisioningServicesCertificateResourceGenerateVerificationCodeOptions, CancellationToken)

Generate verification code for Proof of Possession.

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

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

Source:
DeviceProvisioningServicesCertificateResource.cs
Source:
DeviceProvisioningServicesCertificateResource.cs

Generate verification code for Proof of Possession.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode
  • Operation Id: DpsCertificate_GenerateVerificationCode
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DeviceProvisioningServices.Models.CertificateVerificationCodeResult>> GenerateVerificationCodeAsync (string ifMatch, 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 GenerateVerificationCodeAsync : string * 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.Models.CertificateVerificationCodeResult>>
override this.GenerateVerificationCodeAsync : string * 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.Models.CertificateVerificationCodeResult>>
Public Overridable Function GenerateVerificationCodeAsync (ifMatch As String, 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 CertificateVerificationCodeResult))

Parameters

ifMatch
String

ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new 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>

Description mentioning 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 is null.

Applies to

GenerateVerificationCodeAsync(DeviceProvisioningServicesCertificateResourceGenerateVerificationCodeOptions, CancellationToken)

Source:
DeviceProvisioningServicesCertificateResource.cs
Source:
DeviceProvisioningServicesCertificateResource.cs

Generate verification code for Proof of Possession.

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

Parameters

options
DeviceProvisioningServicesCertificateResourceGenerateVerificationCodeOptions

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