DeviceProvisioningServicesCertificateResource.DeleteAsync Method

Definition

Overloads

DeleteAsync(WaitUntil, DeviceProvisioningServicesCertificateResourceDeleteOptions, CancellationToken)

Deletes the specified certificate associated with the Provisioning Service

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

Deletes the specified certificate associated with the Provisioning Service

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

DeleteAsync(WaitUntil, DeviceProvisioningServicesCertificateResourceDeleteOptions, CancellationToken)

Source:
DeviceProvisioningServicesCertificateResource.cs
Source:
DeviceProvisioningServicesCertificateResource.cs

Deletes the specified certificate associated with the Provisioning Service

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

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

options
DeviceProvisioningServicesCertificateResourceDeleteOptions

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

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

Source:
DeviceProvisioningServicesCertificateResource.cs
Source:
DeviceProvisioningServicesCertificateResource.cs

Deletes the specified certificate associated with the Provisioning Service

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}
  • Operation Id: DpsCertificate_Delete
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> DeleteAsync (Azure.WaitUntil waitUntil, 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 DeleteAsync : Azure.WaitUntil * 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.ResourceManager.ArmOperation>
override this.DeleteAsync : Azure.WaitUntil * 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.ResourceManager.ArmOperation>
Public Overridable Function DeleteAsync (waitUntil As WaitUntil, 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 ArmOperation)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

ifMatch
String

ETag of the certificate.

certificateCommonName
String

This is optional, and it is the Common Name of the certificate.

certificateRawBytes
Byte[]

Raw data within the certificate.

certificateIsVerified
Nullable<Boolean>

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

certificatePurpose
Nullable<DeviceProvisioningServicesCertificatePurpose>

A description that mentions the purpose of the certificate.

certificateCreatedOn
Nullable<DateTimeOffset>

Time the certificate is created.

certificateLastUpdatedOn
Nullable<DateTimeOffset>

Time the certificate is last updated.

certificateHasPrivateKey
Nullable<Boolean>

Indicates if the certificate contains a 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