AvailabilityGroupListener Class
SQL Server 2012
Represents the object of the availability group listener.
System.Object
Microsoft.SqlServer.Management.Smo.SmoObjectBase
Microsoft.SqlServer.Management.Smo.SqlSmoObject
Microsoft.SqlServer.Management.Smo.NamedSmoObject
Microsoft.SqlServer.Management.Smo.AvailabilityGroupListener
Microsoft.SqlServer.Management.Smo.SmoObjectBase
Microsoft.SqlServer.Management.Smo.SqlSmoObject
Microsoft.SqlServer.Management.Smo.NamedSmoObject
Microsoft.SqlServer.Management.Smo.AvailabilityGroupListener
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
The AvailabilityGroupListener type exposes the following members.
| Name | Description | |
|---|---|---|
 | AvailabilityGroupListener() | Initializes a new instance of the AvailabilityGroupListener class. |
| AvailabilityGroupListener(AvailabilityGroup, String) | Initializes a new instance of the AvailabilityGroupListener class using the specified availability group and name. |
| Name | Description | |
|---|---|---|
| AvailabilityGroupListenerIPAddresses | Gets the collection of replicas participating in the availability group. |
| ClusterIPConfiguration | Gets or sets the cluster IP configuration of the Availability Group Listener. |
| IsConformant | Gets or sets a value that indicates whether the availability group is conformant. |
| Name | Gets or sets the name of the object. (Inherited from NamedSmoObject.) |
| Parent | Gets or sets the parent of the availability group listener. |
| PortNumber | Gets or sets the number of the port used to communicate with the availability group. |
| Properties | Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.) |
| State | Gets the state of the referenced object. (Inherited from SmoObjectBase.) |
| UniqueId | Gets the unique identifier of the availability group listener. |
| 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.) |
| Name | Description | |
|---|---|---|
| Alter | Alters an existing availability group listener options. |
| Create | Creates an availability group listener for the availability group. |
| Discover | Discovers a list of type Object. (Inherited from SqlSmoObject.) |
| Drop | Drops an availability group listener 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 | Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.) |
| RestartListener | Restarts the listener. |
| Script() | Generates a create script this availability group listener. |
| Script(ScriptingOptions) | Generates a script for this availability group listener using the specified scripting options. |
| 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.) |
| 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.) |
| 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.) |
