Endpoint Members
Include Protected Members
Include Inherited Members
The Endpoint class represents an endpoint service that can listen natively for requests.
The Endpoint type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
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
Methods
| Name | Description | |
|---|---|---|
.gif "Protected method") |
AddDatabaseContext(StringCollection) | (Inherited from SqlSmoObject.) |
|
Alter() | Updates any Endpoint object property changes on the instance of Microsoft SQL Server. |
|
AlterImpl() | (Inherited from SqlSmoObject.) |
|
AlterImplFinish(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
AlterImplInit(StringCollection%, ScriptingOptions%) | (Inherited from SqlSmoObject.) |
|
AlterImplWorker() | (Inherited from SqlSmoObject.) |
|
AppendCommaText(StringBuilder, String, Boolean%, String) | (Inherited from ScriptNameObjectBase.) |
|
AppendWithCommaText(StringBuilder, String, Boolean%) | (Inherited from ScriptNameObjectBase.) |
|
AppendWithOption(StringBuilder, String, String, Boolean%) | (Inherited from ScriptNameObjectBase.) |
|
BindDefaultImpl(String, String, Boolean) | (Inherited from SqlSmoObject.) |
|
BindRuleImpl(String, String, Boolean) | (Inherited from SqlSmoObject.) |
|
CheckCollation(String, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
CheckObjectDirty() | (Inherited from ScriptNameObjectBase.) |
|
CheckObjectState() | Validates the state of the referenced object. (Inherited from SqlSmoObject.) |
|
CheckObjectState(Boolean) | Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.) |
|
CheckObjectStateImpl(Boolean) | (Inherited from SqlSmoObject.) |
|
CheckTextCorectness(String, Boolean, Boolean, array<String[], DdlTextParserHeaderInfo%) | (Inherited from ScriptNameObjectBase.) |
|
CheckTextModeSupport() | (Inherited from ScriptNameObjectBase.) |
|
CheckVersion100() | (Inherited from SqlSmoObject.) |
|
CheckVersion80() | Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.) |
|
CheckVersion80SP3() | Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.) |
|
CheckVersion90() | Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.) |
|
CheckVersionBelow90() | (Inherited from SqlSmoObject.) |
|
CleanObject() | Cleans the referenced object. (Inherited from ScriptNameObjectBase.) |
|
Create() | Creates an endpoint on the instance of Microsoft SQL Server as defined by the Endpoint object. |
|
CreateImpl() | (Inherited from SqlSmoObject.) |
|
CreateImplFinish(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
CreateImplInit(StringCollection%, ScriptingOptions%) | (Inherited from SqlSmoObject.) |
|
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() | (Inherited from SqlSmoObject.) |
|
Drop() | Removes the endpoint from the instance of Microsoft SQL Server. |
|
DropImpl() | (Inherited from SqlSmoObject.) |
|
DropImplWorker(Urn%) | (Inherited from SqlSmoObject.) |
|
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. |
|
EnumScriptImpl(ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
EnumScriptImplWorker(ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
Equals(Object) | (Inherited from Object.) |
|
Finalize() | (Inherited from Object.) |
|
ForceTextModeOnTextBody() | Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.) |
|
FormatSqlVariant(Object) | (Inherited from SqlSmoObject.) |
|
GenerateDataSpaceFileStreamScript(StringBuilder, ScriptingOptions, Boolean) | (Inherited from SqlSmoObject.) |
|
GenerateDataSpaceScript(StringBuilder, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
GetBindDefaultScript(ScriptingOptions, String, String, Boolean) | (Inherited from SqlSmoObject.) |
|
GetBindRuleScript(ScriptingOptions, String, String, Boolean) | (Inherited from SqlSmoObject.) |
|
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | (Inherited from SqlSmoObject.) |
|
GetBraketNameForText() | (Inherited from ScriptNameObjectBase.) |
|
GetDateTimeParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetDateTimeParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetDBName() | Gets the database name that is associated with the object. (Inherited from SqlSmoObject.) |
|
GetEnumParameter(StringBuilder, ScriptingOptions, String, String, Type, Int32%) | (Inherited from SqlSmoObject.) |
|
GetFragOptionString(FragmentationOption) | (Inherited from SqlSmoObject.) |
|
GetGuidParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetIsTextDirty() | Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.) |
|
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | (Inherited from SqlSmoObject.) |
|
GetPropValue(String) | (Inherited from SqlSmoObject.) |
|
GetPropValueOptional(String) | (Inherited from SqlSmoObject.) |
|
GetPropValueOptionalAllowNull(String) | (Inherited from SqlSmoObject.) |
|
GetRealValue(Property, Object) | (Inherited from SqlSmoObject.) |
|
GetScriptIncludeExists(ScriptingOptions, String, Boolean) | (Inherited from ScriptNameObjectBase.) |
|
GetScriptingOptionsForCreate() | (Inherited from SqlSmoObject.) |
|
GetServerName() | Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) |
|
GetServerObject() | (Inherited from SqlSmoObject.) |
|
GetSqlServerVersionName() | Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) |
|
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | (Inherited from SqlSmoObject.) |
|
GetTextBody() | Returns the text body. (Inherited from ScriptNameObjectBase.) |
|
GetTextBody(Boolean) | Returns the text body. (Inherited from ScriptNameObjectBase.) |
|
GetTextForScript(ScriptingOptions, Boolean, array<String[]) | Gets the text for scripting. (Inherited from ScriptNameObjectBase.) |
|
GetTextForScript(ScriptingOptions, Boolean, array<String[], Boolean) | (Inherited from ScriptNameObjectBase.) |
|
GetTextHeader(Boolean) | Returns the text header. (Inherited from ScriptNameObjectBase.) |
|
GetTextMode() | Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.) |
|
GetTextProperty(String) | (Inherited from ScriptNameObjectBase.) |
|
GetTextProperty(String, ScriptingOptions) | (Inherited from ScriptNameObjectBase.) |
|
GetTimeSpanParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetType() | (Inherited from Object.) |
|
GetUrnRecursive(StringBuilder) | (Inherited from SqlSmoObject.) |
|
GetUrnRecursive(StringBuilder, UrnIdOption) | (Inherited from SqlSmoObject.) |
|
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. |
|
ImplInitialize(array<String[], array<OrderBy[]) | (Inherited from SqlSmoObject.) |
|
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.) |
|
IsObjectDirty() | Determines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.) |
|
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.) |
|
IsVersion80SP3() | (Inherited from SqlSmoObject.) |
|
MarkDropped() | (Inherited from SqlSmoObject.) |
|
MarkForDropImpl(Boolean) | (Inherited from SqlSmoObject.) |
|
MemberwiseClone() | (Inherited from Object.) |
|
PostAlter() | (Inherited from SqlSmoObject.) |
|
PostCreate() | (Inherited from SqlSmoObject.) |
|
PostDrop() | (Inherited from SqlSmoObject.) |
|
Refresh() | Refreshes the endpoint. (Overrides ScriptNameObjectBase.Refresh().) |
|
RenameImpl(String) | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) |
|
RenameImplWorker(String) | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) |
|
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. |
|
ScriptAlter(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
ScriptAnsiQI(SqlSmoObject, ScriptingOptions, StringCollection, StringBuilder, Object%, Object%) | (Inherited from ScriptNameObjectBase.) |
|
ScriptChangeOwner(StringCollection, ScriptingOptions) | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) |
|
ScriptCreate(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
ScriptDdl(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
ScriptDrop(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
ScriptImpl() | (Inherited from SqlSmoObject.) |
|
ScriptImpl(ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
ScriptImplWorker(ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
ScriptInformativeHeaders(ScriptingOptions, StringBuilder) | (Inherited from ScriptNameObjectBase.) |
|
ScriptRename(StringCollection, ScriptingOptions, String) | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) |
|
SetCollectionTextMode(Boolean, SmoCollectionBase) | Sets the collection text mode. (Inherited from ScriptNameObjectBase.) |
|
SetParentImpl(SqlSmoObject) | (Inherited from SqlSmoObject.) |
|
SetTextBody(String) | Specifies the text body. (Inherited from ScriptNameObjectBase.) |
|
SetTextHeader(String) | Specifies the text header. (Inherited from ScriptNameObjectBase.) |
|
SetTextMode(Boolean, array<SmoCollectionBase[]) | Specifies the text mode. (Inherited from ScriptNameObjectBase.) |
|
Start() | Starts the endpoint listening and processing requests. |
|
Stop() | Stops the endpoint listening and processing requests. |
|
SwitchTextMode(Boolean, array<SmoCollectionBase[]) | Switches the text mode. (Inherited from ScriptNameObjectBase.) |
|
ThrowIfTextIsDirtyForAlter() | (Inherited from ScriptNameObjectBase.) |
|
ToString() | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) |
|
TouchImpl() | (Inherited from SqlSmoObject.) |
|
UnbindDefaultImpl(Boolean) | (Inherited from SqlSmoObject.) |
|
UnbindRuleImpl(Boolean) | (Inherited from SqlSmoObject.) |
|
Validate(String, array<Object[]) | (Inherited from SmoObjectBase.) |
Top
.gif "Protected field")
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
EndpointState | Gets the state of the endpoint. |
|
EndpointType | Gets or sets the type of the endpoint. |
.gif "Protected property") |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.) |
|
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. |
|
IsTouched | Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.) |
|
Name | Gets or sets the name of the object. (Inherited from NamedSmoObject.) |
|
ObjectInSpace | Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.) |
|
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. |
|
ScalarResult | Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.) |
|
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
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
PropertyChanged | (Inherited from SqlSmoObject.) |
|
PropertyMetadataChanged | (Inherited from SqlSmoObject.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IAlienObjectDiscover() | (Inherited from SqlSmoObject.) |
|
IAlienObjectGetParent() | (Inherited from SqlSmoObject.) |
|
IAlienObjectGetProperty(String) | (Inherited from SqlSmoObject.) |
|
ISfcPropertyProviderGetPropertySet() | (Inherited from SqlSmoObject.) |
|
IAlienObjectGetUrn() | (Inherited from SqlSmoObject.) |
|
IAlienObjectResolve(String) | (Inherited from SqlSmoObject.) |
|
IAlienObjectSetProperty(Object, Object) | (Inherited from SqlSmoObject.) |
Top