restorable_mongodb_collections

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

Overview

Name	restorable_mongodb_collections
Type	Resource
Id	azure.cosmosdb.restorable_mongodb_collections

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.
resource	object	The resource of an Azure Cosmos DB MongoDB collection event.
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	restorableMongodbDatabaseRid, startTime, endTime	Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB collections under a specific database. This helps in scenario where container was accidentally deleted. 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
endTime	string	Restorable MongoDB collections event feed end time. Default value is None.
restorableMongodbDatabaseRid	string	The resource ID of the MongoDB database. Default value is None.
startTime	string	Restorable MongoDB collections event feed start time. Default value is None.

SELECT examples

list

Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB collections under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.

SELECT
id,
name,
resource,
type
FROM azure.cosmosdb.restorable_mongodb_collections
WHERE location = '{{ location }}' -- required
AND instance_id = '{{ instance_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND restorableMongodbDatabaseRid = '{{ restorableMongodbDatabaseRid }}'
AND startTime = '{{ startTime }}'
AND endTime = '{{ endTime }}'
;