Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

BrokerService Class

The BrokerService object represents a Service Broker service, which is an addressable endpoint for conversations.

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 BrokerService : BrokerObjectBase, 
	IObjectPermission, IExtendedProperties, ICreatable, IAlterable, IDroppable

The BrokerService type exposes the following members.

  NameDescription
Public methodBrokerService()Initializes a new instance of the BrokerService class.
Public methodBrokerService(ServiceBroker, String)Initializes a new instance of the BrokerService class on the specified implementation of Service Broker and with the specified name.
Top
  NameDescription
Public propertyEventsGets the events associated with the Service Broker service.
Public propertyExtendedPropertiesGets the extended properties of the Service Broker service.
Public propertyIDGets the ID value that uniquely identifies the Service Broker service.
Public propertyIsSystemObjectGets a Boolean which indicates whether this instance is system object.
Public propertyNameGets or sets the name of the object. (Inherited from BrokerObjectBase.)
Public propertyOwnerGets or sets the Service Broker service owner.
Public propertyParentGets or sets the ServiceBroker object that is the parent of the BrokerService object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyQueueNameGets or sets the queue that the service uses to hold messages.
Public propertyQueueSchemaGets or sets the schema for the queue that the service uses to hold messages.
Public propertyServiceContractMappingsGets a collection of contracts that are mapped to the Service Broker service.
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 BrokerService object property changes on the instance of Microsoft SQL Server. 
Public methodCreateCreates a Service Broker service on the instance of Microsoft SQL Server as defined by the BrokerService object.
Public methodDeny(ObjectPermissionSet, String)Denies access to the specified permission for the specified grantee on the Service Broker service.
Public methodDeny(ObjectPermissionSet, String[])Denies access to the specified permission for the specified grantees on the Service Broker service.
Public methodDeny(ObjectPermissionSet, String, Boolean)Denies access to the specified permission for the specified grantee and other users who the grantee granted access to on the Service Broker service.
Public methodDeny(ObjectPermissionSet, String[], Boolean)Denies access to the specified permission for the specified grantees on the Service Broker service.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the Service Broker service.
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the Service Broker service.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the Service Broker service.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the Service Broker service.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the Service Broker service.
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 Broker service.
Public methodGrant(ObjectPermissionSet, String[])Grants access to the specified permission for the specified grantees on the Service Broker service.
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 Broker service.
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 Broker service.
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 Broker service.
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 Broker service 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 Broker service.
Public methodRevoke(ObjectPermissionSet, String[])Revokes previously granted permissions from a list of grantees on the Service Broker service.
Public methodRevoke(ObjectPermissionSet, String, Boolean, Boolean)Revokes previously granted permissions from a grantee on the Service Broker service 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 Broker service 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 Broker service 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 Broker service 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

Service Broker messages are sent from one service to another service. A service specifies a queue to hold messages, and also specifies the contracts for which the service can be the target.

A Service Broker service defines a set of contracts that list the other services from which the target service will accept incoming dialogs. If a service tries to start a dialog with another service, the contract specified by the initiator service must belong to the contract set of the target service. On the other hand, the initiator service can begin a dialog using a contract that is not part of its own contract set.

A service can be created with an empty service contract set.

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

To set BrokerService object properties, users must be owner of the service, be a member of the db_ddladmin or db_owner fixed database roles, or be a member of the sysadmin fixed server role.

To create a service, 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 must also have REFERENCES permission on the queue and all contracts specified.

To drop a service, users must be owner of the service, be a member of the db_ddladmin or db_owner fixed database roles, or be a member of the sysadmin fixed server role.

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

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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.