Skip to main content

restorable_mongodb_collections

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

Overview

Namerestorable_mongodb_collections
TypeResource
Idazure.cosmos_db.restorable_mongodb_collections

Fields

The following fields are returned by SELECT queries:

The operation completed successfully.

NameDatatypeDescription
idstringThe unique resource Identifier of the ARM resource.
namestringThe name of the ARM resource.
propertiesobjectThe properties of a MongoDB collection event.
typestringThe type of Azure resource.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectsubscriptionId, location, instanceIdrestorableMongodbDatabaseRid, startTime, endTimeShow 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.

NameDatatypeDescription
instanceIdstringThe instanceId GUID of a restorable database account.
locationstringCosmos DB region, with spaces between words and each word capitalized.
subscriptionIdstringThe ID of the target subscription.
endTimestringRestorable MongoDB collections event feed end time.
restorableMongodbDatabaseRidstringThe resource ID of the MongoDB database.
startTimestringRestorable MongoDB collections event feed start time.

SELECT examples

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,
properties,
type
FROM azure.cosmos_db.restorable_mongodb_collections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND location = '{{ location }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND restorableMongodbDatabaseRid = '{{ restorableMongodbDatabaseRid }}'
AND startTime = '{{ startTime }}'
AND endTime = '{{ endTime }}'
;