IAvailabilityGroupState Interface

Definition

This facet aggregates various availability group state information. It is used to support SQL Server manageability tools.

[Microsoft.SqlServer.Management.Facets.EvaluationMode(Microsoft.SqlServer.Management.Dmf.AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[Microsoft.SqlServer.Management.Sdk.Sfc.DisplayDescriptionKey("AvailabilityGroupStateDesc")]
[Microsoft.SqlServer.Management.Sdk.Sfc.DisplayNameKey("AvailabilityGroupStateName")]
[Microsoft.SqlServer.Management.Sdk.Sfc.LocalizedPropertyResources("Microsoft.SqlServer.Management.Smo.FacetSR")]
[System.ComponentModel.TypeConverter(typeof(Microsoft.SqlServer.Management.Sdk.Sfc.LocalizableTypeConverter))]
public interface IAvailabilityGroupState : Microsoft.SqlServer.Management.Common.IRefreshable, Microsoft.SqlServer.Management.Sdk.Sfc.IDmfFacet
[<Microsoft.SqlServer.Management.Facets.EvaluationMode(Microsoft.SqlServer.Management.Dmf.AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<Microsoft.SqlServer.Management.Sdk.Sfc.DisplayDescriptionKey("AvailabilityGroupStateDesc")>]
[<Microsoft.SqlServer.Management.Sdk.Sfc.DisplayNameKey("AvailabilityGroupStateName")>]
[<Microsoft.SqlServer.Management.Sdk.Sfc.LocalizedPropertyResources("Microsoft.SqlServer.Management.Smo.FacetSR")>]
[<System.ComponentModel.TypeConverter(typeof(Microsoft.SqlServer.Management.Sdk.Sfc.LocalizableTypeConverter))>]
type IAvailabilityGroupState = interface
    interface IDmfFacet
    interface IRefreshable
Public Interface IAvailabilityGroupState
Implements IDmfFacet, IRefreshable
Derived
Attributes
Implements

Properties

IsAutoFailover

Gets a value indicating whether the failover mode of the availability group is Automatic Failover.

IsOnline

Gets a value indicating whether the Availability Group is up. This is true if a functioning primary replica exists for the Availability Group.

NumberOfDisconnectedReplicas

Gets the nubmer of replicas that are not in a "Connected" state

NumberOfNotSynchronizedReplicas

Gets the number of replicas that are not in a "Synchronized" state. Since only synchronous replicas can be in a "synchronized" state, this does not apply to asynchronous replicas

NumberOfNotSynchronizingReplicas

Gets the nubmer of replicas in a "Not Synchronizing" state.

NumberOfReplicasWithUnhealthyRole

Gets the number of replicas that are neither a primary or a secondary in the Availability Group.

NumberOfSynchronizedSecondaryReplicas

Gets the number of synchronous secondary replicas with Automatic Failover mode and Synchronized state.

Methods

Refresh() (Inherited from IRefreshable)

Applies to