Interface RestorableDatabaseAccounts

Package version

Interface representing a RestorableDatabaseAccounts.

Hierarchy

RestorableDatabaseAccounts

Implemented by

RestorableDatabaseAccountsImpl

Index

Methods

Methods

getByLocation

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

- Defined in operationsInterfaces/restorableDatabaseAccounts.ts:47
Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.

Parameters
- location: string
  
  Cosmos DB region, with spaces between words and each word capitalized.
- instanceId: string
  
  The instanceId GUID of a restorable database account.
- Optional options: RestorableDatabaseAccountsGetByLocationOptionalParams
  
  The options parameters.
Returns Promise<RestorableDatabaseAccountsGetByLocationResponse>

list

list(options?: RestorableDatabaseAccountsListOptionalParams): PagedAsyncIterableIterator<RestorableDatabaseAccountGetResult>

- Defined in operationsInterfaces/restorableDatabaseAccounts.ts:37
Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.

Parameters
- Optional options: RestorableDatabaseAccountsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<RestorableDatabaseAccountGetResult>

listByLocation

listByLocation(location: string, options?: RestorableDatabaseAccountsListByLocationOptionalParams): PagedAsyncIterableIterator<RestorableDatabaseAccountGetResult>

- Defined in operationsInterfaces/restorableDatabaseAccounts.ts:28
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.

Parameters
- location: string
  
  Cosmos DB region, with spaces between words and each word capitalized.
- Optional options: RestorableDatabaseAccountsListByLocationOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<RestorableDatabaseAccountGetResult>

Generated using TypeDoc