Share via

AvailabilityGroupListenerIPAddress Class

  • Article

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
Public method AvailabilityGroupListenerIPAddress() Initializes a new instance of the AvailabilityGroupListenerIPAddress class using default values.
Public method AvailabilityGroupListenerIPAddress(AvailabilityGroupListener) Initializes a new instance of the AvailabilityGroupListenerIPAddress class using the specified availability group listener.

Top

Properties

  Name Description
Public property IPAddress Gets or sets the IP address of the availability group listener.
Public property IPAddressState Gets the IP state of the availability group listener.
Public property IPAddressStateDescription Gets the state description of the availability group listener IP address.
Public property IsDHCP Gets a value that indicates whether the object is DHCP.
Public property IsIPv6 Gets a value that indicates whether the object is IP v6.
Public property Parent Gets an object that is the parent of the AvailabilityGroupListenerIPAddress object.
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 SubnetIP Gets or sets the subnet IP of the availability group listener.
Public property SubnetIPv4Mask Gets or sets the subnet IP v4 mask of the availability group listener.
Public property SubnetMask Gets or sets the subnet IP mask of the availability group listener.
Public property SubnetPrefixLength Gets or sets the subnet prefix length of the availability group listener.
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 Create Creates an AvailabilityGroupListenerIPAddress into the AvailabilityGroupListener.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Equals (Inherited from Object.)
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 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 Script() Generates a script for this availability group listener.
Public method Script(ScriptingOptions) Generates a script for this availability group listener 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