Compartilhar via


@azure/service-bus package

Classes

MessagingError

Descreve a classe base para Erro de Mensagens.

ServiceBusAdministrationClient

Todas as operações retornam promessas que resolvem para um objeto que tem a saída relevante. Esses objetos também têm uma propriedade chamada _response que você pode usar se quiser acessar a resposta direta do serviço.

ServiceBusClient

Um cliente que pode criar instâncias de Remetente para enviar mensagens para filas e tópicos, bem como instâncias de receptor para receber mensagens de filas e assinaturas.

ServiceBusError

Erros que ocorrem no Barramento de Serviço.

Interfaces

AuthorizationRule

Representa o tipo de AuthorizationRule em operações de gerenciamento baseadas em ATOM.

CorrelationRuleFilter

Representa a expressão de filtro de correlação. Um CorrelationRuleFilter contém um conjunto de condições correspondentes às propriedades do usuário e do sistema de mensagens de entrada de uma Assinatura.

CreateMessageBatchOptions

Opções para configurar o método createBatch no Sender.

  • maxSizeInBytes: o limite superior para o tamanho do lote.

Uso de exemplo:

{
    maxSizeInBytes: 1024 * 1024 // 1 MB
}
CreateQueueOptions

Representa opções configuráveis em uma fila

CreateSubscriptionOptions

Representa opções configuráveis em uma assinatura

CreateTopicOptions

Representa opções configuráveis em um tópico

DeadLetterOptions

Descreve o motivo e a descrição do erro para enviar mensagens mortas usando o método deadLetter() na mensagem recebida do Barramento de Serviço.

Delivery
GetMessageIteratorOptions

Opções ao obter um iterador iterável do Barramento de Serviço.

HttpHeader

Um cabeçalho individual dentro de uma coleção HttpHeaders.

HttpHeadersLike

Uma coleção de pares chave/valor de cabeçalho HTTP.

HttpResponse

As propriedades em uma resposta HTTP que sempre estarão presentes.

MessageHandlers

A interface geral do manipulador de mensagens (usada para streamMessages).

NamespaceProperties

Representa os metadados relacionados a um namespace do barramento de serviço.

OperationOptions

O tipo de opções base para todas as operações.

PeekMessagesOptions

Descreve as opções passadas para o método peekMessages em um receptor.

ProcessErrorArgs

Argumentos para o retorno de chamada processError.

QueueProperties

Representa a entrada para updateQueue.

QueueRuntimeProperties

Representa atributos de informações de runtime de uma entidade de fila

ReceiveMessagesOptions

Opções ao receber um lote de mensagens do Barramento de Serviço.

RetryOptions

Opções de política de repetição que determinam o modo, o número de repetições, o intervalo de repetição etc.

RuleProperties

Representa todos os atributos de uma regra.

ServiceBusAdministrationClientOptions

Representa as opções de cliente do ServiceBusAdministrationClient.

ServiceBusClientOptions

Descreve as opções que podem ser fornecidas durante a criação do ServiceBusClient.

  • webSocketOptions: opções para configurar a canalização da conexão AMQP por meio de Soquetes Web.
    • websocket: o construtor WebSocket usado para criar uma conexão AMQP se você optar por fazer a conexão em um WebSocket.
    • webSocketConstructorOptions: opções para passar para o construtor Websocket quando você optar por fazer a conexão em um WebSocket.
  • retryOptions: as opções de repetição para todas as operações no cliente.
    • maxRetries: o número de vezes que a operação pode ser repetida no caso de um erro retrátivel.
    • maxRetryDelayInMs: o atraso máximo entre novas tentativas. Aplicável somente ao executar novas tentativas exponencial.
    • mode: qual modo de repetição aplicar, especificado pela enumeração RetryMode. As opções são Exponential e Fixed. O padrão é Fixed.
    • retryDelayInMs: tempo de espera em milissegundos antes de fazer a próxima tentativa. Quando mode é definido como Exponential, isso é usado para calcular os atrasos exponencialmente crescentes entre repetições. Padrão: 30000 milissegundos.
    • timeoutInMs: quantidade de tempo em milissegundos para aguardar antes do tempo limite da operação. Isso disparará uma nova tentativa se houver outras tentativas restantes. Valor mínimo: 60000 milissegundos.
ServiceBusConnectionStringProperties

O conjunto de propriedades que compõem uma cadeia de conexão do Barramento de Serviço.

ServiceBusMessage

Descreve a mensagem a ser enviada ao Barramento de Serviço.

ServiceBusMessageBatch

Um lote de mensagens que você pode criar usando o método <xref:createBatch>.

ServiceBusReceivedMessage

Descreve a mensagem recebida do Barramento de Serviço durante as operações de inspeção e, portanto, não pode ser resolvida.

ServiceBusReceiver

Um receptor que não manipula sessões.

ServiceBusReceiverOptions

Opções a serem usadas ao criar um receptor.

ServiceBusRuleManager

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

ServiceBusSender

Um Remetente pode ser usado para enviar mensagens, agendar mensagens para serem enviadas posteriormente e cancelar essas mensagens agendadas. Use a função createSender no ServiceBusClient para criar uma instância de um Remetente. A classe Sender é uma abstração no link do remetente AMQP subjacente.

ServiceBusSenderOptions

Opções a serem usadas ao criar um remetente.

ServiceBusSessionReceiver

Um receptor que manipula sessões, incluindo a renovação do bloqueio de sessão.

ServiceBusSessionReceiverOptions

Descreve as opções passadas para os métodos acceptSession e acceptNextSession ao usar uma fila/assinatura que tenha sessões habilitadas.

SqlRuleFilter

Representa todos os campos possíveis no SqlRuleFilter

SubscribeOptions

Opções usadas ao assinar uma fila ou assinatura do Barramento de Serviço.

SubscriptionProperties

Representa a entrada para updateSubscription.

SubscriptionRuntimeProperties

Representa atributos de informações de runtime de uma entidade de assinatura

TokenCredential

Representa uma credencial capaz de fornecer um token de autenticação.

TopicProperties

Representa a entrada para updateTopic.

TopicRuntimeProperties

Representa atributos de informações de runtime de uma entidade de tópico

TryAddOptions

O conjunto de opções para propagar manualmente Span contexto para rastreamento distribuído.

WebResourceLike

Uma descrição de uma solicitação HTTP a ser feita a um servidor remoto.

WebSocketImpl

Descreve a forma necessária de construtores WebSocket.

WebSocketOptions

Opções para configurar a canalização da conexão AMQP por meio de Soquetes Web.

Aliases de tipo

EntitiesResponse

Representa o resultado da operação de lista em entidades que também contém o continuationToken de onde começar a iterar.

EntityAvailabilityStatus

Valores possíveis para availabilityStatus das entidades de mensagens do Barramento de Serviço.

EntityStatus

Valores possíveis para status das entidades de mensagens do Barramento de Serviço.

OperationOptionsBase

OBSERVAÇÃO: esse tipo destina-se a espelhar os campos e a estrutura relevantes de @azure/core-client OperationOptions

Opções para configurar o rastreamento e o abortSignal.

RawHttpHeaders

Uma coleção HttpHeaders representada como um objeto JSON simples.

ServiceBusErrorCode

Códigos de falha do Barramento de Serviço.

SqlRuleAction

Representa todos os campos possíveis no SqlRuleAction

TransferProgressEvent

Acionado em resposta ao progresso de upload ou download.

WithResponse

Representa a resposta retornada da operação junto com a resposta bruta.

Enumerações

RetryMode

Descreve o tipo de Modo de Repetição

TokenType

Descreve o tipo de tokens com suporte.

Funções

delay<T>(number, AbortSignalLike, string, T)

Um wrapper para setTimeout que resolve uma promessa após milissegundos.

isServiceBusError(unknown)

Determina se um erro é do tipo ServiceBusError

parseServiceBusConnectionString(string)

Analisa a cadeia de conexão fornecida nas diferentes propriedades aplicáveis ao Barramento de Serviço do Azure. As propriedades são úteis para construir um ServiceBusClient.

Detalhes da função

delay<T>(number, AbortSignalLike, string, T)

Um wrapper para setTimeout que resolve uma promessa após milissegundos.

function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>

Parâmetros

delayInMs

number

O número de milissegundos a serem atrasados.

abortSignal
AbortSignalLike

O abortSignal associado à operação de contenção.

abortErrorMsg

string

A mensagem de erro de anulação associada à operação de contenção.

value

T

O valor a ser resolvido após um tempo limite de t milissegundos.

Retornos

Promise<T | void>

  • Promessa resolvida

isServiceBusError(unknown)

Determina se um erro é do tipo ServiceBusError

function isServiceBusError(err: unknown): err

Parâmetros

err

unknown

Um erro para verificar se ele é do tipo ServiceBusError

Retornos

err

parseServiceBusConnectionString(string)

Analisa a cadeia de conexão fornecida nas diferentes propriedades aplicáveis ao Barramento de Serviço do Azure. As propriedades são úteis para construir um ServiceBusClient.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Parâmetros

connectionString

string

A cadeia de conexão associada à Política de Acesso Compartilhado criada para o namespace, fila ou tópico do Barramento de Serviço.

Retornos