ServiceQueue Class

 

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

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


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

NameDescription
System_CAPS_pubmethodServiceQueue()

Initializes a new instance of the ServiceQueue class.

System_CAPS_pubmethodServiceQueue(ServiceBroker, String)

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

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

NameDescription
System_CAPS_pubpropertyActivationExecutionContext

Gets or sets the execution context for the activated procedure.

System_CAPS_pubpropertyCreateDate

Gets the date and time when the service queue was created.

System_CAPS_pubpropertyDateLastModified

Gets the date and time when the service queue was last modified.

System_CAPS_pubpropertyEvents

Gets the events associated with the service queue.

System_CAPS_pubpropertyExecutionContextPrincipal

Gets or sets the server principal for the activated procedure.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyExtendedProperties

Gets the extended properties of the ServiceQueue object.

System_CAPS_pubpropertyFileGroup

Gets or sets the filegroup on which the service queue is located.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the service queue.

System_CAPS_pubpropertyIsActivationEnabled

Gets or sets the Boolean property that specifies whether activation is enabled for the service queue.

System_CAPS_pubpropertyIsEnqueueEnabled

Gets or sets the Boolean property that specifies whether the queue is enabled.

System_CAPS_pubpropertyIsPoisonMessageHandlingEnabled

Gets or sets a Boolean property that specifies whether automatic poison message handling is active for the Service Broker queue.

System_CAPS_pubpropertyIsRetentionEnabled

Gets or sets the Boolean property that specifies whether the retention is enabled for the service queue.

System_CAPS_pubpropertyIsSystemObject

Gets a value that indicates whether the M:Microsoft.SqlServer.Management.Smo.Broker.ServiceQueue is a system object.

System_CAPS_pubpropertyMaxReaders

Gets or sets the maximum number of concurrent queue readers.

System_CAPS_pubpropertyName

Gets or sets the String containing the name of the ServiceQueue(Overrides ScriptSchemaObjectBase.Name.)

System_CAPS_pubpropertyParent

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

System_CAPS_pubpropertyProcedureDatabase

Gets or sets the database that contains the executing procedure.

System_CAPS_pubpropertyProcedureName

Gets or sets the name of the executing procedure.

System_CAPS_pubpropertyProcedureSchema

Gets or sets the schema of the executing procedure.

System_CAPS_pubpropertyProperties

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

System_CAPS_pubpropertyRowCount

Gets the number of rows in the service queue.

System_CAPS_pubpropertyRowCountAsDouble

Gets the number of rows in the service queue as a double floating point value.

System_CAPS_pubpropertySchema

Gets or sets the String containing the name of the Schema associated with the ServiceQueue(Overrides ScriptSchemaObjectBase.Schema.)

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

System_CAPS_pubmethodCreate()

Creates a service queue on the instance of SQL Server as defined by the ServiceQueue object.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String)

Denies access to the specified permission for the specified grantee on the service queue.

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

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[])

Denies access to the specified permission for the specified grantees on the service queue.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[], Boolean)

Denies access to the specified permission for the specified grantees on the service queue.

System_CAPS_pubmethodDiscover()

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

System_CAPS_pubmethodDrop()

Removes the service queue.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of object permissions for the service queue.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet)

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

System_CAPS_pubmethodEnumObjectPermissions(String)

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

System_CAPS_pubmethodEnumObjectPermissions(String, ObjectPermissionSet)

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

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

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

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

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

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

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[])

Grants access to the specified permission for the specified grantees on the service queue.

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

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 queue 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_pubmethodMoveTo(String)

System_CAPS_pubmethodMoveTo(String, Int32)

System_CAPS_pubmethodRebuild()

System_CAPS_pubmethodRebuild(Int32)

System_CAPS_pubmethodRefresh()

Refreshes the script name.(Inherited from ScriptNameObjectBase.)

System_CAPS_pubmethodReorganize()

System_CAPS_pubmethodReorganize(Boolean)

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String)

Revokes previously granted permissions from a grantee on the service queue.

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

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

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String[])

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

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

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

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the Service Broker service queue.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to create the Service Broker service queue as specified by the scripting options.

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

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcSupportsDesignMode.IsDesignMode

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.

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.

CREATE QUEUE (Transact-SQL)

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: