• Article

Server.Endpoints Property

Represents a collection of Endpoint objects. Each Endpoint object represents an endpoint defined on the instance of SQL Server.

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

Syntax

'Declaration
<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny,  _
    GetType(Endpoint))> _
Public ReadOnly Property Endpoints As EndpointCollection
    Get
'Usage
Dim instance As Server
Dim value As EndpointCollection

value = instance.Endpoints

[SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny, 
    typeof(Endpoint))]
public EndpointCollection Endpoints { get; }

[SfcObjectAttribute(SfcContainerRelationship::ObjectContainer, SfcContainerCardinality::ZeroToAny, 
    typeof(Endpoint))]
public:
property EndpointCollection^ Endpoints {
    EndpointCollection^ get ();
}

[<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny, 
    typeof(Endpoint))>]
member Endpoints : EndpointCollection

function get Endpoints () : EndpointCollection

Property Value

Type: Microsoft.SqlServer.Management.Smo.EndpointCollection
An EndpointCollection object that represents all the endpoints defined on the instance of SQL Server.

Remarks

The Endpoint class is used to manage connections over the network for SQL Server services. These include database mirroring, SQL Server, Transact-SQL, and SOAP requests. These are also referred to as the payload types.

Examples

Visual Basic

'Set up a database mirroring endpoint on the server before setting up a database mirror.
'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Define an Endpoint object variable for database mirroring.
Dim ep As Endpoint
ep = New Endpoint(srv, "Mirroring_Endpoint")
ep.ProtocolType = ProtocolType.Tcp
ep.EndpointType = EndpointType.DatabaseMirroring
'Specify the protocol ports.
ep.Protocol.Http.SslPort = 5024
ep.Protocol.Tcp.ListenerPort = 6666
'Specify the role of the payload.
ep.Payload.DatabaseMirroring.ServerMirroringRole = ServerMirroringRole.All
'Create the endpoint on the instance of SQL Server.
ep.Create()
'Start the endpoint.
ep.Start()
Console.WriteLine(ep.EndpointState)

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$ep = new-object Microsoft.SqlServer.Management.Smo.Endpoint($srv, "Mirroring Endpoint")
$ep.ProtocolType = [Microsoft.SqlServer.Management.Smo.ProtocolType]::Tcp
$ep.EndpointType = [Microsoft.SqlServer.Management.Smo.EndpointType]::DatabaseMirroring
$ep.Protocol.Http.SslPort = 5024
$ep.Protocol.Tcp.ListenerPort = 6666
$ep.Payload.DatabaseMirroring.ServerMirroringRole = [Microsoft.SqlServer.Management.Smo.ServerMirroringRole]::All
$ep.Create()
$ep.Start()
Write-Host $ep.EndpointState