ServiceBusMessage interface

Pacote:

@azure/service-bus

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

Propriedades

applicationProperties	As propriedades específicas do aplicativo que podem ser usadas para metadados de mensagem personalizados.
body	O corpo da mensagem que precisa ser enviado ou recebido. Se o aplicativo que recebe a mensagem não estiver usando esse SDK, converta o conteúdo do corpo em uma matriz de bytes ou buffer para uma melhor compatibilidade entre idiomas.
contentType	O tipo de conteúdo da mensagem. Opcionalmente, descreve o conteúdo da mensagem, com um descritor seguindo o formato 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 a MessageId de uma mensagem que está sendo respondido. Consulte Roteamento de Mensagens e Correlação.
messageId	O identificador da mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e seu payload. Observação: 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, definir esse valor permite a atribuição de mensagens relacionadas à mesma partição interna para que a ordem de sequência de envio esteja registrada corretamente. A partição é escolhida por uma função de hash sobre esse valor e não pode ser escolhida diretamente. Para entidades com reconhecimento de sessão, a sessionId propriedade 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 receptor da mensagem. Quando um remetente espera uma resposta, ele define o valor como o caminho absoluto ou relativo da fila ou do tópico para o qual ele espera que a resposta seja enviada. Consulte Roteamento de Mensagens e Correlação.
replyToSessionId	O identificador de sessão que aumenta o replyTo endereço. O comprimento máximo é de 128 caracteres. Esse valor aumenta a informação ReplyTo e especifica qual SessionId deve ser definido para a resposta quando enviada para a entidade de resposta. Consulte Roteamento de Mensagens e Correlação.
scheduledEnqueueTimeUtc	A data e a hora em UTC em que a mensagem será enfileirada. Essa 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. Ele é utilizado para atrasar o envio de mensagens para um momento específico no futuro. O tempo de enfileiramento de mensagem não significa que a mensagem será enviada ao mesmo tempo. Ele será enfileirado, mas o tempo real de envio depende da carga de trabalho da fila e do estado dela.
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 ao bloqueio de resumo e permitem a demultiplexação e o processamento na ordem exata. Para entidades sem reconhecimento de sessão, esse valor é ignorado. Sessões de mensagem.
subject	Rótulo específico do aplicativo. Essa propriedade permite que o aplicativo indique a finalidade da mensagem para o receptor em um padronizado. moda, semelhante a uma linha de assunto de email. A propriedade AMQP mapeada é "subject".
timeToLive	O valor da vida útil da mensagem. Esse valor é a duração relativa após a qual a mensagem expira, começando a partir do instante em que a mensagem foi aceita e armazenada pelo agente, conforme capturado em enqueuedTimeUtc. Quando não definido explicitamente, o valor assumido será o DefaultTimeToLive para a respectiva fila ou tópico. Um valor no nível timeToLive da mensagem não pode ser maior do que a configuração DefaultTimeToLive da entidade e é silenciosamente ajustado se o fizer. 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 agente. Os aplicativos podem usar esse valor em cenários de encadeamento de encaminhamento automático controlados por regras para indicar o destino lógico pretendido da mensagem.

Detalhes da propriedade

applicationProperties

As propriedades específicas do aplicativo que podem ser usadas para metadados de mensagem personalizados.

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

Valor da propriedade

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

body

O corpo da mensagem que precisa ser enviado ou recebido. Se o aplicativo que recebe a mensagem não estiver usando esse SDK, converta o conteúdo do corpo em uma matriz de bytes ou buffer para uma melhor compatibilidade entre idiomas.

body: any

Valor da propriedade

any

contentType

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

contentType?: string

Valor da 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 a MessageId de uma mensagem que está sendo respondido. Consulte Roteamento de Mensagens e Correlação.

correlationId?: string | number | Buffer

Valor da propriedade

string | number | Buffer

messageId

O identificador da mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e seu payload.

Observação: números que não são inteiros não são permitidos.

messageId?: string | number | Buffer

Valor da 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, definir esse valor permite a atribuição de mensagens relacionadas à mesma partição interna para que a ordem de sequência de envio esteja registrada corretamente. A partição é escolhida por uma função de hash sobre esse valor e não pode ser escolhida diretamente.

• Para entidades com reconhecimento de sessão, a sessionId propriedade substitui esse valor.
• Para entidades não particionadas, a chave de partição será ignorada

partitionKey?: string

Valor da 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 receptor da mensagem. Quando um remetente espera uma resposta, ele define o valor como o caminho absoluto ou relativo da fila ou do tópico para o qual ele espera que a resposta seja enviada. Consulte Roteamento de Mensagens e Correlação.

replyTo?: string

Valor da propriedade

string

replyToSessionId

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

replyToSessionId?: string

Valor da propriedade

string

scheduledEnqueueTimeUtc

A data e a hora em UTC em que a mensagem será enfileirada. Essa 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. Ele é utilizado para atrasar o envio de mensagens para um momento específico no futuro. O tempo de enfileiramento de mensagem não significa que a mensagem será enviada ao mesmo tempo. Ele será enfileirado, mas o tempo real de envio depende da carga de trabalho da fila e do estado dela.

scheduledEnqueueTimeUtc?: Date

Valor da 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 ao bloqueio de resumo e permitem a demultiplexação e o processamento na ordem exata. Para entidades sem reconhecimento de sessão, esse valor é ignorado. Sessões de mensagem.

sessionId?: string

Valor da propriedade

string

subject

Rótulo específico do aplicativo. Essa propriedade permite que o aplicativo indique a finalidade da mensagem para o receptor em um padronizado. moda, semelhante a uma linha de assunto de email. A propriedade AMQP mapeada é "subject".

subject?: string

Valor da propriedade

string

timeToLive

O valor da vida útil da mensagem. Esse valor é a duração relativa após a qual a mensagem expira, começando a partir do instante em que a mensagem foi aceita e armazenada pelo agente, conforme capturado em enqueuedTimeUtc. Quando não definido explicitamente, o valor assumido será o DefaultTimeToLive para a respectiva fila ou tópico. Um valor no nível timeToLive da mensagem não pode ser maior do que a configuração DefaultTimeToLive da entidade e é silenciosamente ajustado se o fizer. Consulte Expiração.

timeToLive?: number

Valor da propriedade

number

to

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

to?: string

Valor da propriedade

string