Share via

CosmosDBAccountRestoreParameters Class

Definition

Namespace:
Azure.Provisioning.CosmosDB
Assembly:
Azure.Provisioning.CosmosDB.dll
Package:
Azure.Provisioning.CosmosDB v1.0.0
Package:
Azure.Provisioning.CosmosDB v1.1.0-beta.1
Source:
CosmosDBAccountRestoreParameters.cs
Source:
CosmosDBAccountRestoreParameters.cs

Parameters to indicate the information about the restore.

public class CosmosDBAccountRestoreParameters : Azure.Provisioning.Primitives.ProvisionableConstruct
type CosmosDBAccountRestoreParameters = class
    inherit ProvisionableConstruct
Public Class CosmosDBAccountRestoreParameters
Inherits ProvisionableConstruct
Inheritance
Object
Provisionable
ProvisionableConstruct
CosmosDBAccountRestoreParameters

Constructors

Name Description
CosmosDBAccountRestoreParameters()

Creates a new CosmosDBAccountRestoreParameters.

Properties

Name Description
DatabasesToRestore

List of specific databases available for restore.
GremlinDatabasesToRestore

List of specific gremlin databases available for restore.
IsRestoreWithTtlDisabled

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

Describes the mode of the restore.
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).
SourceBackupLocation

The source backup location for restore.
TablesToRestore

List of specific tables available for restore.

Methods

Name Description
AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableConstruct)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], T, Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of CosmosDBAccountRestoreParameters.
GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableConstruct)

Explicit Interface Implementations

Name Description
IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Extension Methods

Name Description
ToBicepExpression(IBicepValue)

Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to