Share via


az cosmosdb mongodb restorable-collection

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage different versions of mongodb collections that are restorable in a database of a Azure Cosmos DB account.

Commands

Name Description Type Status
az cosmosdb mongodb restorable-collection list

List all the versions of all the mongodb collections that were created / modified / deleted in the given database and restorable account.

Core GA
az cosmosdb mongodb restorable-collection list (cosmosdb-preview extension)

List all the versions of all the mongodb collections that were created / modified / deleted in the given database and restorable account.

Extension Preview

az cosmosdb mongodb restorable-collection list

List all the versions of all the mongodb collections that were created / modified / deleted in the given database and restorable account.

az cosmosdb mongodb restorable-collection list --database-rid
                                               --instance-id
                                               --location
                                               [--end-time]
                                               [--start-time]

Required Parameters

--database-rid -d

Rid of the database.

--instance-id -i

InstanceId of the Account.

--location -l

Location.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--end-time -e

End time of restorable MongoDB collections event feed.

--start-time -s

Start time of restorable MongoDB collections event feed.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az cosmosdb mongodb restorable-collection list (cosmosdb-preview extension)

Preview

Command group 'cosmosdb mongodb restorable-collection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all the versions of all the mongodb collections that were created / modified / deleted in the given database and restorable account.

az cosmosdb mongodb restorable-collection list --database-rid
                                               --instance-id
                                               --location
                                               [--end-time]
                                               [--start-time]

Required Parameters

--database-rid -d

Rid of the database.

--instance-id -i

InstanceId of the Account.

--location -l

Location.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--end-time -e

End time of restorable MongoDB collections event feed.

--start-time -s

Start time of restorable MongoDB collections event feed.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False