RestorableDatabaseAccountsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosDBManagementClient's

<xref:restorable_database_accounts> attribute.

Inheritance

builtins.object

RestorableDatabaseAccountsOperations

Constructor

RestorableDatabaseAccountsOperations(*args, **kwargs)

Methods

get_by_location	Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/>>*<<' permission.
list	Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.
list_by_location	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.

get_by_location

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

get_by_location(location: str, instance_id: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.RestorableDatabaseAccountGetResult

Parameters

location

str

Required

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

instance_id

str

Required

The instanceId GUID of a restorable database account.

cls

callable

A custom type or function that will be passed the direct response

Returns

RestorableDatabaseAccountGetResult, or the result of cls(response)

Return type

RestorableDatabaseAccountGetResult

Exceptions

HttpResponseError

list

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

list(**kwargs: Any) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableDatabaseAccountsListResult]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableDatabaseAccountsListResult or the result of cls(response)

Return type

ItemPaged[RestorableDatabaseAccountsListResult]

Exceptions

HttpResponseError

list_by_location

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.

list_by_location(location: str, **kwargs: Any) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableDatabaseAccountsListResult]

Parameters

location

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableDatabaseAccountsListResult or the result of cls(response)

Return type

ItemPaged[RestorableDatabaseAccountsListResult]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>