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) -> RestorableDatabaseAccountGetResult

Parameters

Name	Description
location Required	str Cosmos DB region, with spaces between words and each word capitalized. Required.
instance_id Required	str The instanceId GUID of a restorable database account. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
RestorableDatabaseAccountGetResult	RestorableDatabaseAccountGetResult or the result of cls(response)

Exceptions

Type	Description
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[RestorableDatabaseAccountGetResult]

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[RestorableDatabaseAccountGetResult]	An iterator like instance of either RestorableDatabaseAccountGetResult or the result of cls(response)

Exceptions

Type	Description
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[RestorableDatabaseAccountGetResult]

Parameters

Name	Description
location Required	str Cosmos DB region, with spaces between words and each word capitalized. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[RestorableDatabaseAccountGetResult]	An iterator like instance of either RestorableDatabaseAccountGetResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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