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)


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

NameDescription
System_CAPS_pubmethodEndpoint()

Initializes a new instance of the Endpoint class.

System_CAPS_pubmethodEndpoint(Server^, String^)

Initializes a new instance of the Endpoint class with the specified name on the specified instance of Microsoft SQL Server.

NameDescription
System_CAPS_pubpropertyEndpointState

Gets the state of the endpoint.

System_CAPS_pubpropertyEndpointType

Gets or sets the type of the endpoint.

System_CAPS_pubpropertyExecutionManager

Gets the object to execute to the manager.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the endpoint.

System_CAPS_pubpropertyIsAdminEndpoint

Gets the Boolean property value that specifies whether the endpoint is for administration.

System_CAPS_pubpropertyIsSystemObject

Determines if the Endpoint is a system object.

System_CAPS_pubpropertyName

Gets or sets the name of the object.(Inherited from NamedSmoObject.)

System_CAPS_pubpropertyOwner

Gets or sets the owner of the endpoint.

System_CAPS_pubpropertyParent

Gets or sets the Server object that is the parent of the Endpoint object.

System_CAPS_pubpropertyPayload

Gets the endpoint payload.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyProtocol

Gets the protocol used by the endpoint.

System_CAPS_pubpropertyProtocolType

Gets or sets the protocol type used by the endpoint.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any Endpoint object property changes on the instance of Microsoft SQL Server. 

System_CAPS_pubmethodCreate()

Creates an endpoint on the instance of Microsoft SQL Server as defined by the Endpoint object.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, String^)

Denies the specified set of permissions for the specified grantee on the endpoint.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, array<String^>^)

Denies the specified set of permissions for the specified grantees on the endpoint.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDisable()

Disables the endpoint.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the endpoint from the instance of Microsoft SQL Server.

System_CAPS_pubmethodDropIfExists()

Drops the endpoint object if it exists.

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of permissions for the endpoint.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet^)

Enumerates a list of permissions for the endpoint limited to the specified permission set.

System_CAPS_pubmethodEnumObjectPermissions(String^)

Enumerates a list of permissions for the endpoint that belongs to the specified user.

System_CAPS_pubmethodEnumObjectPermissions(String^, ObjectPermissionSet^)

Enumerates a list of permissions for the endpoint that belong to the specified user and limited to the specified permission set.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object^)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGrant(ObjectPermissionSet^, String^)

Grants the specified set of permissions to the specified grantee on the endpoint.

System_CAPS_pubmethodGrant(ObjectPermissionSet^, String^, Boolean)

Grants access to the specified permission to the grantee and the ability to grant access to other users on the endpoint.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(ObjectPermissionSet^, array<String^>^)

Grants the specified set of permissions to the specified grantees on the endpoint.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String^)

Determines whether the specified property is supported in the target .NET Framework.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the endpoint.(Overrides ScriptNameObjectBase::Refresh().)

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, String^)

Revokes a previously granted set of permissions from a grantee on the endpoint.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, array<String^>^)

Revokes a previously granted set of permissions from a list of grantees on the endpoint.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the endpoint.

System_CAPS_pubmethodScript(ScriptingOptions^)

Generates a Transact-SQL script that can be used to re-create the endpoint as specified by the script options.

System_CAPS_protmethodSetParentImpl(SqlSmoObject^)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodStart()

Starts the endpoint listening and processing requests.

System_CAPS_pubmethodStop()

Stops the endpoint listening and processing requests.

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String^, array<Object^>^)

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetPropertyType(String^)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetPropertyValue(String^, Type^)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::Resolve(String^)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::SetPropertyValue(String^, Type^, Object^)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider::GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

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.

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.

Return to top
Show: