ServiceBusRuleManager interface

Pacote:

@azure/service-bus

Permite que as regras de uma assinatura sejam gerenciadas. Esse gerenciador de regras requer apenas Declarações de escuta, enquanto o ServiceBusAdministrationClient requer Gerenciar declarações.

Métodos

createRule(string, CorrelationRuleFilter | SqlRuleFilter, OperationOptionsBase)	Adiciona uma regra à assinatura atual para filtrar as mensagens que chegam do tópico à assinatura.
createRule(string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptionsBase)	Adiciona uma regra à assinatura atual para filtrar as mensagens que chegam do tópico à assinatura.
deleteRule(string, OperationOptionsBase)	Exclui uma regra.
listRules(OperationOptions)	Retorna um iterador iterável assíncrono para listar todas as regras na assinatura especificada. .byPage() retorna um iterador iterável assíncrono para listar as regras em páginas.

Detalhes do método

createRule(string, CorrelationRuleFilter | SqlRuleFilter, OperationOptionsBase)

Adiciona uma regra à assinatura atual para filtrar as mensagens que chegam do tópico à assinatura.

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 avaliada pela regra.

options

OperationOptionsBase

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação.

Retornos

Promise<void>

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

Adiciona uma regra à assinatura atual para filtrar as mensagens que chegam do tópico à assinatura.

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 avaliada pela regra.

ruleAction

SqlRuleAction

A expressão semelhante ao SQL que pode ser executada na mensagem deve ser aplicada ao filtro associado.

options

OperationOptionsBase

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação.

Retornos

Promise<void>

deleteRule(string, OperationOptionsBase)

Exclui uma regra.

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

Parâmetros

ruleName

string

o nome da regra

options

OperationOptionsBase

Retornos

Promise<void>

listRules(OperationOptions)

Retorna um iterador iterável assíncrono para listar todas as regras na assinatura especificada.

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

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

Parâmetros

options

OperationOptions

Retornos

PagedAsyncIterableIterator<RuleProperties, RuleProperties[], PageSettings>

Um asyncIterableIterator que dá suporte à paginação.