restorable_database_accounts

Creates, updates, deletes, gets or lists a restorable_database_accounts resource.

Overview

Name	restorable_database_accounts
Type	Resource
Id	azure.cosmos_db.restorable_database_accounts

Fields

The following fields are returned by SELECT queries:

get_by_location

The restorable database account properties were retrieved successfully.

Name	Datatype	Description
id	string	The unique resource identifier of the ARM resource.
name	string	The name of the ARM resource.
location	string	The location of the resource group to which the resource belongs.
properties	object	The properties of a restorable database account.
type	string	The type of Azure resource.

list_by_location

The operation completed successfully.

Name	Datatype	Description
id	string	The unique resource identifier of the ARM resource.
name	string	The name of the ARM resource.
location	string	The location of the resource group to which the resource belongs.
properties	object	The properties of a restorable database account.
type	string	The type of Azure resource.

list

The operation completed successfully.

Name	Datatype	Description
id	string	The unique resource identifier of the ARM resource.
name	string	The name of the ARM resource.
location	string	The location of the resource group to which the resource belongs.
properties	object	The properties of a restorable database account.
type	string	The type of Azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_location	select	subscriptionId, location, instanceId		Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.
list_by_location	select	subscriptionId, 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	select	subscriptionId		Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instanceId	string	The instanceId GUID of a restorable database account.
location	string	Cosmos DB region, with spaces between words and each word capitalized.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get_by_location

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

SELECT
id,
name,
location,
properties,
type
FROM azure.cosmos_db.restorable_database_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND location = '{{ location }}' -- required
AND instanceId = '{{ instanceId }}' -- required
;

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.

SELECT
id,
name,
location,
properties,
type
FROM azure.cosmos_db.restorable_database_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND location = '{{ location }}' -- required
;

list

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

SELECT
id,
name,
location,
properties,
type
FROM azure.cosmos_db.restorable_database_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;