Class VmWorkloadProtectedItem

Azure VM workload-specific protected item. Please note VmWorkloadProtectedItem 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 VmWorkloadSapAseDatabaseProtectedItem, VmWorkloadSapHanaDatabaseProtectedItem, VmWorkloadSapHanaDBInstanceProtectedItem and VmWorkloadSqlDatabaseProtectedItem.

Inheritance
System.Object
BackupGenericProtectedItem
VmWorkloadProtectedItem
VmWorkloadSapAseDatabaseProtectedItem
VmWorkloadSapHanaDatabaseProtectedItem
VmWorkloadSapHanaDBInstanceProtectedItem
VmWorkloadSqlDatabaseProtectedItem
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.RecoveryServicesBackup.dll
Syntax
public class VmWorkloadProtectedItem : Azure.ResourceManager.RecoveryServicesBackup.Models.BackupGenericProtectedItem, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.RecoveryServicesBackup.Models.VmWorkloadProtectedItem>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.RecoveryServicesBackup.Models.VmWorkloadProtectedItem>

Constructors

VmWorkloadProtectedItem()

Initializes a new instance of VmWorkloadProtectedItem.

Declaration
public VmWorkloadProtectedItem ();

Properties

ExtendedInfo

Additional information for this backup item.

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

FriendlyName

Friendly name of the DB represented by this backup item.

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

KpisHealths

Health details of different KPIs.

Declaration
public System.Collections.Generic.IDictionary<string,Azure.ResourceManager.RecoveryServicesBackup.Models.KpiResourceHealthDetails> KpisHealths { get; }
Property Value
System.Collections.Generic.IDictionary<System.String,KpiResourceHealthDetails>

LastBackupErrorDetail

Error details in last backup.

Declaration
public Azure.ResourceManager.RecoveryServicesBackup.Models.BackupErrorDetail LastBackupErrorDetail { get; set; }
Property Value
BackupErrorDetail

LastBackupOn

Timestamp of the last backup operation on this backup item.

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

LastBackupStatus

Last backup operation status. Possible values: Healthy, Unhealthy.

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

NodesList

List of the nodes in case of distributed container.

Declaration
public System.Collections.Generic.IList<Azure.ResourceManager.RecoveryServicesBackup.Models.DistributedNodesInfo> NodesList { get; }
Property Value
System.Collections.Generic.IList<DistributedNodesInfo>

ParentName

Parent name of the DB such as Instance or Availability Group.

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

ParentType

Parent type of protected item, example: for a DB, standalone server or distributed.

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

ProtectedItemDataSourceId

Data ID of the protected item.

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

ProtectedItemHealthStatus

Health status of the backup item, evaluated based on last heartbeat received.

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

ProtectionState

Backup state of this backup item.

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

ProtectionStatus

Backup status of this backup item.

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

ServerName

Host/Cluster Name for instance or AG.

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected override 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<VmWorkloadProtectedItem>.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.VmWorkloadProtectedItem IJsonModel<VmWorkloadProtectedItem>.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
VmWorkloadProtectedItem

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

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

IJsonModel<VmWorkloadProtectedItem>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

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

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

Converts the provided System.BinaryData into a model.

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

A T representation of the data.
Exceptions
System.FormatException

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

IPersistableModel<VmWorkloadProtectedItem>.GetFormatFromOptions(ModelReaderWriterOptions)

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

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

Writes the model into a System.BinaryData.

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