KeyVaultClientExtensions.GetDeletedCertificatesAsync(IKeyVaultClient, String, Nullable<Int32>, Nullable<Boolean>, CancellationToken) Method

Definition

Lists the deleted certificates in the specified vault currently available for recovery.

public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedCertificateItem>> GetDeletedCertificatesAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, int? maxresults = default, bool? includePending = default, System.Threading.CancellationToken cancellationToken = default);
static member GetDeletedCertificatesAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedCertificateItem>>
<Extension()>
Public Function GetDeletedCertificatesAsync (operations As IKeyVaultClient, vaultBaseUrl As String, Optional maxresults As Nullable(Of Integer) = Nothing, Optional includePending As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of DeletedCertificateItem))

Parameters

operations
IKeyVaultClient

The operations group for this extension method.

vaultBaseUrl
String

The vault name, for example https://myvault.vault.azure.net.

maxresults
Nullable<Int32>

Maximum number of results to return in a page. If not specified the service will return up to 25 results.

includePending
Nullable<Boolean>

Specifies whether to include certificates which are not completely provisioned.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<IPage<DeletedCertificateItem>>

Remarks

The GetDeletedCertificates operation retrieves the certificates in the

current vault which are in a deleted state and ready for recovery or

purging. This operation includes deletion-specific information. This

operation requires the certificates/get/list permission. This operation can

only be enabled on soft-delete enabled vaults.

Applies to