New-AzCosmosDBDatabaseToRestore
Creates a new CosmosDB Database to Restore object(PSDatabaseToRestore)
Syntax
New-AzCosmosDBDatabaseToRestore
-DatabaseName <String>
[-CollectionName <String[]>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Creates a new CosmosDB DatabaseToRestore object(PSDatabaseToRestore). This returned object can be uses to speficy the subset of databases and collections to restore.
Examples
Example 1
New-AzCosmosDBDatabaseToRestore -DatabaseName database1 -CollectionName collection1,collection2,collection3
DatabaseName CollectionNames
------------ ---------------
database1 {collection1, collection2, collection3}
Creates a new DatabaseToRestore object with the name database1 and collections with names collection1, collection2 and collection3.
Parameters
-CollectionName
The names of the collections to be restored. (If not provided, all the collections will be restored)
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DatabaseName
The name of the database to restore
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 |
Inputs
None
Outputs
Azure PowerShell