Table of Contents

Class SqlAvailabilityReplica

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents an availability group replica.

public class SqlAvailabilityReplica : BaseTypeSection, IComparable<SqlAvailabilityReplica>
Inheritance
SqlAvailabilityReplica
Implements

Constructors

SqlAvailabilityReplica()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.SqlAvailabilityReplica class.

public SqlAvailabilityReplica()

Properties

AvailabilityMode

Gets or sets the availability mode of the availability replica.

public SqlAvailabilityReplicaAvailabilityMode AvailabilityMode { get; set; }

Property Value

SqlAvailabilityReplicaAvailabilityMode

AvailabilityModeString

Gets the availability mode of the availability replica.

public string AvailabilityModeString { get; set; }

Property Value

string

BackupPriority

Gets or sets the backup priority of the replica. A value of zero indicates that the replica is excluded from backups.

public int BackupPriority { get; set; }

Property Value

int

ConnectionModeInPrimaryRole

Gets or sets the connection mode of the availability replica in a primary role.

public SqlAvailabilityReplicaConnectionModeInPrimaryRole ConnectionModeInPrimaryRole { get; set; }

Property Value

SqlAvailabilityReplicaConnectionModeInPrimaryRole

ConnectionModeInPrimaryRoleString

Gets the connection mode of the availability replica in a primary role.

public string ConnectionModeInPrimaryRoleString { get; set; }

Property Value

string

ConnectionModeInSecondaryRole

Gets or sets the connection mode of the availability replica in a secondary role.

public SqlAvailabilityReplicaConnectionModeInSecondaryRole ConnectionModeInSecondaryRole { get; set; }

Property Value

SqlAvailabilityReplicaConnectionModeInSecondaryRole

ConnectionModeInSecondaryRoleString

Gets the connection mode of the availability replica in a secondary role.

public string ConnectionModeInSecondaryRoleString { get; set; }

Property Value

string

EndpointUrl

Gets or sets the endpoint URL for the replica.

public string EndpointUrl { get; set; }

Property Value

string

ExcludeReplicaFromBackups

Gets or sets whether to exclude the replica from backups.

public BooleanOption ExcludeReplicaFromBackups { get; set; }

Property Value

BooleanOption

FailoverMode

Gets or sets the failover mode.

public SqlAvailabilityReplicaFailoverMode FailoverMode { get; set; }

Property Value

SqlAvailabilityReplicaFailoverMode

FailoverModeString

Gets the failover mode.

public string FailoverModeString { get; set; }

Property Value

string

Identifier

Gets or sets the unique identifier for the availability replica. This is for internal use only.

public Guid Identifier { get; set; }

Property Value

Guid

Name

Gets or sets the name of the replica.

public string Name { get; set; }

Property Value

string

ReadonlyRoutingConnectionUrl

Gets or sets the read-only routing connection URL.

public string ReadonlyRoutingConnectionUrl { get; set; }

Property Value

string

ReadonlyRoutingReplicas

Gets or sets the read-only routing replicas sorted by priority.

public SerializableStringCollection ReadonlyRoutingReplicas { get; set; }

Property Value

SerializableStringCollection

Role

Gets or sets the role of the replica.

public SqlAvailabilityReplicaRole Role { get; set; }

Property Value

SqlAvailabilityReplicaRole

RoleString

Gets the role of the replica.

public string RoleString { get; set; }

Property Value

string

SessionTimeout

Gets or sets the session timeout in seconds.

public int SessionTimeout { get; set; }

Property Value

int

Methods

Clone()

Returns a CENTREL.XIA.Configuration.Types.SqlAvailabilityReplica cloned from this object.

public SqlAvailabilityReplica Clone()

Returns

SqlAvailabilityReplica

A CENTREL.XIA.Configuration.Types.SqlAvailabilityReplica.

CompareTo(SqlAvailabilityReplica)

Compares two CENTREL.XIA.Configuration.Types.SqlAvailabilityReplica objects to allow sorting alphabetically by name.

public int CompareTo(SqlAvailabilityReplica other)

Parameters

other SqlAvailabilityReplica

The CENTREL.XIA.Configuration.Types.SqlAvailabilityReplica to compare to.

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.SqlAvailabilityReplica objects.