restorable_mongodb_resources

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

Overview

Name	restorable_mongodb_resources
Type	Resource
Id	azure.cosmosdb.restorable_mongodb_resources

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string	The unique resource identifier of the ARM resource.
name	string	The name of the ARM resource.
collectionNames	array	The names of the collections available for restore.
databaseName	string	The name of the database available for restore.
type	string	The type of Azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	location, instance_id, subscription_id	restoreLocation, restoreTimestampInUtc	Return a list of database and collection combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API 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
restoreLocation	string	The location where the restorable resources are located. Default value is None.
restoreTimestampInUtc	string	The timestamp when the restorable resources existed. Default value is None.

SELECT examples

list

Return a list of database and collection combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.

SELECT
id,
name,
collectionNames,
databaseName,
type
FROM azure.cosmosdb.restorable_mongodb_resources
WHERE location = '{{ location }}' -- required
AND instance_id = '{{ instance_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND restoreLocation = '{{ restoreLocation }}'
AND restoreTimestampInUtc = '{{ restoreTimestampInUtc }}'
;