Class BackupGenericEngine

The base backup engine class. All workload specific backup engines derive from this class. Please note BackupGenericEngine 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 BackupServerEngine and DpmBackupEngine.

Inheritance
System.Object
BackupGenericEngine
BackupServerEngine
DpmBackupEngine
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.RecoveryServicesBackup.dll
Syntax
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.ResourceManager.RecoveryServicesBackup.Models.UnknownBackupEngineBase))]
public abstract class BackupGenericEngine : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.RecoveryServicesBackup.Models.BackupGenericEngine>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.RecoveryServicesBackup.Models.BackupGenericEngine>

Constructors

BackupGenericEngine()

Initializes a new instance of BackupGenericEngine.

Declaration
protected BackupGenericEngine ();

Properties

AzureBackupAgentVersion

Backup agent version.

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

BackupEngineId

ID of the backup engine.

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

BackupEngineState

Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}.

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

BackupManagementType

Type of backup management for the backup engine.

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

CanReRegister

Flag indicating if the backup engine be registered, once already registered.

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

DpmVersion

Backup engine version.

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

ExtendedInfo

Extended info of the backupengine.

Declaration
public Azure.ResourceManager.RecoveryServicesBackup.Models.BackupEngineExtendedInfo ExtendedInfo { get; set; }
Property Value
BackupEngineExtendedInfo

FriendlyName

Friendly name of the backup engine.

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

HealthStatus

Backup status of the backup engine.

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

IsAzureBackupAgentUpgradeAvailable

To check if backup agent upgrade available.

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

IsDpmUpgradeAvailable

To check if backup engine upgrade available.

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

RegistrationStatus

Registration status of the backup engine with the Recovery Services Vault.

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

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<BackupGenericEngine>.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.BackupGenericEngine IJsonModel<BackupGenericEngine>.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
BackupGenericEngine

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

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

IJsonModel<BackupGenericEngine>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

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

Declaration
void IJsonModel<BackupGenericEngine>.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<BackupGenericEngine>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.RecoveryServicesBackup.Models.BackupGenericEngine IPersistableModel<BackupGenericEngine>.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
BackupGenericEngine

A T representation of the data.
Exceptions
System.FormatException

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

IPersistableModel<BackupGenericEngine>.GetFormatFromOptions(ModelReaderWriterOptions)

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

Declaration
string IPersistableModel<BackupGenericEngine>.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<BackupGenericEngine>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<BackupGenericEngine>.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.