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, IDropIfExists

NameDescription
System_CAPS_pubmethodBrokerService()

Initializes a new instance of the BrokerService class.

System_CAPS_pubmethodBrokerService(ServiceBroker, String)

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

NameDescription
System_CAPS_pubpropertyEvents

Gets the events associated with the Service Broker service.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyExtendedProperties

Gets the extended properties of the Service Broker service.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the Service Broker service.

System_CAPS_pubpropertyIsSystemObject

Gets a Boolean which indicates whether this instance is system object.

System_CAPS_pubpropertyName

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

System_CAPS_pubpropertyOwner

Gets or sets the Service Broker service owner.

System_CAPS_pubpropertyParent

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

System_CAPS_pubpropertyProperties

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

System_CAPS_pubpropertyQueueName

Gets or sets the queue that the service uses to hold messages.

System_CAPS_pubpropertyQueueSchema

Gets or sets the schema for the queue that the service uses to hold messages.

System_CAPS_pubpropertyServiceContractMappings

Gets a collection of contracts that are mapped to the Service Broker service.

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

System_CAPS_pubmethodCreate()

Creates a Service Broker service on the instance of Microsoft SQL Server as defined by the BrokerService object.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String)

Denies access to the specified permission for the specified grantee on the Service Broker service.

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

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[])

Denies access to the specified permission for the specified grantees on the Service Broker service.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[], Boolean)

Denies access to the specified permission for the specified grantees on the Service Broker service.

System_CAPS_pubmethodDiscover()

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

System_CAPS_pubmethodDrop()

Removes the Service Broker service.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of object permissions for the Service Broker service.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet)

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

System_CAPS_pubmethodEnumObjectPermissions(String)

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

System_CAPS_pubmethodEnumObjectPermissions(String, ObjectPermissionSet)

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

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 Broker service.

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 Broker service.

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 Broker service.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[])

Grants access to the specified permission for the specified grantees on the Service Broker service.

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 Broker service.

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 Broker service 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 Broker service.

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

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

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String[])

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

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

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

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

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.

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: