BrokerService Class

  • Article

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

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.Broker.BrokerObjectBase
            Microsoft.SqlServer.Management.Smo.Broker.BrokerService

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

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Smo.Broker.BrokerLocalizableResources",  _
    True)> _
<TypeConverterAttribute(GetType(LocalizableTypeConverter))> _
Public NotInheritable Class BrokerService _
    Inherits BrokerObjectBase _
    Implements IObjectPermission, IExtendedProperties, ICreatable, IAlterable,  _
    IDroppable
'Usage
Dim instance As BrokerService

[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

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

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
[<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Smo.Broker.BrokerLocalizableResources", 
    true)>]
[<TypeConverterAttribute(typeof(LocalizableTypeConverter))>]
type BrokerService =  
    class 
        inherit BrokerObjectBase 
        interface IObjectPermission 
        interface IExtendedProperties 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
    end

public final class BrokerService extends BrokerObjectBase implements IObjectPermission, IExtendedProperties, ICreatable, IAlterable, IDroppable

The BrokerService type exposes the following members.

Constructors

  Name Description
Public method BrokerService() Initializes a new instance of the BrokerService class.
Public method BrokerService(ServiceBroker, String) Initializes a new instance of the BrokerService class on the specified implementation of Service Broker and with the specified name.

Top

Properties

  Name Description
Public property Events Gets the events associated with the Service Broker service.
Public property ExtendedProperties Gets the extended properties of the Service Broker service.
Public property ID Gets the ID value that uniquely identifies the Service Broker service.
Public property IsSystemObject Gets a Boolean which indicates whether this instance is system object.
Public property Name Gets or sets the name of the object. (Inherited from BrokerObjectBase.)
Public property Owner Gets or sets the Service Broker service owner.
Public property Parent Gets or sets the ServiceBroker object that is the parent of the BrokerService object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property QueueName Gets or sets the queue that the service uses to hold messages.
Public property QueueSchema Gets or sets the schema for the queue that the service uses to hold messages.
Public property ServiceContractMappings Gets a collection of contracts that are mapped to the Service Broker service.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter Updates any BrokerService object property changes on the instance of Microsoft SQL Server. 
Public method Create Creates a Service Broker service on the instance of Microsoft SQL Server as defined by the BrokerService object.
Public method Deny(ObjectPermissionSet, String) Denies access to the specified permission for the specified grantee on the Service Broker service.
Public method Deny(ObjectPermissionSet, array<String[]) Denies access to the specified permission for the specified grantees on the Service Broker service.
Public method Deny(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 method Deny(ObjectPermissionSet, array<String[], Boolean) Denies access to the specified permission for the specified grantees on the Service Broker service.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the Service Broker service.
Public method EnumObjectPermissions() Enumerates a list of object permissions for the Service Broker service.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the Service Broker service.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the Service Broker service.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the Service Broker service.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Returns the name of the database on which the instance of Service Broker is implemented. (Inherited from BrokerObjectBase.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Grant(ObjectPermissionSet, String) Grants access to the specified permission for the specified grantee on the Service Broker service.
Public method Grant(ObjectPermissionSet, array<String[]) Grants access to the specified permission for the specified grantees on the Service Broker service.
Public method Grant(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 method Grant(ObjectPermissionSet, array<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 method Grant(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 method Grant(ObjectPermissionSet, array<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 method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Revoke(ObjectPermissionSet, String) Revokes previously granted permissions from a grantee on the Service Broker service.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes previously granted permissions from a list of grantees on the Service Broker service.
Public method Revoke(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 method Revoke(ObjectPermissionSet, array<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 method Revoke(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 method Revoke(ObjectPermissionSet, array<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 method Script() Generates a Transact-SQL script that can be used to re-create the Service Broker object. (Inherited from BrokerObjectBase.)
Public method Script(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 method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.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.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.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.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Remarks

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.

Examples

Overview [Service Broker]

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo.Broker Namespace

Other Resources

DEL - Development (Service Broker)

Managing Service Broker

Service Broker

CREATE SERVICE (Transact-SQL)