@azure/service-bus package

Classes

MessagingError	Descreve a classe base do Erro de Mensagens.
ServiceBusAdministrationClient	Todas as operações devolvem promessas que são resolvidas para um objeto que tem o resultado relevante. Estes objetos também têm uma propriedade chamada _response que pode utilizar se quiser aceder à resposta direta do serviço.
ServiceBusClient	Um cliente que pode criar instâncias do Remetente para enviar mensagens para filas e tópicos, bem como instâncias de Recetor para receber mensagens de filas e subscrições.
ServiceBusError	Erros que ocorrem no Service Bus.

Interfaces

AuthorizationRule	Representa o tipo de em operações de AuthorizationRule gestão baseadas em ATOM.
CorrelationRuleFilter	Representa a expressão do filtro de correlação. Um CorrelationRuleFilter contém um conjunto de condições que correspondem às propriedades do utilizador e do sistema das mensagens recebidas de uma Subscrição.
CreateMessageBatchOptions	Opções para configurar o createBatch método no Sender. maxSizeInBytes: o limite superior para o tamanho do lote. Utilização de exemplo: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Representa opções de tabelas definidas numa fila
CreateSubscriptionOptions	Representa opções de tabelas definidas numa subscrição
CreateTopicOptions	Representa opções de tabelas definidas num tópico
DeadLetterOptions	Descreve o motivo e a descrição do erro para escrever uma mensagem sem saída através do deadLetter() método na mensagem recebida do Service Bus.
Delivery
GetMessageIteratorOptions	Opções ao obter um iterador iterável do Service Bus.
HttpHeader	Um cabeçalho individual numa coleção httpHeaders.
HttpHeadersLike	Uma coleção de pares de chave/valor de cabeçalho HTTP.
HttpResponse	As propriedades numa resposta HTTP que estarão sempre presentes.
MessageHandlers	A interface geral do processador de mensagens (utilizada para streamMessages).
NamespaceProperties	Representa os metadados relacionados com um espaço de nomes do service bus.
OperationOptions	O tipo de opções base para todas as operações.
PeekMessagesOptions	Descreve as opções transmitidas ao peekMessages método num recetor.
ProcessErrorArgs	Argumentos para a processError chamada de retorno.
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 Service Bus.
RetryOptions	Repita as opções de política 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 ao criar o ServiceBusClient. webSocketOptions : opções para configurar a canalização da ligação AMQP através de Sockets Web. websocket : o construtor WebSocket utilizado para criar uma ligação AMQP se optar por fazer a ligação através de um WebSocket. webSocketConstructorOptions : opções para passar para o construtor Websocket quando optar por fazer a ligaçã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 erro retráctil. maxRetryDelayInMs: o atraso máximo entre as repetições. Aplicável apenas ao realizar repetições exponenciais. mode: o modo de repetição a aplicar, especificado pela RetryMode enum. As opções são Exponential e Fixed. Predefinições para Fixed. retryDelayInMs: período de tempo para aguardar em milissegundos antes de fazer a próxima tentativa. Quando mode está definido como Exponential, isto é utilizado para calcular os atrasos exponencialmente crescentes entre repetições. Predefinição: 30000 milissegundos. timeoutInMs: período de tempo em milissegundos para aguardar antes de a operação exceder o limite de tempo. Isto irá acionar uma repetição se existirem tentativas de repetição restantes. Valor mínimo: 60000 milissegundos.
ServiceBusConnectionStringProperties	O conjunto de propriedades que compõem uma cadeia de ligação do Service Bus.
ServiceBusMessage	Descreve a mensagem a enviar para o Service Bus.
ServiceBusMessageBatch	Um lote de mensagens que pode criar com o <xref:createBatch> método .
ServiceBusReceivedMessage	Descreve a mensagem recebida do Service Bus durante as operações de pré-visualização, pelo que não pode ser resolvida.
ServiceBusReceiver	Um recetor que não processa sessões.
ServiceBusReceiverOptions	Opções a utilizar ao criar um recetor.
ServiceBusRuleManager	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.
ServiceBusSender	Um Remetente pode ser utilizado para enviar mensagens, agendar mensagens para serem enviadas mais tarde e cancelar essas mensagens agendadas. Utilize a createSender função no ServiceBusClient para instanciar um Remetente. A classe Remetente é uma abstração sobre a ligação do remetente AMQP subjacente.
ServiceBusSenderOptions	Opções a utilizar ao criar um remetente.
ServiceBusSessionReceiver	Um recetor que processa sessões, incluindo a renovação do bloqueio de sessão.
ServiceBusSessionReceiverOptions	Descreve as opções transmitidas aos acceptSession métodos e acceptNextSession ao utilizar uma Fila/Subscrição com sessões ativadas.
SqlRuleFilter	Representa todos os campos possíveis no SqlRuleFilter
SubscribeOptions	Opções utilizadas ao subscrever uma fila ou subscrição do Service Bus.
SubscriptionProperties	Representa a entrada para updateSubscription.
SubscriptionRuntimeProperties	Representa atributos de informações de runtime de uma entidade de subscrição
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 o Span contexto para rastreio distribuído.
WebResourceLike	Uma descrição de um pedido HTTP a ser feito num servidor remoto.
WebSocketImpl	Descreve a forma necessária dos construtores WebSocket.
WebSocketOptions	Opções para configurar a canalização da ligação AMQP através de Sockets Web.

Aliases de Tipo

EntitiesResponse	Representa o resultado da operação de lista em entidades que também contém o continuationToken para começar a iterar.
EntityAvailabilityStatus	Valores possíveis para availabilityStatus as entidades de mensagens do Service Bus.
EntityStatus	Valores possíveis para status as 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 rastreio e 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 no SqlRuleAction
TransferProgressEvent	Acionado em resposta ao progresso do carregamento ou transferência.
WithResponse	Representa a resposta devolvida da operação juntamente com a resposta não processada.

Enumerações

RetryMode	Descreve o tipo 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 a cadeia de ligação fornecida nas diferentes propriedades aplicáveis ao Azure Service Bus. 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<T | void>

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 abortação associada à operação de contenção.

value

T

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

Devoluções

Promise<T | void>

• Promessa resolvida

isServiceBusError(unknown)

Determina se um erro é do tipo ServiceBusError

function isServiceBusError(err: unknown): err

Parâmetros

err

unknown

Erro ao verificar se é do tipo ServiceBusError

Devoluções

err

parseServiceBusConnectionString(string)

Analisa a cadeia de ligação fornecida nas diferentes propriedades aplicáveis ao Azure Service Bus. As propriedades são úteis para construir um ServiceBusClient.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Parâmetros

connectionString

string

A cadeia de ligação associada à Política de Acesso Partilhado criada para o espaço de nomes, fila ou tópico do Service Bus.

Devoluções

ServiceBusConnectionStringProperties