RestorableDatabaseAccounts interface

Package:

@azure/arm-cosmosdb

Interface representing a RestorableDatabaseAccounts.

Methods

getByLocation(string, string, RestorableDatabaseAccountsGetByLocationOptionalParams)	Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.
list(RestorableDatabaseAccountsListOptionalParams)	Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.
listByLocation(string, RestorableDatabaseAccountsListByLocationOptionalParams)	Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.

Method Details

getByLocation(string, string, RestorableDatabaseAccountsGetByLocationOptionalParams)

Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.

function getByLocation(location: string, instanceId: string, options?: RestorableDatabaseAccountsGetByLocationOptionalParams): Promise<RestorableDatabaseAccountGetResult>

Parameters

location

string

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

instanceId

string

The instanceId GUID of a restorable database account.

options

RestorableDatabaseAccountsGetByLocationOptionalParams

The options parameters.

Returns

Promise<RestorableDatabaseAccountGetResult>

list(RestorableDatabaseAccountsListOptionalParams)

Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.

function list(options?: RestorableDatabaseAccountsListOptionalParams): PagedAsyncIterableIterator<RestorableDatabaseAccountGetResult, RestorableDatabaseAccountGetResult[], PageSettings>

Parameters

options

RestorableDatabaseAccountsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RestorableDatabaseAccountGetResult, RestorableDatabaseAccountGetResult[], PageSettings>

listByLocation(string, RestorableDatabaseAccountsListByLocationOptionalParams)

Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.

function listByLocation(location: string, options?: RestorableDatabaseAccountsListByLocationOptionalParams): PagedAsyncIterableIterator<RestorableDatabaseAccountGetResult, RestorableDatabaseAccountGetResult[], PageSettings>

Parameters

location

string

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

options

RestorableDatabaseAccountsListByLocationOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RestorableDatabaseAccountGetResult, RestorableDatabaseAccountGetResult[], PageSettings>