• Article

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)

Syntax

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

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

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

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Smo.Broker.BrokerLocalizableResources", 
    true)>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<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

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.

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.