@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 Recetor para receber mensagens de filas e assinaturas.
ServiceBusError	Erros que ocorrem no Service Bus.

Interfaces

AuthorizationRule	Representa o tipo de AuthorizationRule em operações de gerenciamento baseadas em ATOM.
CorrelationRuleFilter	Representa a expressão do filtro de correlação. Um CorrelationRuleFilter contém um conjunto de condições que são comparadas com as propriedades do usuário e do sistema de mensagens recebidas de uma Assinatura.
CreateMessageBatchOptions	Opções para configurar o método createBatch no Sender. maxSizeInBytes: O limite superior para o tamanho do lote. Exemplo de uso: { 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 letras mortas de uma mensagem usando o método deadLetter() na mensagem recebida do Service Bus.
Delivery
GetMessageIteratorOptions	Opções ao obter um iterador iterável do Service Bus.
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á presente.
MessageHandlers	A interface geral do manipulador de mensagens (usada para streamMessages).
NamespaceProperties	Representa os metadados relacionados a um namespace de 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 recetor.
ProcessErrorArgs	Argumentos para o retorno de chamada processError.
QueueProperties	Representa a entrada para updateQueue.
QueueRuntimeProperties	Representa atributos de informações de tempo de execução de uma entidade de fila
ReceiveMessagesOptions	Opções ao receber um lote de mensagens do Service Bus.
RetryOptions	Opções de política de repetição que determinam o modo, o número de tentativas, o intervalo de repetição etc.
RuleProperties	Representa todos os atributos de uma regra.
ServiceBusAdministrationClientOptions	Representa as opções do 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 através de Web Sockets. websocket : O construtor WebSocket usado para criar uma conexão AMQP se você optar por fazer a conexão através de um WebSocket. webSocketConstructorOptions : Opções para passar para o construtor Websocket quando você optar por fazer a conexão através de 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 em caso de um erro tentável. maxRetryDelayInMs: O atraso máximo entre as tentativas. Aplicável apenas ao realizar tentativas exponenciais. mode: Qual modo de repetição aplicar, especificado pelo RetryMode enum. As opções são Exponential e Fixed. O padrão é Fixed. retryDelayInMs: Quantidade de tempo para esperar em milissegundos antes de fazer a próxima tentativa. Quando mode é definido como Exponential, isso é usado para calcular os atrasos exponencialmente crescentes entre as tentativas. Padrão: 30000 milissegundos. timeoutInMs: Quantidade de tempo em milissegundos para aguardar antes que a operação atinja o tempo limite. Isso acionará uma nova tentativa se houver alguma tentativa restante. Valor mínimo: 60000 milissegundos.
ServiceBusConnectionStringProperties	O conjunto de propriedades que compõem uma cadeia de conexão do Service Bus.
ServiceBusMessage	Descreve a mensagem a ser enviada para o Service Bus.
ServiceBusMessageBatch	Um lote de mensagens que você pode criar usando o método <xref:createBatch>.
ServiceBusReceivedMessage	Descreve a mensagem recebida do Service Bus durante as operações de visualização e, portanto, não pode ser liquidada.
ServiceBusReceiver	Um recetor que não lida com sessões.
ServiceBusReceiverOptions	Opções para usar ao criar um recetor.
ServiceBusRuleManager	Permite que as regras de uma assinatura sejam gerenciadas. Este 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 instanciar um remetente. A classe Sender é uma abstração sobre o link de remetente AMQP subjacente.
ServiceBusSenderOptions	Opções a serem usadas ao criar um remetente.
ServiceBusSessionReceiver	Um recetor que lida com 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 com sessões habilitadas.
SqlRuleFilter	Representa todos os campos possíveis em SqlRuleFilter
SubscribeOptions	Opções usadas ao assinar uma fila ou assinatura do Service Bus.
SubscriptionProperties	Representa a entrada para updateSubscription.
SubscriptionRuntimeProperties	Representa atributos de informações de tempo de execução 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 tempo de execução 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 através de Web Sockets.

Aliases de Tipo

EntitiesResponse	Representa o resultado da operação de lista em entidades que também contém o continuationToken a partir do qual começar a iterar.
EntityAvailabilityStatus	Valores possíveis para availabilityStatus das entidades de mensagens do Service Bus.
EntityStatus	Valores possíveis para status das entidades de mensagens do Service Bus.
OperationOptionsBase	NOTA: Este 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 Service Bus.
SqlRuleAction	Representa todos os campos possíveis em SqlRuleAction
TransferProgressEvent	Disparado em resposta ao progresso do upload ou download.
WithResponse	Representa a resposta retornada da operação juntamente com a resposta bruta.

Enumerações

RetryMode	Descreve o tipo de Modo de Repetição
TokenType	Descreve o tipo de tokens suportados.

Funções

delay<T>(number, AbortSignalLike, string, T)	Um wrapper para setTimeout que resolve uma promessa após t milissegundos.
isServiceBusError(unknown)	Determina se um erro é do tipo ServiceBusError
parseServiceBusConnectionString(string)	Analisa determinada cadeia de conexão nas diferentes propriedades aplicáveis ao Barramento de Serviço do Azure. As propriedades são úteis para construir um ServiceBusClient.

Detalhes de Função

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

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

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

Parâmetros

delayInMs

number

O número de milissegundos a atrasar.

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.

Devoluções

Promise<void | T>

• Promessa resolvida

isServiceBusError(unknown)

Determina se um erro é do tipo ServiceBusError

function isServiceBusError(err: unknown): err is ServiceBusError

Parâmetros

err

unknown

Um erro para verificar se é do tipo ServiceBusError

Devoluções

err is ServiceBusError

parseServiceBusConnectionString(string)

Analisa determinada cadeia de conexão 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 Service Bus.

Devoluções

ServiceBusConnectionStringProperties