KeyVaultClient.GetDeletedSasDefinitionsWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Package:

Microsoft.Azure.KeyVault v3.0.5

Source:

KeyVaultClient.cs

Lists deleted SAS definitions for the specified vault and storage account.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedSasDefinitionItem>>> GetDeletedSasDefinitionsWithHttpMessagesAsync (string vaultBaseUrl, string storageAccountName, int? maxresults = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDeletedSasDefinitionsWithHttpMessagesAsync : string * string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedSasDefinitionItem>>>
override this.GetDeletedSasDefinitionsWithHttpMessagesAsync : string * string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedSasDefinitionItem>>>

Public Function GetDeletedSasDefinitionsWithHttpMessagesAsync (vaultBaseUrl As String, storageAccountName As String, Optional maxresults As Nullable(Of Integer) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of DeletedSasDefinitionItem)))

Parameters

vaultBaseUrl

String

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

storageAccountName

String

The name of the storage account.

maxresults

Nullable<Int32>

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

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IPage<DeletedSasDefinitionItem>>>

Implements

GetDeletedSasDefinitionsWithHttpMessagesAsync(String, String, Nullable<Int32>, Dictionary<String,List<String>>, CancellationToken)

Exceptions

KeyVaultErrorException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null

Remarks

The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.