Поделиться через

ServiceBusMessage interface

  • Ссылка
Пакет:
@azure/service-bus

Описывает сообщение, которое будет отправлено в служебную шину.

Свойства

applicationProperties

Определенные свойства приложения, которые можно использовать для пользовательских метаданных сообщения.
body

Текст сообщения, который должен быть отправлен или получен. Если приложение, получающее сообщение, не использует этот пакет SDK, преобразуйте полезные данные тела в массив байтов или буфер для повышения совместимости между языками.
contentType

Тип контента сообщения. При необходимости описывает полезные данные сообщения с дескриптором после формата RFC2045, раздела 5, например application/json.
correlationId

Идентификатор корреляции, позволяющий приложению указать контекст для сообщения в целях корреляции, например отражающий MessageId сообщения, на которое отвечает сообщение. См. маршрутизации сообщений и корреляции.
messageId

Идентификатор сообщения — это определяемое приложением значение, которое однозначно идентифицирует сообщение и его полезные данные.

Примечание. Числа, которые не являются целыми целыми целыми числами, не допускаются.
partitionKey

Ключ секции для отправки сообщения в секционированную сущность. Максимальная длина — 128 символов. Для секционированных сущностей, установка этого значения позволяет назначать связанные сообщения той же внутренней секции, чтобы порядок последовательности отправки был правильно записан. Секция выбирается хэш-функцией по этому значению и не может быть выбрана напрямую.

  • Для сущностей с поддержкой сеансов свойство sessionId переопределяет это значение.
  • Для несекционированных сущностей ключ секции будет игнорироваться
replyTo

Адрес сущности для отправки ответов. Это необязательное и определяемое приложением значение — это стандартный способ выразить путь ответа получателю сообщения. Когда отправитель ожидает ответа, он задает значение абсолютного или относительного пути очереди или раздела, в который он ожидает отправки ответа. См. маршрутизации сообщений и корреляции.
replyToSessionId

Идентификатор сеанса, расширяющий адрес replyTo. Максимальная длина — 128 символов. Это значение расширяет сведения ReplyTo и указывает, какой идентификатор сеанса должен быть задан для ответа при отправке сущности ответа. См. маршрутизации сообщений и корреляции.
scheduledEnqueueTimeUtc

Дата и время в формате UTC, в котором будет вложено сообщение. Это свойство возвращает время в формате UTC; При задании свойства указанное значение DateTime также должно находиться в формате UTC. Это значение предназначено для отложенной отправки сообщения. Он используется для задержки отправки сообщений в определенное время в будущем. Время выполнения сообщения не означает, что сообщение будет отправлено одновременно. Он будет помещен в очередь, но фактическое время отправки зависит от рабочей нагрузки очереди и его состояния.
sessionId

Идентификатор сеанса для сущности, поддерживающей сеанс. Максимальная длина — 128 символов. Для сущностей, соответствующих сеансам, это определяемое приложением значение указывает принадлежность сеанса сообщения. Сообщения с тем же идентификатором сеанса подвергаются сводной блокировке и обеспечивают точную обработку в порядке и демультлексирование. Для сущностей, не соответствующих сеансам, это значение игнорируется. сеансах сообщений.
subject

Метка конкретного приложения. Это свойство позволяет приложению указывать назначение сообщения получателю в стандартизованном режиме. мода, аналогичная строке темы электронной почты. Сопоставленное свойство AMQP — "subject".
timeToLive

Время жизни сообщения. Это значение является относительной длительностью, после которой истекает срок действия сообщения, начиная с момента принятия сообщения и хранения брокером, как записано в enqueuedTimeUtc. Если значение не задано явным образом, предполагается, что значение DefaultTimeToLive для соответствующей очереди или раздела. Значение уровня сообщения timeToLive не может быть больше, чем параметр DefaultTimeToLive сущности, и он автоматически корректируется, если это делает. См. срок действия.
to

Адрес "to". Это свойство зарезервировано для дальнейшего использования в сценариях маршрутизации и в настоящее время игнорируется самим брокером. Приложения могут использовать это значение в сценариях, управляемых правилом, автоматической цепочке сценариях, чтобы указать предполагаемое логическое назначение сообщения.

Сведения о свойстве

applicationProperties

Определенные свойства приложения, которые можно использовать для пользовательских метаданных сообщения.

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

Значение свойства

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

body

