Restore-AzCosmosDBMongoDBCollection

Module:

Az.CosmosDB

Restore a deleted mongodb collection in a database to a given timestamp in the same account

Syntax

Restore-AzCosmosDBMongoDBCollection
       -ResourceGroupName <String>
       -AccountName <String>
       -DatabaseName <String>
       [-Name <String>]
       -RestoreTimestampInUtc <DateTime>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

Restores the deleted mongodb collection in the same account with the given name and timestamp.

Examples

Example 1

Restore-AzCosmosDBMongoDBCollection  -AccountName “my-pitr-mongodb-account” -ResourceGroupName “my-rg”  -DatabaseName “my-database” -Name “my-collection”  -RestoreTimestampInUtc “2022-08-25T07:16:20Z”

Name     : my-collection 
Id       : /subscriptions/23587e98-b6ac-4328-a753-03bcd3c8e744/resourceGroups/my-rg/providers/Microsoft.DocumentDB/databaseAccounts/my-pitr-mongodb-account/mongoDBDatabases/my-database/collections/my-collection 
Location :
Tags     :
Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetPropertiesResource

Parameters

-AccountName

Name of the Cosmos DB database account.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseName

Database name.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Collection name.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Name of resource group.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RestoreTimestampInUtc

The timestamp to which the source account has to be restored to.

Type:	DateTime
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PSMongoDBCollectionGetResults

Outputs

PSMongoDBCollectionGetResults

ResourceNotFoundException

Notes

RELATED LINKS