Export (0) Print
Expand All

AvailabilityGroup Class

Displays the availability group that contains the databases and replicas.

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

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

The AvailabilityGroup type exposes the following members.

  NameDescription
Public methodAvailabilityGroup()Initializes a new instance of the AvailabilityGroup class with the default property values.
Public methodAvailabilityGroup(Server, String)Initializes a new instance of the AvailabilityGroup class with the specified server and name.
Top

  NameDescription
Public propertyAutomatedBackupPreferenceGets or sets the collection of the automated backup preference for the availability group.
Public propertyAvailabilityDatabasesGets the collection of availability databases contained in the availability group.
Public propertyAvailabilityGroupListenersGets or sets the collection of replicas participating in the availability group.
Public propertyAvailabilityReplicasGets the collection of availability replicas participating in the availability group.
Public propertyDatabaseReplicaStatesGets the collection of DatabaseReplicaState objects representing the states of physical database replicas participating in the availability groups.
Public propertyFailureConditionLevelGets or sets the failure condition level of the availability group.
Public propertyHealthCheckTimeoutGets or sets the collection of the health check timeout for the availability group.
Public propertyIDGets the identifier value that uniquely identifies the availability group.
Public propertyLocalReplicaRoleGets the availability replica role.
Public propertyNameGets or sets the name of the object. (Inherited from NamedSmoObject.)
Public propertyParentGets or sets the parent of the availability group.
Public propertyPrimaryReplicaServerNameGets the collection for the primary replica server name of the availability group.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUniqueIdGets or sets the GUID that uniquely identifies the availability group.
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAlterAlters an availability group.
Public methodCreateCreates 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 methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the availability group.
Public methodDeny(ObjectPermissionSet, String[])Denies the specified set of permissions for the specified grantees on the availability group.
Public methodDeny(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 methodDeny(ObjectPermissionSet, 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 methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropDrops an availability group.
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the availability group.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the availability group.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the availability group.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the availability group.
Public methodEnumReplicaClusterNodesReturns a DataTable with information about the cluster configuration of the availability group.
Public methodEquals (Inherited from Object.)
Public methodFailoverPerforms a manual failover of this availability group to the server specified by the Parent property with no possibility of data loss.
Public methodFailoverWithPotentialDataLossPerforms 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 methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to the specified grantee on the availability group.
Public methodGrant(ObjectPermissionSet, String[])Grants the specified set of permissions to the specified grantees on the availability group.
Public methodGrant(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 methodGrant(ObjectPermissionSet, 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 methodGrant(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 methodGrant(ObjectPermissionSet, 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 methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the availability group.
Public methodRevoke(ObjectPermissionSet, String[])Revokes a previously granted set of permissions from a list of grantees on the availability group.
Public methodRevoke(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 methodRevoke(ObjectPermissionSet, 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 methodRevoke(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 methodRevoke(ObjectPermissionSet, 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 methodScript()Generates the script for creating this availability group.
Public methodScript(ScriptingOptions)Generates a script for this availability group using the specified scripting options.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets 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 methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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 methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Top

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

Community Additions

ADD
Show:
© 2014 Microsoft