restorable_database_accounts

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

Overview

Name	restorable_database_accounts
Type	Resource
Id	azure.cosmosdb.restorable_database_accounts

Fields

The following fields are returned by SELECT queries:

get_by_location

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accountName	string	The name of the global database account.
apiType	string	The API type of the restorable database account. Known values are: "MongoDB", "Gremlin", "Cassandra", "Table", "Sql", and "GremlinV2". (MongoDB, Gremlin, Cassandra, Table, Sql, GremlinV2)
creationTime	string (date-time)	The creation time of the restorable database account (ISO-8601 format).
deletionTime	string (date-time)	The time at which the restorable database account has been deleted (ISO-8601 format).
location	string	The location of the resource group to which the resource belongs.
oldestRestorableTime	string (date-time)	The least recent time at which the database account can be restored to (ISO-8601 format).
restorableLocations	array	List of regions where the of the database account can be restored from.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_location

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accountName	string	The name of the global database account.
apiType	string	The API type of the restorable database account. Known values are: "MongoDB", "Gremlin", "Cassandra", "Table", "Sql", and "GremlinV2". (MongoDB, Gremlin, Cassandra, Table, Sql, GremlinV2)
creationTime	string (date-time)	The creation time of the restorable database account (ISO-8601 format).
deletionTime	string (date-time)	The time at which the restorable database account has been deleted (ISO-8601 format).
location	string	The location of the resource group to which the resource belongs.
oldestRestorableTime	string (date-time)	The least recent time at which the database account can be restored to (ISO-8601 format).
restorableLocations	array	List of regions where the of the database account can be restored from.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accountName	string	The name of the global database account.
apiType	string	The API type of the restorable database account. Known values are: "MongoDB", "Gremlin", "Cassandra", "Table", "Sql", and "GremlinV2". (MongoDB, Gremlin, Cassandra, Table, Sql, GremlinV2)
creationTime	string (date-time)	The creation time of the restorable database account (ISO-8601 format).
deletionTime	string (date-time)	The time at which the restorable database account has been deleted (ISO-8601 format).
location	string	The location of the resource group to which the resource belongs.
oldestRestorableTime	string (date-time)	The least recent time at which the database account can be restored to (ISO-8601 format).
restorableLocations	array	List of regions where the of the database account can be restored from.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_location	select	location, instance_id, subscription_id		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	location, subscription_id		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	subscription_id		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
instance_id	string	The instanceId GUID of a restorable database account. Required.
location	string	Cosmos DB region, with spaces between words and each word capitalized. Required.
subscription_id	string

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,
accountName,
apiType,
creationTime,
deletionTime,
location,
oldestRestorableTime,
restorableLocations,
systemData,
type
FROM azure.cosmosdb.restorable_database_accounts
WHERE location = '{{ location }}' -- required
AND instance_id = '{{ instance_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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,
accountName,
apiType,
creationTime,
deletionTime,
location,
oldestRestorableTime,
restorableLocations,
systemData,
type
FROM azure.cosmosdb.restorable_database_accounts
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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,
accountName,
apiType,
creationTime,
deletionTime,
location,
oldestRestorableTime,
restorableLocations,
systemData,
type
FROM azure.cosmosdb.restorable_database_accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
;