AvailabilityReplica Class

Displays the availability replica and its properties.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.AvailabilityReplica

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

Syntax

'Declaration
<PhysicalFacetAttribute> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class AvailabilityReplica _
    Inherits NamedSmoObject _
    Implements ICreatable, IDroppable, IAlterable, IScriptable
'Usage
Dim instance As AvailabilityReplica

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class AvailabilityReplica : NamedSmoObject, 
    ICreatable, IDroppable, IAlterable, IScriptable

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class AvailabilityReplica sealed : public NamedSmoObject, 
    ICreatable, IDroppable, IAlterable, IScriptable

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type AvailabilityReplica =  
    class 
        inherit NamedSmoObject 
        interface ICreatable 
        interface IDroppable 
        interface IAlterable 
        interface IScriptable 
    end

public final class AvailabilityReplica extends NamedSmoObject implements ICreatable, IDroppable, IAlterable, IScriptable

The AvailabilityReplica type exposes the following members.

Constructors

	Name	Description
	AvailabilityReplica()	Initializes a new instance of the AvailabilityReplica class with specified default values.
	AvailabilityReplica(AvailabilityGroup, String)	Initializes a new instance of the AvailabilityReplica class on the specified availability group and with the specified name.

Top

Properties

	Name	Description
	AvailabilityMode	Gets or sets the value that represents the availability mode for the availability replica.
	BackupPriority	Gets or sets the value of the backup priority of the AvailabilityReplica
	ConnectionModeInPrimaryRole	Gets or sets the connection model of the availability replica in primary role.
	ConnectionModeInSecondaryRole	Gets or sets the connection model of the availability replica in secondary role.
	ConnectionState	Gets the current connection state of the availability replica.
	CreateDate	Gets the date and time when the availability replica was created.
	DateLastModified	Gets the date and time when the replica was last modified.
	EndpointUrl	Gets or sets the URL of the endpoint.
	FailoverMode	Gets or sets the failover mode of the availability replica.
	JoinState	Gets the availability replica join state.
	LastConnectErrorDescription	Gets or sets the description of the error during the last connection.
	LastConnectErrorNumber	Gets or sets the number of the error during the last connection.
	LastConnectErrorTimestamp	Gets the timestamp of the error during the last connection.
	MemberState	Gets the state of the cluster member.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	OperationalState	Gets the value for operational state.
	Owner	Gets or sets the owner of the availability replica.
	Parent	Gets the availability group that is the parent of the availability replica.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	QuorumVoteCount	Gets the quorum vote count.
	ReadonlyRoutingConnectionUrl	Gets or sets the read only routing connection url for the availability replica.
	ReadonlyRoutingList	Gets or sets the read only routing connection list for the availability replica.
	Role	Gets the replica role object associated with this instance.
	RollupRecoveryState	Gets or sets the rollup recovery state of the availability replica.
	RollupSynchronizationState	Gets or sets the rollup synchronization state of the availability replica.
	SessionTimeout	Gets or sets the timeout of the availability replica.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	UniqueId	Gets the unique, hierarchically qualified identifier for the availability replica.
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Alter	Alters the availability replica.
	Create	Creates an availability replica for the availability group.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Drops an availability replica from the availability group.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Refresh	Reloads the availability replica. (Overrides SqlSmoObject.Refresh().)
	Script()	Represents the collection of scripts used in the availability replica.
	Script(ScriptingOptions)	Represents the collection of scripts with specified options used in the availability replica.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace