ServiceBusMessage interface

Pacote:

@azure/service-bus

Descreve a mensagem a enviar para o Service Bus.

Propriedades

applicationProperties	As propriedades específicas da aplicação que podem ser utilizadas para metadados de mensagens personalizadas.
body	O corpo da mensagem que precisa de ser enviado ou recebido. Se a aplicação que recebe a mensagem não estiver a utilizar este SDK, converta o payload do corpo numa matriz de bytes ou na Memória Intermédia para uma melhor compatibilidade entre idiomas.
contentType	O tipo de conteúdo da mensagem. Opcionalmente, descreve o payload da mensagem, com um descritor a seguir ao formato RFC2045, Secção 5, por exemplo "application/json".
correlationId	O identificador de correlação que permite que uma aplicação especifique um contexto para a mensagem para efeitos de correlação, por exemplo, que reflete o MessageId de uma mensagem a que está a ser respondida. Veja Encaminhamento e Correlação de Mensagens.
messageId	O identificador de mensagens é um valor definido pela aplicação que identifica exclusivamente a mensagem e o respetivo payload. Nota: não são permitidos números inteiros inteiros.
partitionKey	A chave de partição para enviar uma mensagem para uma entidade particionada. O comprimento máximo é de 128 carateres. Para entidades particionadas, definir este valor permite atribuir mensagens relacionadas à mesma partição interna, para que a sequência de submissão seja gravada corretamente. A partição é escolhida por uma função hash sobre este valor e não pode ser escolhida diretamente. Para entidades com suporte para sessões, a sessionId propriedade substitui este valor. Para entidades não particionadas, a chave de partição será ignorada
replyTo	O endereço de uma entidade para a qual enviar respostas. Este valor opcional e definido pela aplicação é uma forma padrão de expressar um caminho de resposta para o recetor da mensagem. Quando um remetente espera uma resposta, define o valor para o caminho absoluto ou relativo da fila ou tópico para o qual espera que a resposta seja enviada. Veja Encaminhamento e Correlação de Mensagens.
replyToSessionId	O identificador de sessão aumenta o replyTo endereço. O comprimento máximo é de 128 carateres. Este valor aumenta as informações do ReplyTo e especifica o SessionId que deve ser definido para a resposta quando enviado para a entidade de resposta. Veja Encaminhamento e Correlação de Mensagens.
scheduledEnqueueTimeUtc	A data e hora em UTC em que a mensagem será colocada em fila. Esta propriedade devolve a hora em UTC; ao definir a propriedade, o valor DateTime fornecido também tem de estar em UTC. Este valor destina-se ao envio de mensagens atrasadas. É utilizado para atrasar o envio de mensagens para uma hora específica no futuro. O tempo de colocação de mensagens não significa que a mensagem será enviada ao mesmo tempo. Será colocado em fila de espera, mas o tempo real de envio depende da carga de trabalho da fila e do respetivo estado.
sessionId	O identificador de sessão de uma entidade com suporte para sessões. O comprimento máximo é de 128 carateres. Para entidades com suporte para sessões, este valor definido pela aplicação especifica a afiliação de sessão da mensagem. As mensagens com o mesmo identificador de sessão estão sujeitas ao bloqueio de resumo e ativam o processamento e a desmultiplexing exatos. Para entidades sem conhecimento da sessão, este valor é ignorado. Sessões de Mensagens.
subject	A etiqueta específica da aplicação. Esta propriedade permite que a aplicação indique o objetivo da mensagem ao recetor num padrão. fashion, semelhante a uma linha de assunto de e-mail. A propriedade AMQP mapeada é "assunto".
timeToLive	O valor de tempo de vida da mensagem. Este valor é a duração relativa após a qual a mensagem expira, começando a partir do instante em que a mensagem foi aceite e armazenada pelo mediador, conforme capturado em enqueuedTimeUtc. Quando não estiver definido explicitamente, o valor assumido é DefaultTimeToLive para a respetiva fila ou tópico. Um valor ao nível timeToLive da mensagem não pode ser maior do que a definição DefaultTimeToLive da entidade e é ajustado automaticamente se o fizer. Veja Expiração.
to	O endereço "para". Esta propriedade está reservada para utilização futura em cenários de encaminhamento e atualmente ignorada pelo próprio mediador. As aplicações podem utilizar este valor em cenários de encadeamento automático orientados por regras para indicar o destino lógico pretendido da mensagem.

Detalhes de Propriedade

applicationProperties

As propriedades específicas da aplicação que podem ser utilizadas para metadados de mensagens personalizadas.

applicationProperties?: {[key: string]: number | boolean | string | Date | null}

Valor de Propriedade

{[key: string]: number | boolean | string | Date | null}

body

O corpo da mensagem que precisa de ser enviado ou recebido. Se a aplicação que recebe a mensagem não estiver a utilizar este SDK, converta o payload do corpo numa matriz de bytes ou na Memória Intermédia para uma melhor compatibilidade entre idiomas.

body: any

Valor de Propriedade

any

contentType

O tipo de conteúdo da mensagem. Opcionalmente, descreve o payload da mensagem, com um descritor a seguir ao formato RFC2045, Secção 5, por exemplo "application/json".

contentType?: string

Valor de Propriedade

string

correlationId

O identificador de correlação que permite que uma aplicação especifique um contexto para a mensagem para efeitos de correlação, por exemplo, que reflete o MessageId de uma mensagem a que está a ser respondida. Veja Encaminhamento e Correlação de Mensagens.

correlationId?: string | number | Buffer

Valor de Propriedade

string | number | Buffer

messageId

O identificador de mensagens é um valor definido pela aplicação que identifica exclusivamente a mensagem e o respetivo payload.

Nota: não são permitidos números inteiros inteiros.

messageId?: string | number | Buffer

Valor de Propriedade

string | number | Buffer

partitionKey

A chave de partição para enviar uma mensagem para uma entidade particionada. O comprimento máximo é de 128 carateres. Para entidades particionadas, definir este valor permite atribuir mensagens relacionadas à mesma partição interna, para que a sequência de submissão seja gravada corretamente. A partição é escolhida por uma função hash sobre este valor e não pode ser escolhida diretamente.

• Para entidades com suporte para sessões, a sessionId propriedade substitui este valor.
• Para entidades não particionadas, a chave de partição será ignorada

partitionKey?: string

Valor de Propriedade

string

replyTo

O endereço de uma entidade para a qual enviar respostas. Este valor opcional e definido pela aplicação é uma forma padrão de expressar um caminho de resposta para o recetor da mensagem. Quando um remetente espera uma resposta, define o valor para o caminho absoluto ou relativo da fila ou tópico para o qual espera que a resposta seja enviada. Veja Encaminhamento e Correlação de Mensagens.

replyTo?: string

Valor de Propriedade

string

replyToSessionId

O identificador de sessão aumenta o replyTo endereço. O comprimento máximo é de 128 carateres. Este valor aumenta as informações do ReplyTo e especifica o SessionId que deve ser definido para a resposta quando enviado para a entidade de resposta. Veja Encaminhamento e Correlação de Mensagens.

replyToSessionId?: string

Valor de Propriedade

string

scheduledEnqueueTimeUtc

A data e hora em UTC em que a mensagem será colocada em fila. Esta propriedade devolve a hora em UTC; ao definir a propriedade, o valor DateTime fornecido também tem de estar em UTC. Este valor destina-se ao envio de mensagens atrasadas. É utilizado para atrasar o envio de mensagens para uma hora específica no futuro. O tempo de colocação de mensagens não significa que a mensagem será enviada ao mesmo tempo. Será colocado em fila de espera, mas o tempo real de envio depende da carga de trabalho da fila e do respetivo estado.

scheduledEnqueueTimeUtc?: Date

Valor de Propriedade

Date

sessionId

O identificador de sessão de uma entidade com suporte para sessões. O comprimento máximo é de 128 carateres. Para entidades com suporte para sessões, este valor definido pela aplicação especifica a afiliação de sessão da mensagem. As mensagens com o mesmo identificador de sessão estão sujeitas ao bloqueio de resumo e ativam o processamento e a desmultiplexing exatos. Para entidades sem conhecimento da sessão, este valor é ignorado. Sessões de Mensagens.

sessionId?: string

Valor de Propriedade

string

subject

A etiqueta específica da aplicação. Esta propriedade permite que a aplicação indique o objetivo da mensagem ao recetor num padrão. fashion, semelhante a uma linha de assunto de e-mail. A propriedade AMQP mapeada é "assunto".

subject?: string

Valor de Propriedade

string

timeToLive

O valor de tempo de vida da mensagem. Este valor é a duração relativa após a qual a mensagem expira, começando a partir do instante em que a mensagem foi aceite e armazenada pelo mediador, conforme capturado em enqueuedTimeUtc. Quando não estiver definido explicitamente, o valor assumido é DefaultTimeToLive para a respetiva fila ou tópico. Um valor ao nível timeToLive da mensagem não pode ser maior do que a definição DefaultTimeToLive da entidade e é ajustado automaticamente se o fizer. Veja Expiração.

timeToLive?: number

Valor de Propriedade

number

to

O endereço "para". Esta propriedade está reservada para utilização futura em cenários de encaminhamento e atualmente ignorada pelo próprio mediador. As aplicações podem utilizar este valor em cenários de encadeamento automático orientados por regras para indicar o destino lógico pretendido da mensagem.

to?: string

Valor de Propriedade

string