Table of Contents

Class SqlAvailabilityGroup

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

Represents an always on high availability group.

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

Constructors

SqlAvailabilityGroup()

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

public SqlAvailabilityGroup()

Properties

AutomatedBackupPreference

Gets or sets the automated backup preference.

public SqlAvailabilityGroupAutomatedBackupPreference AutomatedBackupPreference { get; set; }

Property Value

SqlAvailabilityGroupAutomatedBackupPreference

AutomatedBackupPreferenceString

Gets the automated backup preference.

public string AutomatedBackupPreferenceString { get; set; }

Property Value

string

AvailabilityDatabaseNames

Gets or sets the names of the databases assigned to the availability group.

public SerializableStringCollection AvailabilityDatabaseNames { get; set; }

Property Value

SerializableStringCollection

AvailabilityReplicas

Gets or sets the replicas in the availability group.

public SqlAvailabilityReplicas AvailabilityReplicas { get; set; }

Property Value

SqlAvailabilityReplicas

BasicAvailabilityGroup

Gets or sets whether the availability group is configured as a basic availability group that replaces the deprecated database mirroring feature. This only applies to SQL Server 2016 and above.

public BooleanOption BasicAvailabilityGroup { get; set; }

Property Value

BooleanOption

ClusterType

Gets or sets the cluster type for the availability group.

public SqlAvailabilityGroupClusterType ClusterType { get; set; }

Property Value

SqlAvailabilityGroupClusterType

ClusterTypeString

Gets the cluster type for the availability group.

public string ClusterTypeString { get; set; }

Property Value

string

DatabaseHealthTrigger

Gets or sets whether database level health detection is enabled. This only applies to SQL Server 2016 and above.

public BooleanOption DatabaseHealthTrigger { get; set; }

Property Value

BooleanOption

DtcSupportEnabled

Gets or sets whether per database DTC support is enabled. This only applies to SQL Server 2016 and above.

public BooleanOption DtcSupportEnabled { get; set; }

Property Value

BooleanOption

Listeners

Gets or sets the listeners configured for the availability group.

public SqlAvailabilityGroupListeners Listeners { get; set; }

Property Value

SqlAvailabilityGroupListeners

Name

Gets or sets the name of the availability group.

public string Name { get; set; }

Property Value

string

Permissions

Gets or sets the permissions configured for the availability group.

public SqlPermissions Permissions { get; set; }

Property Value

SqlPermissions

RequiredSynchronizedSecondariesToCommit

Gets or sets the required synchronized secondaries to commit. This only applies to SQL Server 2017 and above.

public int RequiredSynchronizedSecondariesToCommit { get; set; }

Property Value

int

Methods

Clone()

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

public SqlAvailabilityGroup Clone()

Returns

SqlAvailabilityGroup

A CENTREL.XIA.Configuration.Types.SqlAvailabilityGroup.

CompareTo(SqlAvailabilityGroup)

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

public int CompareTo(SqlAvailabilityGroup other)

Parameters

other SqlAvailabilityGroup

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

Returns

int

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