Export (0) Print
Expand All

Endpoint Class

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

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

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

The Endpoint type exposes the following members.

  NameDescription
Public methodEndpoint()Initializes a new instance of the Endpoint class.
Public methodEndpoint(Server, String)Initializes a new instance of the Endpoint class with the specified name on the specified instance of Microsoft SQL Server.
Top

  NameDescription
Public propertyEndpointStateGets the state of the endpoint.
Public propertyEndpointTypeGets or sets the type of the endpoint.
Public propertyIDGets the ID value that uniquely identifies the endpoint.
Public propertyIsAdminEndpointGets the Boolean property value that specifies whether the endpoint is for administration.
Public propertyIsSystemObjectDetermines if the Endpoint is a system object.
Public propertyNameGets or sets the name of the object. (Inherited from NamedSmoObject.)
Public propertyOwnerGets or sets the owner of the endpoint.
Public propertyParentGets or sets the Server object that is the parent of the Endpoint object.
Public propertyPayloadGets the endpoint payload.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyProtocolGets the protocol used by the endpoint.
Public propertyProtocolTypeGets or sets the protocol type used by the endpoint.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAlterUpdates any Endpoint object property changes on the instance of Microsoft SQL Server. 
Public methodCreateCreates an endpoint on the instance of Microsoft SQL Server as defined by the Endpoint object.
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the endpoint.
Public methodDeny(ObjectPermissionSet, String[])Denies the specified set of permissions for the specified grantees on the endpoint.
Public methodDeny(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.
Public methodDeny(ObjectPermissionSet, 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.
Public methodDisableDisables the endpoint.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the endpoint from the instance of Microsoft SQL Server.
Public methodEnumObjectPermissions()Enumerates a list of permissions for the endpoint.
Public methodEnumObjectPermissions(String)Enumerates a list of permissions for the endpoint that belongs to the specified user.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of permissions for the endpoint limited to the specified permission set.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of permissions for the endpoint that belong to the specified user and limited to the specified permission set.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to the specified grantee on the endpoint.
Public methodGrant(ObjectPermissionSet, String[])Grants the specified set of permissions to the specified grantees on the endpoint.
Public methodGrant(ObjectPermissionSet, String, Boolean)Grants access to the specified permission to the grantee and the ability to grant access to other users on the endpoint.
Public methodGrant(ObjectPermissionSet, String[], Boolean)Grants access to the specified permission to the grantees and the ability to grant access to other users on the endpoint.
Public methodGrant(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.
Public methodGrant(ObjectPermissionSet, 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.
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the endpoint. (Overrides ScriptNameObjectBase.Refresh().)
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the endpoint.
Public methodRevoke(ObjectPermissionSet, String[])Revokes a previously granted set of permissions from a list of grantees on the endpoint.
Public methodRevoke(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.
Public methodRevoke(ObjectPermissionSet, 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.
Public methodRevoke(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.
Public methodRevoke(ObjectPermissionSet, 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.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the endpoint.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the endpoint as specified by the script options.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodStartStarts the endpoint listening and processing requests.
Public methodStopStops the endpoint listening and processing requests.
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets 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 methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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 methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft