ServiceBusRuleManager interface

Package:

@azure/service-bus

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

Methods

createRule(string, CorrelationRuleFilter | SqlRuleFilter, OperationOptionsBase)	Adds a rule to the current subscription to filter the messages reaching from topic to the subscription.
createRule(string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptionsBase)	Adds a rule to the current subscription to filter the messages reaching from topic to the subscription.
deleteRule(string, OperationOptionsBase)	Deletes a rule.
listRules(OperationOptions)	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.

Method Details

createRule(string, CorrelationRuleFilter | SqlRuleFilter, OperationOptionsBase)

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

function createRule(ruleName: string, filter: CorrelationRuleFilter | SqlRuleFilter, options?: OperationOptionsBase): Promise<void>

Parameters

ruleName

string

the name of the rule

filter

CorrelationRuleFilter | SqlRuleFilter

the filter expression that the rule evaluates.

options

OperationOptionsBase

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

Returns

Promise<void>

createRule(string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptionsBase)

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

function createRule(ruleName: string, filter: CorrelationRuleFilter | SqlRuleFilter, ruleAction?: SqlRuleAction, options?: OperationOptionsBase): Promise<void>

Parameters

ruleName

string

the name of the rule

filter

CorrelationRuleFilter | SqlRuleFilter

the filter expression that the rule evaluates.

ruleAction

SqlRuleAction

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

options

OperationOptionsBase

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

Returns

Promise<void>

deleteRule(string, OperationOptionsBase)

Deletes a rule.

function deleteRule(ruleName: string, options?: OperationOptionsBase): Promise<void>

Parameters

ruleName

string

the name of the rule

options

OperationOptionsBase

Returns

Promise<void>

listRules(OperationOptions)

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.

function listRules(options?: OperationOptions): PagedAsyncIterableIterator<RuleProperties, RuleProperties[], PageSettings>

Parameters

options

OperationOptions

Returns

PagedAsyncIterableIterator<RuleProperties, RuleProperties[], PageSettings>

An asyncIterableIterator that supports paging.