AvailabilityGroup Class

  • Article

Displays the availability group that contains the databases and replicas.

Inheritance Hierarchy

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

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

Syntax

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

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

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

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

public final class AvailabilityGroup extends NamedSmoObject implements IObjectPermission, ICreatable, IAlterable, IDroppable, IScriptable

The AvailabilityGroup type exposes the following members.

Constructors

  Name Description
Public method AvailabilityGroup() Initializes a new instance of the AvailabilityGroup class with the default property values.
Public method AvailabilityGroup(Server, String) Initializes a new instance of the AvailabilityGroup class with the specified server and name.

Top

Properties

  Name Description
Public property AutomatedBackupPreference Gets or sets the collection of the automated backup preference for the availability group.
Public property AvailabilityDatabases Gets the collection of availability databases contained in the availability group.
Public property AvailabilityGroupListeners Gets or sets the collection of replicas participating in the availability group.
Public property AvailabilityReplicas Gets the collection of availability replicas participating in the availability group.
Public property DatabaseReplicaStates Gets the collection of DatabaseReplicaState objects representing the states of physical database replicas participating in the availability groups.
Public property FailureConditionLevel Gets or sets the failure condition level of the availability group.
Public property HealthCheckTimeout Gets or sets the collection of the health check timeout for the availability group.
Public property ID Gets the identifier value that uniquely identifies the availability group.
Public property LocalReplicaRole Gets the availability replica role.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property Parent Gets or sets the parent of the availability group.
Public property PrimaryReplicaServerName Gets the collection for the primary replica server name of the availability group.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property UniqueId Gets or sets the GUID that uniquely identifies the availability group.
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter Alters an availability group.
Public method Create Creates an availability group that has been specified on the client on the back end. The availability group creation will include any availability replicas or availability databases added to the object before creation.
Public method Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the availability group.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the availability group.
Public method Deny(ObjectPermissionSet, String, Boolean) Denies the specified set of permissions for the specified grantee and other users to whom the grantee granted the specified set of permissions on the availability group.
Public method Deny(ObjectPermissionSet, array<String[], Boolean) Denies the specified set of permissions for the specified grantees and other users to whom the grantees granted the specified set of permissions on the availability group.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Drops an availability group.
Public method EnumObjectPermissions() Enumerates a list of object permissions for the availability group.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the availability group.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the availability group.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the availability group.
Public method EnumReplicaClusterNodes Returns a DataTable with information about the cluster configuration of the availability group.
Public method Equals (Inherited from Object.)
Public method Failover Performs a manual failover of this availability group to the server specified by the Parent property with no possibility of data loss.
Public method FailoverWithPotentialDataLoss Performs a forced failover of this availability group to the server specified by the Parent property with the possibility of data loss if the databases on the replica are not synchronized with the primary.
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Grant(ObjectPermissionSet, String) Grants the specified set of permissions to the specified grantee on the availability group.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the availability group.
Public method Grant(ObjectPermissionSet, String, Boolean) Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the availability group.
Public method Grant(ObjectPermissionSet, array<String[], Boolean) Grants access to the specified permission and the ability to grant access to other users for the specified grantees on the availability group.
Public method Grant(ObjectPermissionSet, String, Boolean, String) Grants access to the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the availability group under an assumed role.
Public method Grant(ObjectPermissionSet, array<String[], Boolean, String) Grants access to the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the availability group under an assumed role.
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the availability group.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the availability group.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revokes a previously granted set of permissions from a grantee on the availability group and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean) Revokes a previously granted set of permissions from a list of grantees on the availability group and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revokes a previously granted set of permissions from a grantee from the availability group and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String) Revokes a previously granted set of permissions from a list of grantees from the availability group and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Script() Generates the script for creating this availability group.
Public method Script(ScriptingOptions) Generates a script for this availability group using the specified scripting options.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

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

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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