Package version:

Interface ServiceBusRuleManager

Allows rules for a subscription to be managed. This rule manager requires only Listen claims, whereas the ServiceBusAdministrationClient requires Manage claims.

interface ServiceBusRuleManager {
    createRule(ruleName, filter, options?): Promise<void>;
    createRule(ruleName, filter, ruleAction?, options?): Promise<void>;
    deleteRule(ruleName, options?): Promise<void>;
    listRules(options?): PagedAsyncIterableIterator<RuleProperties>;
}

Methods

createRule deleteRule listRules

Methods

createRule

  • createRule(ruleName, filter, options?): Promise<void>

  • Adds a rule to the current subscription to filter the messages reaching from topic to the subscription.

    Parameters

    Returns Promise<void>

  • createRule(ruleName, filter, ruleAction?, options?): Promise<void>

  • Adds a rule to the current subscription to filter the messages reaching from topic to the subscription.

    Parameters

    • ruleName: string

      the name of the rule

    • filter: CorrelationRuleFilter | SqlRuleFilter

      the filter expression that the rule evaluates.

    • Optional ruleAction: SqlRuleAction

      The SQL like expression that can be executed on the message should the associated filter apply.

    • Optional options: OperationOptionsBase

      The options that can be used to abort, trace and control other configurations on the request.

    Returns Promise<void>

deleteRule

listRules

  • listRules(options?): PagedAsyncIterableIterator<RuleProperties>

  • Returns an async iterable iterator to list all the rules under the specified subscription.

    .byPage() returns an async iterable iterator to list the rules in pages.

    Parameters

    • Optional options: any

    Returns PagedAsyncIterableIterator<RuleProperties>

    An asyncIterableIterator that supports paging.

Settings

Member Visibility

Theme

Generated using TypeDoc