AvailabilityGroupListenerIPAddress Class

Article
08/11/2014

Represents an availability group listener IP address.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.AvailabilityGroupListenerIPAddress

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

Syntax

'Declaration
Public NotInheritable Class AvailabilityGroupListenerIPAddress _
    Inherits SqlSmoObject _
    Implements ICreatable, IScriptable
'Usage
Dim instance As AvailabilityGroupListenerIPAddress

public sealed class AvailabilityGroupListenerIPAddress : SqlSmoObject, 
    ICreatable, IScriptable

public ref class AvailabilityGroupListenerIPAddress sealed : public SqlSmoObject, 
    ICreatable, IScriptable

[<SealedAttribute>]
type AvailabilityGroupListenerIPAddress =  
    class 
        inherit SqlSmoObject 
        interface ICreatable 
        interface IScriptable 
    end

public final class AvailabilityGroupListenerIPAddress extends SqlSmoObject implements ICreatable, IScriptable

The AvailabilityGroupListenerIPAddress type exposes the following members.

Constructors

	Name	Description
	AvailabilityGroupListenerIPAddress()	Initializes a new instance of the AvailabilityGroupListenerIPAddress class using default values.
	AvailabilityGroupListenerIPAddress(AvailabilityGroupListener)	Initializes a new instance of the AvailabilityGroupListenerIPAddress class using the specified availability group listener.

Top

Properties

	Name	Description
	IPAddress	Gets or sets the IP address of the availability group listener.
	IPAddressState	Gets the IP state of the availability group listener.
	IPAddressStateDescription	Gets the state description of the availability group listener IP address.
	IsDHCP	Gets a value that indicates whether the object is DHCP.
	IsIPv6	Gets a value that indicates whether the object is IP v6.
	Parent	Gets an object that is the parent of the AvailabilityGroupListenerIPAddress object.
	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.)
	SubnetIP	Gets or sets the subnet IP of the availability group listener.
	SubnetIPv4Mask	Gets or sets the subnet IP v4 mask of the availability group listener.
	SubnetMask	Gets or sets the subnet IP mask of the availability group listener.
	SubnetPrefixLength	Gets or sets the subnet prefix length 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.)

Top

Methods

	Name	Description
	Create	Creates an AvailabilityGroupListenerIPAddress into the AvailabilityGroupListener.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	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.)
	Script()	Generates a script for 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.)

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.

Share via