ServiceBusMessage interface

Pacote:

@azure/service-bus

Descreve a mensagem a ser enviada para o Service Bus.

Propriedades

applicationProperties	As propriedades específicas do aplicativo que podem ser usadas para metadados de mensagens personalizadas.
body	O corpo da mensagem que precisa ser enviada ou recebida. Se o aplicativo que está recebendo a mensagem não estiver usando esse SDK, converta sua carga útil corporal em uma matriz de bytes ou Buffer para melhor compatibilidade entre idiomas.
contentType	O tipo de conteúdo da mensagem. Opcionalmente, descreve a carga útil da mensagem, com um descritor seguindo o formato de RFC2045, Seção 5, por exemplo, "application/json".
correlationId	O identificador de correlação que permite que um aplicativo especifique um contexto para a mensagem para fins de correlação, por exemplo, refletindo o MessageId de uma mensagem que está sendo respondida. Consulte de roteamento e correlação de mensagens .
messageId	O identificador de mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e sua carga útil. Nota: Números que não são inteiros não são permitidos.
partitionKey	A chave de partição para enviar uma mensagem para uma entidade particionada. O comprimento máximo é de 128 caracteres. Para entidades particionadas, a definição desse valor permite atribuir mensagens relacionadas à mesma partição interna, para que a ordem da sequência de envio seja registrada corretamente. A partição é escolhida por uma função hash sobre esse valor e não pode ser escolhida diretamente. Para entidades com reconhecimento de sessão, a propriedade sessionId substitui esse 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. Esse valor opcional e definido pelo aplicativo é uma maneira padrão de expressar um caminho de resposta para o recetor da mensagem. Quando um remetente espera uma resposta, ele define o valor para o caminho absoluto ou relativo da fila ou tópico para o qual espera que a resposta seja enviada. Consulte de roteamento e correlação de mensagens .
replyToSessionId	O identificador de sessão que aumenta o endereço replyTo. O comprimento máximo é de 128 caracteres. Esse valor aumenta as informações de ReplyTo e especifica qual SessionId deve ser definido para a resposta quando enviada para a entidade de resposta. Consulte de roteamento e correlação de mensagens .
scheduledEnqueueTimeUtc	A data e hora em UTC em que a mensagem será enfileirada. Esta propriedade retorna a hora em UTC; ao definir a propriedade, o valor DateTime fornecido também deve estar em UTC. Esse valor é para envio de mensagens atrasadas. É utilizado para atrasar o envio de mensagens para um momento específico no futuro. O tempo de enfileiramento da mensagem não significa que a mensagem será enviada ao mesmo tempo. Ele ficará enfileirado, mas o tempo real de envio depende da carga de trabalho da fila e de seu estado.
sessionId	O identificador de sessão para uma entidade com reconhecimento de sessão. O comprimento máximo é de 128 caracteres. Para entidades com reconhecimento de sessão, esse valor definido pelo aplicativo especifica a afiliação de sessão da mensagem. As mensagens com o mesmo identificador de sessão estão sujeitas a bloqueio de resumo e permitem o processamento exato em ordem e a desmultiplexação. Para entidades sem reconhecimento de sessão, esse valor é ignorado. Sessões de Mensagens.
subject	O rótulo específico da aplicação. Esta propriedade permite que o aplicativo indique a finalidade da mensagem para o recetor de forma padronizada. moda, semelhante a uma linha de assunto de e-mail. A propriedade AMQP mapeada é "subject".
timeToLive	A mensagem é tempo de viver valor. Esse valor é a duração relativa após a qual a mensagem expira, a partir do instante em que a mensagem foi aceita e armazenada pelo broker, conforme capturado em enqueuedTimeUtc. Quando não definido explicitamente, o valor assumido é o DefaultTimeToLive para a respetiva fila ou tópico. Um valor de timeToLive no nível da mensagem não pode ser maior do que a configuração DefaultTimeToLive da entidade e é ajustado silenciosamente se isso acontecer. Consulte Expiração.
to	O endereço "para". Essa propriedade é reservada para uso futuro em cenários de roteamento e atualmente ignorada pelo próprio broker. Os aplicativos podem usar esse valor em cenários de encadeamento de de encaminhamento automático de controlados por regras para indicar o destino lógico pretendido da mensagem.

Detalhes de Propriedade

applicationProperties

As propriedades específicas do aplicativo que podem ser usadas 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 ser enviada ou recebida. Se o aplicativo que está recebendo a mensagem não estiver usando esse SDK, converta sua carga útil corporal em uma matriz de bytes ou Buffer para melhor compatibilidade entre idiomas.

body: any

Valor de Propriedade

any

contentType

O tipo de conteúdo da mensagem. Opcionalmente, descreve a carga útil da mensagem, com um descritor seguindo o formato de RFC2045, Seção 5, por exemplo, "application/json".

contentType?: string

Valor de Propriedade

string

correlationId

O identificador de correlação que permite que um aplicativo especifique um contexto para a mensagem para fins de correlação, por exemplo, refletindo o MessageId de uma mensagem que está sendo respondida. Consulte de roteamento e correlação de mensagens .

correlationId?: string | number | Buffer

Valor de Propriedade

string | number | Buffer

messageId

O identificador de mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e sua carga útil.

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

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 caracteres. Para entidades particionadas, a definição desse valor permite atribuir mensagens relacionadas à mesma partição interna, para que a ordem da sequência de envio seja registrada corretamente. A partição é escolhida por uma função hash sobre esse valor e não pode ser escolhida diretamente.

• Para entidades com reconhecimento de sessão, a propriedade sessionId substitui esse 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. Esse valor opcional e definido pelo aplicativo é uma maneira padrão de expressar um caminho de resposta para o recetor da mensagem. Quando um remetente espera uma resposta, ele define o valor para o caminho absoluto ou relativo da fila ou tópico para o qual espera que a resposta seja enviada. Consulte de roteamento e correlação de mensagens .

replyTo?: string

Valor de Propriedade

string

replyToSessionId

O identificador de sessão que aumenta o endereço replyTo. O comprimento máximo é de 128 caracteres. Esse valor aumenta as informações de ReplyTo e especifica qual SessionId deve ser definido para a resposta quando enviada para a entidade de resposta. Consulte de roteamento e correlação de mensagens .

replyToSessionId?: string

Valor de Propriedade

string

scheduledEnqueueTimeUtc

A data e hora em UTC em que a mensagem será enfileirada. Esta propriedade retorna a hora em UTC; ao definir a propriedade, o valor DateTime fornecido também deve estar em UTC. Esse valor é para envio de mensagens atrasadas. É utilizado para atrasar o envio de mensagens para um momento específico no futuro. O tempo de enfileiramento da mensagem não significa que a mensagem será enviada ao mesmo tempo. Ele ficará enfileirado, mas o tempo real de envio depende da carga de trabalho da fila e de seu estado.

scheduledEnqueueTimeUtc?: Date

Valor de Propriedade

Date

sessionId

O identificador de sessão para uma entidade com reconhecimento de sessão. O comprimento máximo é de 128 caracteres. Para entidades com reconhecimento de sessão, esse valor definido pelo aplicativo especifica a afiliação de sessão da mensagem. As mensagens com o mesmo identificador de sessão estão sujeitas a bloqueio de resumo e permitem o processamento exato em ordem e a desmultiplexação. Para entidades sem reconhecimento de sessão, esse valor é ignorado. Sessões de Mensagens.

sessionId?: string

Valor de Propriedade

string

subject

O rótulo específico da aplicação. Esta propriedade permite que o aplicativo indique a finalidade da mensagem para o recetor de forma padronizada. moda, semelhante a uma linha de assunto de e-mail. A propriedade AMQP mapeada é "subject".

subject?: string

Valor de Propriedade

string

timeToLive

A mensagem é tempo de viver valor. Esse valor é a duração relativa após a qual a mensagem expira, a partir do instante em que a mensagem foi aceita e armazenada pelo broker, conforme capturado em enqueuedTimeUtc. Quando não definido explicitamente, o valor assumido é o DefaultTimeToLive para a respetiva fila ou tópico. Um valor de timeToLive no nível da mensagem não pode ser maior do que a configuração DefaultTimeToLive da entidade e é ajustado silenciosamente se isso acontecer. Consulte Expiração.

timeToLive?: number

Valor de Propriedade

number

to

O endereço "para". Essa propriedade é reservada para uso futuro em cenários de roteamento e atualmente ignorada pelo próprio broker. Os aplicativos podem usar esse valor em cenários de encadeamento de de encaminhamento automático de controlados por regras para indicar o destino lógico pretendido da mensagem.

to?: string

Valor de Propriedade

string