RuleDescription RuleDescription Class

Represents a description of a rule.

Syntax

Declaration

[DataContract(Name = "RuleDescription", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public sealed class RuleDescription : EntityDescription, IExtensibleDataObject, IResourceDescription<DataContract(Name:="RuleDescription", Namespace:="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>
Public NotInheritable Class RuleDescription
    Inherits EntityDescription
    Implements IExtensibleDataObject, IResourceDescription

Inheritance Hierarchy

Constructors summary

Initializes a new instance of the RuleDescription class with default values.

Initializes a new instance of the RuleDescription class with the specified filter expression.

Initializes a new instance of the RuleDescription class with the specified name.

Initializes a new instance of the RuleDescription class with the specified name and filter expression.

Fields summary

The default name used in creating default rule when adding subscriptions to a topic. The name is "$Default".

Properties summary

Gets or sets the action to perform if the message satisfies the filtering expression.

Gets creation time of the rule.

Gets or sets the filter expression used to match messages.

Gets or sets the name of the rule.

Constructors

  • RuleDescription()
    RuleDescription()

    Initializes a new instance of the RuleDescription class with default values.

    public RuleDescription()Public Sub New
  • RuleDescription(Filter)
    RuleDescription(Filter)

    Initializes a new instance of the RuleDescription class with the specified filter expression.

    public RuleDescription(Filter filter)Public Sub New(filter As Filter)

    Parameters

    • filter

      The filter expression used to match messages.

  • RuleDescription(String)
    RuleDescription(String)

    Initializes a new instance of the RuleDescription class with the specified name.

    public RuleDescription(string name)Public Sub New(name As String)

    Parameters

  • RuleDescription(String, Filter)
    RuleDescription(String, Filter)

    Initializes a new instance of the RuleDescription class with the specified name and filter expression.

    public RuleDescription(string name, Filter filter)Public Sub New(name As String, filter As Filter)

    Parameters

Fields

  • DefaultRuleName
    DefaultRuleName

    The default name used in creating default rule when adding subscriptions to a topic. The name is "$Default".

    public const string DefaultRuleName = "$Default"Public Const DefaultRuleName As String = "$Default"

Properties

  • Action
    Action

    Gets or sets the action to perform if the message satisfies the filtering expression.

    [DataMember(Name = "Action", IsRequired = false, Order = 65538, EmitDefaultValue = false)]
    public RuleAction Action { get; set; }<DataMember(Name:="Action", IsRequired:=False, Order:=65538, EmitDefaultValue:=False)>
    Public Property Action As RuleAction

    Property Value

  • CreatedAt
    CreatedAt

    Gets creation time of the rule.

    public DateTime CreatedAt { get; }Public ReadOnly Property CreatedAt As Date

    Property Value

  • Filter
    Filter

    Gets or sets the filter expression used to match messages.

    [DataMember(Name = "Filter", IsRequired = false, Order = 65537, EmitDefaultValue = false)]
    public Filter Filter { get; set; }<DataMember(Name:="Filter", IsRequired:=False, Order:=65537, EmitDefaultValue:=False)>
    Public Property Filter As Filter

    Property Value

    • The filter expression used to match messages.

    Exceptions

  • Name
    Name

    Gets or sets the name of the rule.

    [DataMember(Name = "Name", IsRequired = false, Order = 131077, EmitDefaultValue = false)]
    public string Name { get; set; }<DataMember(Name:="Name", IsRequired:=False, Order:=131077, EmitDefaultValue:=False)>
    Public Property Name As String

    Property Value

Details

Namespace

Microsoft.ServiceBus.Messaging

Assembly

Microsoft.ServiceBus.dll