ServiceBusRuleManager interface

Pacote:

@azure/service-bus

Permite que as regras de uma subscrição sejam geridas. Este gestor de regras requer apenas afirmações de Escuta, enquanto o ServiceBusAdministrationClient requer Gerir afirmações.

Métodos

createRule(string, CorrelationRuleFilter | SqlRuleFilter, OperationOptionsBase)	Adiciona uma regra à subscrição atual para filtrar as mensagens que chegam do tópico para a subscrição.
createRule(string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptionsBase)	Adiciona uma regra à subscrição atual para filtrar as mensagens que chegam do tópico para a subscrição.
deleteRule(string, OperationOptionsBase)	Elimina uma regra.
listRules(OperationOptions)	Devolve um iterador iterável assíncrono para listar todas as regras na subscrição especificada. .byPage() devolve um iterador iterável assíncrono para listar as regras nas páginas.

Detalhes de Método

createRule(string, CorrelationRuleFilter | SqlRuleFilter, OperationOptionsBase)

Adiciona uma regra à subscrição atual para filtrar as mensagens que chegam do tópico para a subscrição.

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

Parâmetros

ruleName

string

o nome da regra

filter

CorrelationRuleFilter | SqlRuleFilter

a expressão de filtro que a regra avalia.

options

OperationOptionsBase

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido.

Devoluções

Promise<void>

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

Adiciona uma regra à subscrição atual para filtrar as mensagens que chegam do tópico para a subscrição.

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

Parâmetros

ruleName

string

o nome da regra

filter

CorrelationRuleFilter | SqlRuleFilter

a expressão de filtro que a regra avalia.

ruleAction

SqlRuleAction

A expressão semelhante ao SQL que pode ser executada na mensagem caso se aplique o filtro associado.

options

OperationOptionsBase

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido.

Devoluções

Promise<void>

deleteRule(string, OperationOptionsBase)

Elimina uma regra.

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

Parâmetros

ruleName

string

o nome da regra

options

OperationOptionsBase

Devoluções

Promise<void>

listRules(OperationOptions)

Devolve um iterador iterável assíncrono para listar todas as regras na subscrição especificada.

.byPage() devolve um iterador iterável assíncrono para listar as regras nas páginas.

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

Parâmetros

options

OperationOptions

Devoluções

PagedAsyncIterableIterator<RuleProperties, RuleProperties[], PageSettings>

Um asyncIterableIterator que suporta a paginação.