Share via

ServiceBusMessage interface

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

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

Свойства

applicationProperties

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

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

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

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

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

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

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

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

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

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

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