TechNet
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)


<PhysicalFacetAttribute>
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>
Public NotInheritable Class AvailabilityGroup
	Inherits NamedSmoObject
	Implements IObjectPermission, ICreatable, IAlterable, IDroppable,
	IDropIfExists, IScriptable

NameDescription
System_CAPS_pubmethodAvailabilityGroup()

Initializes a new instance of the AvailabilityGroup class with the default property values.

System_CAPS_pubmethodAvailabilityGroup(Server, String)

Initializes a new instance of the AvailabilityGroup class with the specified server and name.

NameDescription
System_CAPS_pubpropertyAutomatedBackupPreference

Gets or sets the collection of the automated backup preference for the availability group.

System_CAPS_pubpropertyAvailabilityDatabases

Gets the collection of availability databases contained in the availability group.

System_CAPS_pubpropertyAvailabilityGroupListeners

Gets or sets the collection of replicas participating in the availability group.

System_CAPS_pubpropertyAvailabilityReplicas

Gets the collection of availability replicas participating in the availability group.

System_CAPS_pubpropertyBasicAvailabilityGroup

System_CAPS_pubpropertyDatabaseHealthTrigger

System_CAPS_pubpropertyDatabaseReplicaStates

Gets the collection of DatabaseReplicaState objects representing the states of physical database replicas participating in the availability groups.

System_CAPS_pubpropertyDtcSupportEnabled

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyFailureConditionLevel

Gets or sets the failure condition level of the availability group.

System_CAPS_pubpropertyHealthCheckTimeout

Gets or sets the collection of the health check timeout for the availability group.

System_CAPS_pubpropertyID

Gets the identifier value that uniquely identifies the availability group.

System_CAPS_pubpropertyLocalReplicaRole

Gets the availability replica role.

System_CAPS_pubpropertyName

Gets or sets the name of the object.(Inherited from NamedSmoObject.)

System_CAPS_pubpropertyParent

Gets or sets the parent of the availability group.

System_CAPS_pubpropertyPrimaryReplicaServerName

Gets the collection for the primary replica server name of the availability group.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUniqueId

Gets or sets the GUID that uniquely identifies the availability group.

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Alters an availability group.

System_CAPS_pubmethodCreate()

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.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String)

Denies the specified set of permissions for the specified grantee on the availability group.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String())

Denies the specified set of permissions for the specified grantees on the availability group.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Drops an availability group.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of object permissions for the availability group.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet)

Enumerates a list of object permissions for a specified permission on the availability group.

System_CAPS_pubmethodEnumObjectPermissions(String)

Enumerates a list of object permissions for a specified grantee on the availability group.

System_CAPS_pubmethodEnumObjectPermissions(String, ObjectPermissionSet)

Enumerates a list of object permissions for a specified grantee and a specified permission on the availability group.

System_CAPS_pubmethodEnumReplicaClusterNodes()

Returns a DataTable with information about the cluster configuration of the availability group.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodFailover()

Performs a manual failover of this availability group to the server specified by the Parent property with no possibility of data loss.

System_CAPS_pubmethodFailoverWithPotentialDataLoss()

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.

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGrant(ObjectPermissionSet, String)

Grants the specified set of permissions to the specified grantee on the availability group.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String())

Grants the specified set of permissions to the specified grantees on the availability group.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String)

Revokes a previously granted set of permissions from a grantee on the availability group.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String())

Revokes a previously granted set of permissions from a list of grantees on the availability group.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodScript()

Generates the script for creating this availability group.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a script for this availability group using the specified scripting options.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object())

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

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

Return to top
Show:
© 2016 Microsoft