ServiceRoute Members
The ServiceRoute object represents a Service Broker route that contains the location information for the service and the database on which it is defined.
The following tables list the members exposed by the ServiceRoute type.
Public Constructors
| Name | Description | |
|---|---|---|
| ServiceRoute | Overloaded. Initializes a new instance of the ServiceRoute class. |
Top
Protected Fields
| Name | Description | |
|---|---|---|
.gif "ms219217.protfield(en-US,SQL.90).gif") |
m_ExtendedProperties | (inherited from SqlSmoObject ) |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "ms219217.pubproperty(en-US,SQL.90).gif") |
Address | Gets or sets the connection string for the remote Service Broker instance addressed by the route. |
|
BrokerInstance | Gets or sets the Service Broker instance that hosts the remote service. |
|
Events | Gets the events associated with the service route. |
|
ExpirationDate | Gets or sets the date and time when the service route expires. |
|
ExtendedProperties | Gets the extended properties of the ServiceRoute object. |
|
ID | Gets the ID value that uniquely identifies the service route. |
|
MirrorAddress | Gets or sets the connection string of the remote mirrored Service Broker instance addressed by this route. |
|
Name | Gets or sets the name of the object. (inherited from NamedSmoObject) |
|
Owner | Gets or sets the owner of the service route. |
|
Parent | Gets or sets the ServiceBroker object that is the parent of the ServiceRoute object. |
|
Properties | Gets a collection of Property objects that represent the object properties. (inherited from SqlSmoObject) |
|
RemoteService | Gets or sets the remote service addressed by the service route. |
|
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
Protected Properties
| Name | Description | |
|---|---|---|
.gif "ms219217.protproperty(en-US,SQL.90).gif") |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (inherited from SqlSmoObject) |
|
ObjectInSpace | Gets the Boolean property value that specifies whether the object exists in isolation or whether it is connected to the instance of Microsoft SQL Server directly or indirectly. (inherited from SqlSmoObject) |
|
PresetProperties | Gets or sets the preset properties of the referenced object. (inherited from SqlSmoObject) |
|
ScalarResult | Gets the scalar result for the referenced object. (inherited from SqlSmoObject) |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "ms219217.pubmethod(en-US,SQL.90).gif") |
Alter | Updates any ServiceRoute object property changes on the instance of Microsoft SQL Server. |
|
Create | Creates a service route on the instance of Microsoft SQL Server as defined by the ServiceRoute object. |
|
Deny | Overloaded. Denies access to the specified permission for the specified grantees on the service route. |
|
Drop | Removes the service route. |
|
EnumObjectPermissions | Overloaded. Enumerates a list of object permissions for the service route. |
|
Equals | Overloaded. (inherited from Object ) |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
Grant | Overloaded. Grants access to the specified permission for the specified grantees on the service route. |
|
Initialize | Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject) |
.gif "ms219217.static(en-US,SQL.90).gif") |
ReferenceEquals | (inherited from Object ) |
|
Refresh | Refreshes the script name. (inherited from ScriptNameObjectBase) |
|
Revoke | Overloaded. Revokes previously granted permissions from a grantee or grantees on the service route. |
|
Script | Overloaded. Generates a Transact-SQL script that can be used to re-create the Service Broker object. (inherited from BrokerObjectBase) |
|
ToString | Returns a String that represents the referenced object. (inherited from SqlSmoObject) |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "ms219217.protmethod(en-US,SQL.90).gif") |
AlterImpl | (inherited from SqlSmoObject ) |
|
AlterImplFinish | (inherited from SqlSmoObject ) |
|
AlterImplInit | (inherited from SqlSmoObject ) |
|
AlterImplWorker | (inherited from SqlSmoObject ) |
|
AppendCommaText | (inherited from ScriptNameObjectBase ) |
|
AppendWithCommaText | (inherited from ScriptNameObjectBase ) |
|
AppendWithOption | (inherited from ScriptNameObjectBase ) |
|
BindDefaultImpl | (inherited from SqlSmoObject ) |
|
BindRuleImpl | (inherited from SqlSmoObject ) |
|
CheckCollation | (inherited from SqlSmoObject ) |
|
CheckObjectState | Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject) |
|
CheckObjectStateImpl | (inherited from SqlSmoObject ) |
|
CheckTextCorectness | (inherited from ScriptNameObjectBase ) |
|
CheckTextModeSupport | (inherited from ScriptNameObjectBase ) |
|
CheckVersion80 | Checks the validity of the object on Microsoft SQL Server 2000. (inherited from SqlSmoObject) |
|
CheckVersion80SP3 | Checks the validity of the object on Microsoft SQL Server 2000 SP3. (inherited from SqlSmoObject) |
|
CheckVersion90 | Check the validity of the object on Microsoft SQL Server 2005. (inherited from SqlSmoObject) |
|
CheckVersionBelow90 | (inherited from SqlSmoObject ) |
|
CleanObject | Cleans the referenced object. (inherited from ScriptNameObjectBase) |
|
CreateImpl | (inherited from SqlSmoObject ) |
|
CreateImplFinish | (inherited from SqlSmoObject ) |
|
CreateImplInit | (inherited from SqlSmoObject ) |
|
DropImpl | (inherited from SqlSmoObject ) |
|
DropImplWorker | (inherited from SqlSmoObject ) |
|
Finalize | (inherited from Object ) |
|
ForceTextModeOnTextBody | Enforces text mode on the text body. (inherited from ScriptNameObjectBase) |
|
FormatSqlVariant | (inherited from SqlSmoObject ) |
|
GenerateDataSpaceScript | (inherited from SqlSmoObject ) |
|
GetBindDefaultScript | (inherited from SqlSmoObject ) |
|
GetBindRuleScript | (inherited from SqlSmoObject ) |
|
GetBoolParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetBraketNameForText | (inherited from ScriptNameObjectBase ) |
|
GetDateTimeParameter | (inherited from SqlSmoObject ) |
|
GetDateTimeParameterAsInt | (inherited from SqlSmoObject ) |
|
GetDBName | Returns the name of the database on which the instance of Service Broker is implemented. (inherited from BrokerObjectBase) |
|
GetEnumParameter | (inherited from SqlSmoObject ) |
|
GetFragOptionString | (inherited from SqlSmoObject ) |
|
GetGuidParameter | (inherited from SqlSmoObject ) |
|
GetIsTextDirty | Determines whether the text value is consistent with stored value. (inherited from ScriptNameObjectBase) |
|
GetParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetPropValue | (inherited from SqlSmoObject ) |
|
GetPropValueOptional | (inherited from SqlSmoObject ) |
|
GetPropValueOptionalAllowNull | (inherited from SqlSmoObject ) |
|
GetRealValue | (inherited from SqlSmoObject ) |
|
GetScriptIncludeExists | (inherited from ScriptNameObjectBase ) |
|
GetScriptingOptionsForCreate | (inherited from SqlSmoObject ) |
|
GetServerName | Gets the name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) |
|
GetSqlServerVersionName | Gets the version name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) |
|
GetStringParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetTextBody | Overloaded. Returns the text body. (inherited from ScriptNameObjectBase) |
|
GetTextForScript | (inherited from ScriptNameObjectBase ) |
|
GetTextHeader | (inherited from ScriptNameObjectBase ) |
|
GetTextMode | Determines whether the script name is using text mode. (inherited from ScriptNameObjectBase) |
|
GetTextProperty | (inherited from ScriptNameObjectBase ) |
|
GetTimeSpanParameterAsInt | (inherited from SqlSmoObject ) |
|
GetUrnRecursive | Overloaded. (inherited from SqlSmoObject ) |
|
ImplInitialize | (inherited from SqlSmoObject ) |
|
IsCollectionDirty | (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 Microsoft SQL Server. (inherited from SqlSmoObject) |
|
IsVersion80SP3 | (inherited from SqlSmoObject ) |
|
MarkDropped | (inherited from SqlSmoObject ) |
|
MarkForDropImpl | (inherited from SqlSmoObject ) |
|
MemberwiseClone | (inherited from Object ) |
|
PostAlter | (inherited from SqlSmoObject ) |
|
PostCreate | (inherited from SqlSmoObject ) |
|
PostDrop | (inherited from SqlSmoObject ) |
|
RenameImpl | (inherited from NamedSmoObject ) |
|
RenameImplWorker | (inherited from NamedSmoObject ) |
|
ScriptAlter | (inherited from SqlSmoObject ) |
|
ScriptAnsiQI | (inherited from ScriptNameObjectBase ) |
|
ScriptChangeOwner | (inherited from NamedSmoObject ) |
|
ScriptCreate | (inherited from SqlSmoObject ) |
|
ScriptDdl | (inherited from SqlSmoObject ) |
|
ScriptDrop | (inherited from SqlSmoObject ) |
|
ScriptImpl | Overloaded. (inherited from SqlSmoObject ) |
|
ScriptImplWorker | (inherited from SqlSmoObject ) |
|
ScriptInformativeHeaders | (inherited from ScriptNameObjectBase ) |
|
ScriptRename | (inherited from NamedSmoObject ) |
|
SetCollectionTextMode | (inherited from ScriptNameObjectBase ) |
|
SetParentImpl | (inherited from SqlSmoObject ) |
|
SetTextBody | (inherited from ScriptNameObjectBase ) |
|
SetTextHeader | (inherited from ScriptNameObjectBase ) |
|
SetTextMode | (inherited from ScriptNameObjectBase ) |
|
SwitchTextMode | (inherited from ScriptNameObjectBase ) |
|
ThrowIfTextIsDirtyForAlter | (inherited from ScriptNameObjectBase ) |
|
Trace | (inherited from SqlSmoObject ) |
|
UnbindDefaultImpl | (inherited from SqlSmoObject ) |
|
UnbindRuleImpl | (inherited from SqlSmoObject ) |
|
UpdateCollectionState2 | (inherited from SqlSmoObject ) |
Top
See Also
Reference
ServiceRoute Class
Microsoft.SqlServer.Management.Smo.Broker Namespace
Other Resources
Service Broker Programming
Managing Service Broker
Introducing Service Broker
CREATE ROUTE (Transact-SQL)