IAvailabilityGroupState Interface

Represents the adapter class that implements the IAvailabilityGroupState logical facet for an Availability Group.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<DisplayDescriptionKeyAttribute("AvailabilityGroupStateDesc")> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<TypeConverterAttribute(GetType(LocalizableTypeConverter))> _
<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Smo.FacetSR")> _
<DisplayNameKeyAttribute("AvailabilityGroupStateName")> _
Public Interface IAvailabilityGroupState _
    Inherits IDmfFacet, IRefreshable
'Usage
Dim instance As IAvailabilityGroupState

[DisplayDescriptionKeyAttribute("AvailabilityGroupStateDesc")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
[LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Smo.FacetSR")]
[DisplayNameKeyAttribute("AvailabilityGroupStateName")]
public interface IAvailabilityGroupState : IDmfFacet, 
    IRefreshable

[DisplayDescriptionKeyAttribute(L"AvailabilityGroupStateDesc")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
[LocalizedPropertyResourcesAttribute(L"Microsoft.SqlServer.Management.Smo.FacetSR")]
[DisplayNameKeyAttribute(L"AvailabilityGroupStateName")]
public interface class IAvailabilityGroupState : IDmfFacet, 
    IRefreshable

[<DisplayDescriptionKeyAttribute("AvailabilityGroupStateDesc")>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<TypeConverterAttribute(typeof(LocalizableTypeConverter))>]
[<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Smo.FacetSR")>]
[<DisplayNameKeyAttribute("AvailabilityGroupStateName")>]
type IAvailabilityGroupState =  
    interface 
        interface IDmfFacet 
        interface IRefreshable 
    end

public interface IAvailabilityGroupState extends IDmfFacet, IRefreshable

The IAvailabilityGroupState type exposes the following members.

Properties

	Name	Description
	IsAutoFailover	Returns true if the failover mode of the current primary replica of the Availability Group is set to Automatic Failover.
	IsOnline	Indicates whether the Availability Group is up.
	NumberOfDisconnectedReplicas	Gets the number of replicas that are not in a "Connected" state.
	NumberOfNotSynchronizedReplicas	Gets the number of replicas that are not in a "Synchronized" state.
	NumberOfNotSynchronizingReplicas	Gets the number 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.

Top

Methods

	Name	Description
	Refresh	Refreshes object properties by reading them from the server. (Inherited from IRefreshable.)

Top

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace