Implementing Endpoints
Applies to: 
SQL Server
Azure SQL Database
Azure SQL Managed Instance
Azure Synapse Analytics
An endpoint is a service that can listen natively for requests. SMO supports various types of endpoints by using the Endpoint object. You can create an endpoint service that handles a specific type of payload, which uses a specific protocol, by creating an instance of an Endpoint object and setting its properties.
The EndpointType property of the Endpoint object can be used to specify on of the following payload types:
Database mirroring
SOAP (support for SOAP endpoints is present in SQL Server 2008 R2 (10.50.x) and earlier SQL Server versions)
Service Broker
-
Transact-SQL
Also, the ProtocolType property can be used to specify the following two supported protocols:
HTTP protocol
TCP protocol
Having specified the type of payload, the actual payload can be set by using the Payload object property. The Payload object property provides a reference to a payload object of the specified type, for which the properties can be modified.
For the DatabaseMirroringPayload object, you must specify the mirroring role and whether encryption is enabled. The ServiceBrokerPayload object requires information about message forwarding, maximum number of connections allowed and the authentication mode. The SoapPayloadMethod object requires various properties to be set including the Add object property that specifies the SOAP payload methods available to clients (stored procedures and user-defined functions).
Similarly, the actual protocol can be set by using the Protocol object property that references a protocol object of the type specified by ProtocolType property. The HttpProtocol object requires a list of restricted IP addresses, and port, website, and authentication information. The TcpProtocol object also requires a list of restricted IP addresses and port information.
When the endpoint has been created and fully defined, access can be granted to, revoked from, and denied to database users, groups, roles, and logons.
Example
For the following code example, you will have to select the programming environment, programming template and the programming language to create your application. For more information, see Create a Visual C# SMO Project in Visual Studio .NET.
Creating a Database Mirroring Endpoint Service in Visual Basic
The code example demonstrates how to create a Database Mirroring endpoint in SMO. This is necessary before you create a database mirror. Use the IsMirroringEnabled and other properties on the Database object to create a database mirror.
'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)
Creating a Database Mirroring Endpoint Service in Visual C#
The code example demonstrates how to create a Database Mirroring endpoint in SMO. This is necessary before you create a database mirror. Use the IsMirroringEnabled and other properties on the Database object to create a database mirror.
{
//Set up a database mirroring endpoint on the server before
//setting up a database mirror.
//Connect to the local, default instance of SQL Server.
Server srv = new Server();
//Define an Endpoint object variable for database mirroring.
Endpoint ep = default(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);
}
Creating a Database Mirroring Endpoint Service in PowerShell
The code example demonstrates how to create a Database Mirroring endpoint in SMO. This is necessary before you create a database mirror. Use the IsMirroringEnabled and other properties on the Database object to create a database mirror.
# Set the path context to the local, default instance of SQL Server.
CD \sql\localhost\
$srv = get-item default
#Get a new endpoint to congure and add
$ep = New-Object -TypeName Microsoft.SqlServer.Management.SMO.Endpoint -argumentlist $srv,"Mirroring_Endpoint"
#Set some properties
$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 #inline comment
$ep.Payload.DatabaseMirroring.ServerMirroringRole = [Microsoft.SqlServer.Management.SMO.ServerMirroringRole]::All
# Create the endpoint on the instance
$ep.Create()
# Start the endpoint
$ep.Start()
# Report its state
$ep.EndpointState;