TechNet
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)


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

NameDescription
System_CAPS_pubmethodServiceRoute()

Initializes a new instance of the ServiceRoute class.

System_CAPS_pubmethodServiceRoute(ServiceBroker, String)

Initializes a new instance of the ServiceRoute class on the specified instance of Service Broker and with the specified name.

NameDescription
System_CAPS_pubpropertyAddress

Gets or sets the connection string for the remote Service Broker instance addressed by the route.

System_CAPS_pubpropertyBrokerInstance

Gets or sets the Service Broker instance that hosts the remote service.

System_CAPS_pubpropertyEvents

Gets the events associated with the service route.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyExpirationDate

Gets or sets the date and time when the service route expires.

System_CAPS_pubpropertyExtendedProperties

Gets the extended properties of the ServiceRoute object.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the service route.

System_CAPS_pubpropertyMirrorAddress

Gets or sets the connection string of the remote mirrored Service Broker instance addressed by this route.

System_CAPS_pubpropertyName

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

System_CAPS_pubpropertyOwner

Gets or sets the owner of the service route.

System_CAPS_pubpropertyParent

Gets or sets the ServiceBroker object that is the parent of the ServiceRoute object.

System_CAPS_pubpropertyProperties

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

System_CAPS_pubpropertyRemoteService

Gets or sets the remote service addressed by the service route.

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 ServiceRoute object property changes on the instance of Microsoft SQL Server. 

System_CAPS_pubmethodCreate()

Creates a service route on the instance of Microsoft SQL Server as defined by the ServiceRoute object.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String)

Denies access to the specified permission for the specified grantee on the service route.

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

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[])

Denies access to the specified permission for the specified grantees on the service route.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[], Boolean)

Denies access to the specified permission for the specified grantees on the service route.

System_CAPS_pubmethodDiscover()

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

System_CAPS_pubmethodDrop()

Removes the service route.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of object permissions for the service route.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet)

Enumerates a list of object permissions for a specified permission on the service route.

System_CAPS_pubmethodEnumObjectPermissions(String)

Enumerates a list of object permissions for a specified grantee on the service route.

System_CAPS_pubmethodEnumObjectPermissions(String, ObjectPermissionSet)

Enumerates a list of object permissions for a specified grantee and a specified permission on the service route.

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()

Returns the name of the database on which the instance of Service Broker is implemented.(Inherited from BrokerObjectBase.)

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 access to the specified permission for the specified grantee on the service route.

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

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

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[])

Grants access to the specified permission for the specified grantees on the service route.

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

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

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)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the script name.(Inherited from ScriptNameObjectBase.)

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String)

Revokes previously granted permissions from a grantee on the service route.

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

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

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String[])

Revokes previously granted permissions from a list of grantees on the service route.

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

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

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the Service Broker object.(Inherited from BrokerObjectBase.)

System_CAPS_pubmethodScript(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.)

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

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

System_CAPS_pubmethodToString()

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

System_CAPS_pubmethodValidate(String, 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.)

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.

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.

Overview [Service Broker]

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:
© 2016 Microsoft