IRestorableMongodbResourcesOperations.ListWithHttpMessagesAsync Method

Definition

Return a list of database and collection combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<System.Collections.Generic.IEnumerable<Microsoft.Azure.Management.CosmosDB.Models.DatabaseRestoreResource>>> ListWithHttpMessagesAsync (string location, string instanceId, string restoreLocation = default, string restoreTimestampInUtc = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ListWithHttpMessagesAsync : string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<seq<Microsoft.Azure.Management.CosmosDB.Models.DatabaseRestoreResource>>>
Public Function ListWithHttpMessagesAsync (location As String, instanceId As String, Optional restoreLocation As String = Nothing, Optional restoreTimestampInUtc As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IEnumerable(Of DatabaseRestoreResource)))

Parameters

location
String

Cosmos DB region, with spaces between words and each word capitalized.

instanceId
String

The instanceId GUID of a restorable database account.

restoreLocation
String

The location where the restorable resources are located.

restoreTimestampInUtc
String

The timestamp when the restorable resources existed.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to