BrokerPriority Class

  • Article

The BrokerPriority object represents a priority level and the set of criteria for determining which Service Broker conversations to assign the priority level.

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

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

Syntax

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

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

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

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

public final class BrokerPriority extends BrokerObjectBase implements IObjectPermission, ICreatable, IAlterable, IDroppable, IScriptable

The BrokerPriority type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property ContractName Gets or sets the contract name specified for the BrokerPriority object.
Public property ID Gets the conversation priority ID associated with the BrokerPriority object.
Public property LocalServiceName Gets or sets the local service name associated with the BrokerPriority object.
Public property Name Gets or sets the name of the object. (Inherited from BrokerObjectBase.)
Public property Parent Gets or sets the ServiceBroker object that is the parent of the BrokerPriority object
Public property PriorityLevel Gets or sets the priority level associated with the BrokerPriority object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property RemoteServiceName Gets or sets the remote service name associated with the BrokerPriority object.
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 a conversation priority in an instance of SQL Server with any property changes made in the specified BrokerPriority object.
Public method Create Creates a conversation priority on the instance of Microsoft SQL Server as defined by the BrokerPriority object.
Public method Deny(ObjectPermissionSet, String) This method will be removed in a future version of the product.Denies access to the specified permission for the specified grantees on the conversation priority.
Public method Deny(ObjectPermissionSet, array<String[]) This method will be removed in a future version of the product.Denies access to the specified permission for the specified grantees on the conversation priority.
Public method Deny(ObjectPermissionSet, String, Boolean) This method will be removed in a future version of the product.Denies access to the specified permission for the specified grantee and other users that the grantee granted access to on the conversation priority.
Public method Deny(ObjectPermissionSet, array<String[], Boolean) This method will be removed in a future version of the product.Denies access to the specified permission for the specified grantee and other users that the grantee granted access to on the conversation priority.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the conversation priority.
Public method EnumObjectPermissions() This method will be removed in a future version of the product.Enumerates a list of object permissions for the conversation priority.
Public method EnumObjectPermissions(String) This method will be removed in a future version of the product.Enumerates a list of object permissions for a specified grantee on the conversation priority.
Public method EnumObjectPermissions(ObjectPermissionSet) This method will be removed in a future version of the product.Enumerates a list of object permissions for a specified permission on the conversation priority.
Public method EnumObjectPermissions(String, ObjectPermissionSet) This method will be removed in a future version of the product.Enumerates a list of object permissions for a specified grantee and a specified permission on the conversation priority.
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) This method will be removed in a future version of the product.Grants access to the specified permission for the specified grantees on the conversation priority.
Public method Grant(ObjectPermissionSet, array<String[]) This method will be removed in a future version of the product.Grants access to the specified permission for the specified grantees on the conversation priority.
Public method Grant(ObjectPermissionSet, String, Boolean) This method will be removed in a future version of the product.Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the conversation priority.
Public method Grant(ObjectPermissionSet, array<String[], Boolean) This method will be removed in a future version of the product.Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the conversation priority.
Public method Grant(ObjectPermissionSet, String, Boolean, String) This method will be removed in a future version of the product.Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the conversation priority.
Public method Grant(ObjectPermissionSet, array<String[], Boolean, String) This method will be removed in a future version of the product.Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the conversation priority.
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) This method will be removed in a future version of the product.Revokes previously granted permissions from a grantee on the conversation priority.
Public method Revoke(ObjectPermissionSet, array<String[]) This method will be removed in a future version of the product.Revokes previously granted permissions from a grantee on the conversation priority.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean) This method will be removed in a future version of the product.Revokes previously granted permissions from a grantee on the conversation priority 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) This method will be removed in a future version of the product.Revokes previously granted permissions from a grantee on the conversation priority 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, String, Boolean, Boolean, String) This method will be removed in a future version of the product.Revokes previously granted permissions from a grantee on the conversation priority 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, String) This method will be removed in a future version of the product.Revokes previously granted permissions from a grantee on the conversation priority 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 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

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

To set BrokerPriority 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 ALTER permission on the database.

To create a conversation priority, 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 ALTER permission on the database.

To drop a conversation priority, 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 ALTER permission on the database.

Warning

In a future release of SQL Server, BrokerPriority will no longer implement IObjectPermission.

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 BROKER PRIORITY (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

Conversation Priorities

Manage Conversation Priorities

Troubleshoot Conversation Priorities

DEL - Development (Service Broker)

Service Broker

CREATE BROKER PRIORITY (Transact-SQL)

ALTER BROKER PRIORITY (Transact-SQL)

DROP BROKER PRIORITY (Transact-SQL)