Export (0) Print
Expand All

ServiceRoute Class

The ServiceRoute object represents a Service Broker route that contains the location information for the service and the database on which it is defined.

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

[PhysicalFacetAttribute]
[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
[LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Smo.Broker.BrokerLocalizableResources", 
	true)]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class ServiceRoute : BrokerObjectBase, 
	IObjectPermission, IExtendedProperties, ICreatable, IAlterable, IDroppable

The ServiceRoute type exposes the following members.

  NameDescription
Public methodServiceRoute()Initializes a new instance of the ServiceRoute class.
Public methodServiceRoute(ServiceBroker, String)Initializes a new instance of the ServiceRoute class on the specified instance of Service Broker and with the specified name.
Top

  NameDescription
Public propertyAddressGets or sets the connection string for the remote Service Broker instance addressed by the route.
Public propertyBrokerInstanceGets or sets the Service Broker instance that hosts the remote service.
Public propertyEventsGets the events associated with the service route.
Public propertyExpirationDateGets or sets the date and time when the service route expires.
Public propertyExtendedPropertiesGets the extended properties of the ServiceRoute object.
Public propertyIDGets the ID value that uniquely identifies the service route.
Public propertyMirrorAddressGets or sets the connection string of the remote mirrored Service Broker instance addressed by this route.
Public propertyNameGets or sets the name of the object. (Inherited from BrokerObjectBase.)
Public propertyOwnerGets or sets the owner of the service route.
Public propertyParentGets or sets the ServiceBroker object that is the parent of the ServiceRoute object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyRemoteServiceGets or sets the remote service addressed by the service route.
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 ServiceRoute object property changes on the instance of Microsoft SQL Server. 
Public methodCreateCreates a service route on the instance of Microsoft SQL Server as defined by the ServiceRoute object.
Public methodDeny(ObjectPermissionSet, String)Denies access to the specified permission for the specified grantee on the service route.
Public methodDeny(ObjectPermissionSet, String[])Denies access to the specified permission for the specified grantees on the service route.
Public methodDeny(ObjectPermissionSet, String, Boolean)Denies access to the specified permission for the specified grantee and other users who the grantee granted access on the service route.
Public methodDeny(ObjectPermissionSet, String[], Boolean)Denies access to the specified permission for the specified grantees on the service route.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the service route.
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the service route.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the service route.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the service route.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the service route.
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 methodGetDBNameReturns the name of the database on which the instance of Service Broker is implemented. (Inherited from BrokerObjectBase.)
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 access to the specified permission for the specified grantee on the service route.
Public methodGrant(ObjectPermissionSet, String[])Grants access to the specified permission for the specified grantees on the service route.
Public methodGrant(ObjectPermissionSet, String, Boolean)Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the service route.
Public methodGrant(ObjectPermissionSet, String[], Boolean)Grants access to the specified permission and the ability to grant access to other users for the specified grantees on the service route.
Public methodGrant(ObjectPermissionSet, String, Boolean, String)Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the service route.
Public methodGrant(ObjectPermissionSet, String[], Boolean, String)Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the service route 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 script name. (Inherited from ScriptNameObjectBase.)
Public methodRevoke(ObjectPermissionSet, String)Revokes previously granted permissions from a grantee on the service route.
Public methodRevoke(ObjectPermissionSet, String[])Revokes previously granted permissions from a list of grantees on the service route.
Public methodRevoke(ObjectPermissionSet, String, Boolean, Boolean)Revokes previously granted permissions from a grantee on the service route and any other users to whom the grantee has granted access. The grantee is also given the ability to revoke other users' access.
Public methodRevoke(ObjectPermissionSet, String[], Boolean, Boolean)Revokes previously granted permissions from a grantees on the service route and any other users to whom the grantees have granted access. The grantees are also given the ability to revoke other users' access.
Public methodRevoke(ObjectPermissionSet, String, Boolean, Boolean, String)Revokes previously granted permissions from a grantee on the service route and any other users to whom the grantee has granted access. The grantee is also given the ability to revoke other users' access under an assumed role.
Public methodRevoke(ObjectPermissionSet, String[], Boolean, Boolean, String)Revokes previously granted permissions from grantees on the service route and any other users to whom the grantees have granted access. The grantees are also given the ability to revoke other users' access under an assumed role.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the Service Broker object. (Inherited from BrokerObjectBase.)
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the SQL Server Agent alert as specified by the scripting options. (Inherited from BrokerObjectBase.)
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
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

A route is required for message delivery. By default, each database contains a route that specifies the location as the current instance of Microsoft SQL Server.

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

To set ServiceRoute object properties, users must be a member of the db_ddladmin or db_owner fixed database roles, or be a member of the sysadmin fixed server role. The user also requires REFERENCES permission on the specified schema.

To create a service route, users must be a member of the db_ddladmin or db_owner fixed database roles, or be a member of the sysadmin fixed server role. The user also requires REFERENCES permission on the specified schema.

To drop a service route, users must be a member of the db_ddladmin or db_owner fixed database roles, or be a member of the sysadmin fixed server role. The user also requires REFERENCES permission on the specified schema.

To grant, deny, or revoke permissions on the message type to other users, users must have CONTROL permission on the service route.

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