Endpoint Class

The Endpoint class represents an endpoint service that can listen natively for requests.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.Endpoint

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

Syntax

'Declaration
<StateChangeEventAttribute("CREATE_ENDPOINT", "ENDPOINT")> _
<StateChangeEventAttribute("ALTER_ENDPOINT", "ENDPOINT")> _
<StateChangeEventAttribute("ALTER_AUTHORIZATION_SERVER", "ENDPOINT")> _
<PhysicalFacetAttribute> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class Endpoint _
    Inherits ScriptNameObjectBase _
    Implements ICreatable, IAlterable, IDroppable, IScriptable,  _
    IObjectPermission
'Usage
Dim instance As Endpoint

[StateChangeEventAttribute("CREATE_ENDPOINT", "ENDPOINT")]
[StateChangeEventAttribute("ALTER_ENDPOINT", "ENDPOINT")]
[StateChangeEventAttribute("ALTER_AUTHORIZATION_SERVER", "ENDPOINT")]
[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class Endpoint : ScriptNameObjectBase, 
    ICreatable, IAlterable, IDroppable, IScriptable, IObjectPermission

[StateChangeEventAttribute(L"CREATE_ENDPOINT", L"ENDPOINT")]
[StateChangeEventAttribute(L"ALTER_ENDPOINT", L"ENDPOINT")]
[StateChangeEventAttribute(L"ALTER_AUTHORIZATION_SERVER", L"ENDPOINT")]
[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class Endpoint sealed : public ScriptNameObjectBase, 
    ICreatable, IAlterable, IDroppable, IScriptable, IObjectPermission

[<SealedAttribute>]
[<StateChangeEventAttribute("CREATE_ENDPOINT", "ENDPOINT")>]
[<StateChangeEventAttribute("ALTER_ENDPOINT", "ENDPOINT")>]
[<StateChangeEventAttribute("ALTER_AUTHORIZATION_SERVER", "ENDPOINT")>]
[<PhysicalFacetAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type Endpoint =  
    class 
        inherit ScriptNameObjectBase 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IScriptable 
        interface IObjectPermission 
    end

public final class Endpoint extends ScriptNameObjectBase implements ICreatable, IAlterable, IDroppable, IScriptable, IObjectPermission

The Endpoint type exposes the following members.

Constructors

	Name	Description
	Endpoint()	Initializes a new instance of the Endpoint class.
	Endpoint(Server, String)	Initializes a new instance of the Endpoint class with the specified name on the specified instance of Microsoft SQL Server.

Top

Properties

	Name	Description
	EndpointState	Gets the state of the endpoint.
	EndpointType	Gets or sets the type of the endpoint.
	ID	Gets the ID value that uniquely identifies the endpoint.
	IsAdminEndpoint	Gets the Boolean property value that specifies whether the endpoint is for administration.
	IsSystemObject	Determines if the Endpoint is a system object.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	Owner	Gets or sets the owner of the endpoint.
	Parent	Gets or sets the Server object that is the parent of the Endpoint object.
	Payload	Gets the endpoint payload.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	Protocol	Gets the protocol used by the endpoint.
	ProtocolType	Gets or sets the protocol type used by the endpoint.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	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
	Alter	Updates any Endpoint object property changes on the instance of Microsoft SQL Server.
	Create	Creates an endpoint on the instance of Microsoft SQL Server as defined by the Endpoint object.
	Deny(ObjectPermissionSet, String)	Denies the specified set of permissions for the specified grantee on the endpoint.
	Deny(ObjectPermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the endpoint.
	Deny(ObjectPermissionSet, String, Boolean)	Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the endpoint.
	Deny(ObjectPermissionSet, array<String[], Boolean)	Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the endpoint.
	Disable	Disables the endpoint.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes the endpoint from the instance of Microsoft SQL Server.
	EnumObjectPermissions()	Enumerates a list of permissions for the endpoint.
	EnumObjectPermissions(String)	Enumerates a list of permissions for the endpoint that belongs to the specified user.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of permissions for the endpoint limited to the specified permission set.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of permissions for the endpoint that belong to the specified user and limited to the specified permission set.
	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.)
	Grant(ObjectPermissionSet, String)	Grants the specified set of permissions to the specified grantee on the endpoint.
	Grant(ObjectPermissionSet, array<String[])	Grants the specified set of permissions to the specified grantees on the endpoint.
	Grant(ObjectPermissionSet, String, Boolean)	Grants access to the specified permission to the grantee and the ability to grant access to other users on the endpoint.
	Grant(ObjectPermissionSet, array<String[], Boolean)	Grants access to the specified permission to the grantees and the ability to grant access to other users on the endpoint.
	Grant(ObjectPermissionSet, String, Boolean, String)	Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the endpoint under an assumed role.
	Grant(ObjectPermissionSet, array<String[], Boolean, String)	Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the endpoint under an assumed role.
	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 endpoint. (Overrides ScriptNameObjectBase.Refresh().)
	Revoke(ObjectPermissionSet, String)	Revokes a previously granted set of permissions from a grantee on the endpoint.
	Revoke(ObjectPermissionSet, array<String[])	Revokes a previously granted set of permissions from a list of grantees on the endpoint.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean)	Revokes previously granted permissions from a grantee on the endpoint and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean)	Revokes previously granted permissions from grantees on the endpoint and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean, String)	Revokes previously granted permissions from a grantee on the endpoint and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String)	Revokes previously granted permissions from grantees on the endpoint and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Script()	Generates a Transact-SQL script that can be used to re-create the endpoint.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the endpoint as specified by the script options.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	Start	Starts the endpoint listening and processing requests.
	Stop	Stops the endpoint listening and processing requests.
	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

Remarks

The Endpoint object can be used to create an endpoint service for the following payload types:

• SOAP

• Service Broker

• Transact-SQL

• Database mirroring

To get Endpoint object properties, users can be a member or the public fixed server role.

To set Endpoint object properties, users must be the owner of the endpoint, have ALTER ANY ENDPONT permission on the server, or be a member of the sysadmin fixed server role.

To create an endpoint, users must have CREATE ANY ENDPOINT permission on the server or be a member of the sysadmin fixed server role.

To drop an endpoint, users must have CONTROL permission on the endpoint or be a member of the sysadmin fixed server role.

To stop, start, or disable an endpoint, users must be the owner of the endpoint, have ALTER ANY ENDPOINT permission on the server or be a member of the sysadmin fixed server role.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Examples

Implementing Endpoints

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

Other Resources

Endpoints Catalog Views (Transact-SQL)

CREATE ENDPOINT (Transact-SQL)