New-AzCosmosDBDatabaseToRestore
Creates a new CosmosDB Database to Restore object(PSDatabaseToRestore)
Syntax
Default (Default)
New-AzCosmosDBDatabaseToRestore
-DatabaseName <String>
[-CollectionName <String[]>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Creates a new CosmosDB DatabaseToRestore object(PSDatabaseToRestore). This returned object can be used to specify 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)
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseName
The name of the database to restore
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