Текст сообщения, который должен быть отправлен или получен. Если приложение, получающее сообщение, не использует этот пакет SDK, преобразуйте полезные данные тела в массив байтов или буфер для повышения совместимости между языками.

body: any

Значение свойства

any

contentType

Тип контента сообщения. При необходимости описывает полезные данные сообщения с дескриптором после формата RFC2045, раздела 5, например application/json.

contentType?: string

Значение свойства

string

correlationId

Идентификатор корреляции, позволяющий приложению указать контекст для сообщения в целях корреляции, например отражающий MessageId сообщения, на которое отвечает сообщение. См. маршрутизации сообщений и корреляции.

correlationId?: string | number | Buffer

Значение свойства

string | number | Buffer

messageId

Идентификатор сообщения — это определяемое приложением значение, которое однозначно идентифицирует сообщение и его полезные данные.

Примечание. Числа, которые не являются целыми целыми целыми числами, не допускаются.

messageId?: string | number | Buffer

Значение свойства

string | number | Buffer

partitionKey

Ключ секции для отправки сообщения в секционированную сущность. Максимальная длина — 128 символов. Для секционированных сущностей, установка этого значения позволяет назначать связанные сообщения той же внутренней секции, чтобы порядок последовательности отправки был правильно записан. Секция выбирается хэш-функцией по этому значению и не может быть выбрана напрямую.

  • Для сущностей с поддержкой сеансов свойство sessionId переопределяет это значение.
  • Для несекционированных сущностей ключ секции будет игнорироваться
partitionKey?: string

Значение свойства

string

replyTo

Адрес сущности для отправки ответов. Это необязательное и определяемое приложением значение — это стандартный способ выразить путь ответа получателю сообщения. Когда отправитель ожидает ответа, он задает значение абсолютного или относительного пути очереди или раздела, в который он ожидает отправки ответа. См. маршрутизации сообщений и корреляции.

replyTo?: string

Значение свойства

string

replyToSessionId

Идентификатор сеанса, расширяющий адрес replyTo. Максимальная длина — 128 символов. Это значение расширяет сведения ReplyTo и указывает, какой идентификатор сеанса должен быть задан для ответа при отправке сущности ответа. См. маршрутизации сообщений и корреляции.

replyToSessionId?: string

Значение свойства

string

scheduledEnqueueTimeUtc

Дата и время в формате UTC, в котором будет вложено сообщение. Это свойство возвращает время в формате UTC; При задании свойства указанное значение DateTime также должно находиться в формате UTC. Это значение предназначено для отложенной отправки сообщения. Он используется для задержки отправки сообщений в определенное время в будущем. Время выполнения сообщения не означает, что сообщение будет отправлено одновременно. Он будет помещен в очередь, но фактическое время отправки зависит от рабочей нагрузки очереди и его состояния.

scheduledEnqueueTimeUtc?: Date

Значение свойства

Date

sessionId

Идентификатор сеанса для сущности, поддерживающей сеанс. Максимальная длина — 128 символов. Для сущностей, соответствующих сеансам, это определяемое приложением значение указывает принадлежность сеанса сообщения. Сообщения с тем же идентификатором сеанса подвергаются сводной блокировке и обеспечивают точную обработку в порядке и демультлексирование. Для сущностей, не соответствующих сеансам, это значение игнорируется. сеансах сообщений.

sessionId?: string

Значение свойства

string

subject

Метка конкретного приложения. Это свойство позволяет приложению указывать назначение сообщения получателю в стандартизованном режиме. мода, аналогичная строке темы электронной почты. Сопоставленное свойство AMQP — "subject".

subject?: string

Значение свойства

string

timeToLive

Время жизни сообщения. Это значение является относительной длительностью, после которой истекает срок действия сообщения, начиная с момента принятия сообщения и хранения брокером, как записано в enqueuedTimeUtc. Если значение не задано явным образом, предполагается, что значение DefaultTimeToLive для соответствующей очереди или раздела. Значение уровня сообщения timeToLive не может быть больше, чем параметр DefaultTimeToLive сущности, и он автоматически корректируется, если это делает. См. срок действия.

timeToLive?: number

Значение свойства

number

to

Адрес "to". Это свойство зарезервировано для дальнейшего использования в сценариях маршрутизации и в настоящее время игнорируется самим брокером. Приложения могут использовать это значение в сценариях, управляемых правилом, автоматической цепочке сценариях, чтобы указать предполагаемое логическое назначение сообщения.

to?: string

Значение свойства

string