ServiceQueue Class

The ServiceQueue object represents a queue that stores Service Broker messages.

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.ScriptSchemaObjectBase
            Microsoft.SqlServer.Management.Smo.Broker.ServiceQueue

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

Syntax

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

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

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

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

public final class ServiceQueue extends ScriptSchemaObjectBase implements ISfcSupportsDesignMode, IObjectPermission, IExtendedProperties, ICreatable, IAlterable, IDroppable, IScriptable

The ServiceQueue type exposes the following members.

Constructors

	Name	Description
	ServiceQueue()	Initializes a new instance of the ServiceQueue class.
	ServiceQueue(ServiceBroker, String)	Initializes a new instance of the ServiceQueue class on the specified instance of Service Broker and with the specified name.
	ServiceQueue(ServiceBroker, String, String)	Initializes a new instance of the ServiceQueue class on the specified instance of Service Broker and with the specified name and schema.

Top

Properties

	Name	Description
	ActivationExecutionContext	Gets or sets the execution context for the activated procedure.
	CreateDate	Gets the date and time when the service queue was created.
	DateLastModified	Gets the date and time when the service queue was last modified.
	Events	Gets the events associated with the service queue.
	ExecutionContextPrincipal	Gets or sets the server principal for the activated procedure.
	ExtendedProperties	Gets the extended properties of the ServiceQueue object.
	FileGroup	Gets or sets the filegroup on which the service queue is located.
	ID	Gets the ID value that uniquely identifies the service queue.
	IsActivationEnabled	Gets or sets the Boolean property that specifies whether activation is enabled for the service queue.
	IsEnqueueEnabled	Gets or sets the Boolean property that specifies whether the queue is enabled.
	IsPoisonMessageHandlingEnabled	Gets or sets a Boolean property that specifies whether automatic poison message handling is active for the Service Broker queue.
	IsRetentionEnabled	Gets or sets the Boolean property that specifies whether the retention is enabled for the service queue.
	IsSystemObject	Gets a value that indicates whether the ServiceQueue is a system object.
	MaxReaders	Gets or sets the maximum number of concurrent queue readers.
	Name	Gets or sets the String containing the name of the ServiceQueue (Overrides ScriptSchemaObjectBase.Name.)
	Parent	Gets or sets the ServiceBroker object that is the parent of the ServiceQueue object.
	ProcedureDatabase	Gets or sets the database that contains the executing procedure.
	ProcedureName	Gets or sets the name of the executing procedure.
	ProcedureSchema	Gets or sets the schema of the executing procedure.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	RowCount	Gets the number of rows in the service queue.
	RowCountAsDouble	Gets the number of rows in the service queue as a double floating point value.
	Schema	Gets or sets the String containing the name of the Schema associated with the ServiceQueue (Overrides ScriptSchemaObjectBase.Schema.)
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

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

Top

Events

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

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	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.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	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.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets or sets a property that specifies whether the object is open in design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed..

Top

Remarks

The ServiceQueue object provides asynchronous communication between services. It also provides other benefits, such as automatically locking messages in the same conversation group.

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

To set ServiceQueue 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 queue, 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 queue, 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 receive a message, users must have RECEIVE permission on the service queue.

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

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

CREATE QUEUE (Transact-SQL)

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 QUEUE (Transact-SQL)