Share via

RestoreParameters interface

  • Reference
Package:
@azure/arm-cosmosdb

Parameters to indicate the information about the restore.

Extends
RestoreParametersBase

Properties

databasesToRestore

List of specific databases available for restore.
gremlinDatabasesToRestore

List of specific gremlin databases available for restore.
restoreMode

Describes the mode of the restore.
tablesToRestore

List of specific tables available for restore.

Inherited Properties

restoreSource

The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc

Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled

Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

Property Details

databasesToRestore

List of specific databases available for restore.

databasesToRestore?: DatabaseRestoreResource[]

Property Value

DatabaseRestoreResource[]

gremlinDatabasesToRestore

List of specific gremlin databases available for restore.

gremlinDatabasesToRestore?: GremlinDatabaseRestoreResource[]

Property Value

GremlinDatabaseRestoreResource[]

restoreMode

Describes the mode of the restore.

restoreMode?: string

Property Value

string

tablesToRestore

List of specific tables available for restore.

tablesToRestore?: string[]

Property Value

string[]

Inherited Property Details

restoreSource

The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}

restoreSource?: string

Property Value

string

Inherited From RestoreParametersBase.restoreSource

restoreTimestampInUtc

Time to which the account has to be restored (ISO-8601 format).

restoreTimestampInUtc?: Date

Property Value

Date

Inherited From RestoreParametersBase.restoreTimestampInUtc

restoreWithTtlDisabled

Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

restoreWithTtlDisabled?: boolean

Property Value

boolean

Inherited From RestoreParametersBase.restoreWithTtlDisabled