Edit

Share via


New-AzCosmosDBGremlinDatabaseToRestore

Creates a new CosmosDB Gremlin Database to Restore object(PSGremlinDatabaseToRestore)

Syntax

Default (Default)

New-AzCosmosDBGremlinDatabaseToRestore
    -DatabaseName <String>
    [-GraphName <String[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

Creates a new CosmosDB GremlinDatabaseToRestore object(PSGremlinDatabaseToRestore). This returned object can be used to specify the subset of databases and graphs to restore.

Examples

Example 1

New-AzCosmosDBGremlinDatabaseToRestore -DatabaseName database1 -GraphName graph1,graph2,graph3
DatabaseName GraphNames
------------ ---------------
database1    {graph1, graph2, graph3}

Creates a new GremlinDatabaseToRestore object with the name database1 and graphs with names graph1, graph2 and graph3.

Parameters

-DatabaseName

The name of the gremlin 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

-GraphName

The names of the graphs to be restored. (If not provided, all the graphs 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

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.

Inputs

None

Outputs

PSGremlinDatabaseToRestore