Class BackupGenericProtectedItem

Base class for backup items. Please note BackupGenericProtectedItem is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include FileshareProtectedItem, IaasVmProtectedItem, VmWorkloadProtectedItem, VmWorkloadSapAseDatabaseProtectedItem, VmWorkloadSapHanaDatabaseProtectedItem, VmWorkloadSapHanaDBInstanceProtectedItem, VmWorkloadSqlDatabaseProtectedItem, DpmProtectedItem, GenericProtectedItem, MabFileFolderProtectedItem, IaasClassicComputeVmProtectedItem, IaasComputeVmProtectedItem and SqlProtectedItem.

Inheritance
System.Object
BackupGenericProtectedItem
DpmProtectedItem
FileshareProtectedItem
GenericProtectedItem
IaasVmProtectedItem
MabFileFolderProtectedItem
SqlProtectedItem
VmWorkloadProtectedItem
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.RecoveryServicesBackup.dll
Syntax
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.ResourceManager.RecoveryServicesBackup.Models.UnknownProtectedItem))]
public abstract class BackupGenericProtectedItem : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.RecoveryServicesBackup.Models.BackupGenericProtectedItem>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.RecoveryServicesBackup.Models.BackupGenericProtectedItem>

Constructors

BackupGenericProtectedItem()

Initializes a new instance of BackupGenericProtectedItem.

Declaration
protected BackupGenericProtectedItem ();

Properties

BackupManagementType

Type of backup management for the backed up item.

Declaration
public Nullable<Azure.ResourceManager.RecoveryServicesBackup.Models.BackupManagementType> BackupManagementType { get; }
Property Value
System.Nullable<BackupManagementType>

BackupSetName

Name of the backup set the backup item belongs to.

Declaration
public string BackupSetName { get; set; }
Property Value
System.String

ContainerName

Unique name of container.

Declaration
public string ContainerName { get; set; }
Property Value
System.String

CreateMode

Create mode to indicate recovery of existing soft deleted data source or creation of new data source.

Declaration
public Nullable<Azure.ResourceManager.RecoveryServicesBackup.Models.BackupCreateMode> CreateMode { get; set; }
Property Value
System.Nullable<BackupCreateMode>

DeferredDeletedOn

Time for deferred deletion in UTC.

Declaration
public Nullable<DateTimeOffset> DeferredDeletedOn { get; set; }
Property Value
System.Nullable<System.DateTimeOffset>

DeferredDeleteTimeRemaining

Time remaining before the DS marked for deferred delete is permanently deleted.

Declaration
public string DeferredDeleteTimeRemaining { get; set; }
Property Value
System.String

IsArchiveEnabled

Flag to identify whether datasource is protected in archive.

Declaration
public Nullable<bool> IsArchiveEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>

IsDeferredDeleteScheduleUpcoming

Flag to identify whether the deferred deleted DS is to be purged soon.

Declaration
public Nullable<bool> IsDeferredDeleteScheduleUpcoming { get; set; }
Property Value
System.Nullable<System.Boolean>

IsRehydrate

Flag to identify that deferred deleted DS is to be moved into Pause state.

Declaration
public Nullable<bool> IsRehydrate { get; set; }
Property Value
System.Nullable<System.Boolean>

IsScheduledForDeferredDelete

Flag to identify whether the DS is scheduled for deferred delete.

Declaration
public Nullable<bool> IsScheduledForDeferredDelete { get; set; }
Property Value
System.Nullable<System.Boolean>

LastRecoverOn

Timestamp when the last (latest) backup copy was created for this backup item.

Declaration
public Nullable<DateTimeOffset> LastRecoverOn { get; set; }
Property Value
System.Nullable<System.DateTimeOffset>

PolicyId

ID of the backup policy with which this item is backed up.

Declaration
public Azure.Core.ResourceIdentifier PolicyId { get; set; }
Property Value
Azure.Core.ResourceIdentifier

PolicyName

Name of the policy used for protection.

Declaration
public string PolicyName { get; set; }
Property Value
System.String

ResourceGuardOperationRequests

ResourceGuardOperationRequests on which LAC check will be performed.

Declaration
public System.Collections.Generic.IList<string> ResourceGuardOperationRequests { get; }
Property Value
System.Collections.Generic.IList<System.String>

SoftDeleteRetentionPeriod

SoftDelete Retention Period Serialized Name: SecuritySettings.immutabilitySettings

Declaration
[System.ComponentModel.EditorBrowsable]
public Nullable<int> SoftDeleteRetentionPeriod { get; set; }
Property Value
System.Nullable<System.Int32>

SoftDeleteRetentionPeriodInDays

Soft delete retention period in days.

Declaration
public Nullable<int> SoftDeleteRetentionPeriodInDays { get; set; }
Property Value
System.Nullable<System.Int32>

SourceResourceId

ARM ID of the resource to be backed up.

Declaration
public Azure.Core.ResourceIdentifier SourceResourceId { get; set; }
Property Value
Azure.Core.ResourceIdentifier

VaultId

ID of the vault which protects this item.

Declaration
public string VaultId { get; }
Property Value
System.String

WorkloadType

Type of workload this item represents.

Declaration
public Nullable<Azure.ResourceManager.RecoveryServicesBackup.Models.BackupDataSourceType> WorkloadType { get; }
Property Value
System.Nullable<BackupDataSourceType>

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The JSON writer.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<BackupGenericProtectedItem>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration
Azure.ResourceManager.RecoveryServicesBackup.Models.BackupGenericProtectedItem IJsonModel<BackupGenericProtectedItem>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
BackupGenericProtectedItem

A T representation of the JSON value.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<BackupGenericProtectedItem>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<BackupGenericProtectedItem>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<BackupGenericProtectedItem>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.RecoveryServicesBackup.Models.BackupGenericProtectedItem IPersistableModel<BackupGenericProtectedItem>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
BackupGenericProtectedItem

A T representation of the data.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<BackupGenericProtectedItem>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration
string IPersistableModel<BackupGenericProtectedItem>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.
Returns
System.String

The format that the model uses when communicating with the serivce.

IPersistableModel<BackupGenericProtectedItem>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<BackupGenericProtectedItem>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
System.BinaryData

A binary representation of the written model.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.