Bagikan melalui

ServiceBusMessage interface

  • Referensi
Paket:
@azure/service-bus

Menjelaskan pesan yang akan dikirim ke Azure Service Bus.

Properti

applicationProperties

Properti khusus aplikasi yang dapat digunakan untuk metadata pesan kustom.
body

Isi pesan yang perlu dikirim atau diterima. Jika aplikasi yang menerima pesan tidak menggunakan SDK ini, konversikan payload isi Anda ke array byte atau Buffer untuk kompatibilitas lintas bahasa yang lebih baik.
contentType

Tipe isi pesan. Secara opsional menjelaskan payload pesan, dengan deskriptor mengikuti format RFC2045, Bagian 5, misalnya "application/json".
correlationId

Pengidentifikasi korelasi yang memungkinkan aplikasi menentukan konteks untuk pesan untuk tujuan korelasi, misalnya mencerminkan MessageId dari pesan yang sedang dijawab. Lihat Perutean dan Korelasi Pesan.
messageId

Pengidentifikasi pesan adalah nilai yang ditentukan aplikasi yang secara unik mengidentifikasi pesan dan muatannya.

Catatan: Angka yang bukan bilangan bulat utuh tidak diperbolehkan.
partitionKey

Kunci partisi untuk mengirim pesan ke entitas yang dipartisi. Panjang maksimum adalah 128 karakter. Untuk entitas yang dipartisi, pengaturan nilai ini memungkinkan penetapan pesan terkait ke partisi internal yang sama, sehingga urutan pengiriman dicatat dengan benar. Partisi dipilih oleh fungsi hash atas nilai ini dan tidak dapat dipilih secara langsung.

  • Untuk entitas yang sadar sesi, sessionId properti akan mengambil alih nilai ini.
  • Untuk entitas yang tidak dipartisi, kunci partisi akan diabaikan
replyTo

Alamat entitas yang akan dikirimi balasan. Nilai opsional dan yang ditentukan aplikasi ini adalah cara standar untuk mengekspresikan jalur balasan ke penerima pesan. Ketika pengirim mengharapkan balasan, ini menetapkan nilai ke jalur absolut atau relatif dari antrean atau topik yang diharapkan balasan akan dikirim. Lihat Perutean dan Korelasi Pesan.
replyToSessionId

Pengidentifikasi sesi menambah replyTo alamat. Panjang maksimum adalah 128 karakter. Nilai ini menambah informasi ReplyTo dan menentukan SessionId mana yang harus ditetapkan untuk balasan saat dikirim ke entitas balasan. Lihat Perutean dan Korelasi Pesan.
scheduledEnqueueTimeUtc

Tanggal dan waktu dalam UTC di mana pesan akan diantrekan. Properti ini mengembalikan waktu dalam UTC; saat mengatur properti, nilai DateTime yang disediakan juga harus dalam UTC. Nilai ini untuk pengiriman pesan yang tertunda. Ini digunakan untuk menunda pengiriman pesan ke waktu tertentu di masa mendatang. Waktu antrean pesan tidak berarti bahwa pesan akan dikirim secara bersamaan. Ini akan diantrekan, tetapi waktu pengiriman aktual tergantung pada beban kerja antrean dan statusnya.
sessionId

Pengidentifikasi sesi untuk entitas yang sadar sesi. Panjang maksimum adalah 128 karakter. Untuk entitas yang mengetahui sesi, nilai yang ditentukan aplikasi ini menentukan afiliasi sesi pesan. Pesan dengan pengidentifikasi sesi yang sama tunduk pada penguncian ringkasan dan mengaktifkan pemrosesan dan demultiplexing dalam urutan yang tepat. Untuk entitas yang tidak sadar sesi, nilai ini diabaikan. Sesi Pesan.
subject

Label khusus aplikasi. Properti ini memungkinkan aplikasi untuk menunjukkan tujuan pesan kepada penerima dalam standar. mode, mirip dengan baris subjek email. Properti AMQP yang dipetakan adalah "subjek".
timeToLive

Waktu pesan untuk nilai hidup. Nilai ini adalah durasi relatif setelah pesan kedaluwarsa, mulai dari instan pesan telah diterima dan disimpan oleh broker, seperti yang diambil dalam enqueuedTimeUtc. Ketika tidak diatur secara eksplisit, nilai yang diasumsikan adalah DefaultTimeToLive untuk masing-masing antrean atau topik. Nilai tingkat timeToLive pesan tidak boleh lebih panjang dari pengaturan DefaultTimeToLive entitas dan diam-diam disesuaikan jika sesuai. Lihat Kedaluwarsa.
to

Alamat "ke". Properti ini dicadangkan untuk digunakan di masa mendatang dalam skenario perutean dan saat ini diabaikan oleh broker itu sendiri. Aplikasi dapat menggunakan nilai ini dalam skenario rantai penerusan otomatis berbasis aturan untuk menunjukkan tujuan logis pesan yang dimaksudkan.

Detail Properti

applicationProperties

Properti khusus aplikasi yang dapat digunakan untuk metadata pesan kustom.

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

Nilai Properti

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

body

Isi pesan yang perlu dikirim atau diterima. Jika aplikasi yang menerima pesan tidak menggunakan SDK ini, konversikan payload isi Anda ke array byte atau Buffer untuk kompatibilitas lintas bahasa yang lebih baik.

body: any

Nilai Properti

any

contentType

Tipe isi pesan. Secara opsional menjelaskan payload pesan, dengan deskriptor mengikuti format RFC2045, Bagian 5, misalnya "application/json".

contentType?: string

Nilai Properti

string

correlationId

Pengidentifikasi korelasi yang memungkinkan aplikasi menentukan konteks untuk pesan untuk tujuan korelasi, misalnya mencerminkan MessageId dari pesan yang sedang dijawab. Lihat Perutean dan Korelasi Pesan.

correlationId?: string | number | Buffer

Nilai Properti

string | number | Buffer

messageId

Pengidentifikasi pesan adalah nilai yang ditentukan aplikasi yang secara unik mengidentifikasi pesan dan muatannya.

Catatan: Angka yang bukan bilangan bulat utuh tidak diperbolehkan.

messageId?: string | number | Buffer

Nilai Properti

string | number | Buffer

partitionKey

Kunci partisi untuk mengirim pesan ke entitas yang dipartisi. Panjang maksimum adalah 128 karakter. Untuk entitas yang dipartisi, pengaturan nilai ini memungkinkan penetapan pesan terkait ke partisi internal yang sama, sehingga urutan pengiriman dicatat dengan benar. Partisi dipilih oleh fungsi hash atas nilai ini dan tidak dapat dipilih secara langsung.

  • Untuk entitas yang sadar sesi, sessionId properti akan mengambil alih nilai ini.
  • Untuk entitas yang tidak dipartisi, kunci partisi akan diabaikan
partitionKey?: string

Nilai Properti

string

replyTo

Alamat entitas yang akan dikirimi balasan. Nilai opsional dan yang ditentukan aplikasi ini adalah cara standar untuk mengekspresikan jalur balasan ke penerima pesan. Ketika pengirim mengharapkan balasan, ini menetapkan nilai ke jalur absolut atau relatif dari antrean atau topik yang diharapkan balasan akan dikirim. Lihat Perutean dan Korelasi Pesan.

replyTo?: string

Nilai Properti

string

replyToSessionId

Pengidentifikasi sesi menambah replyTo alamat. Panjang maksimum adalah 128 karakter. Nilai ini menambah informasi ReplyTo dan menentukan SessionId mana yang harus ditetapkan untuk balasan saat dikirim ke entitas balasan. Lihat Perutean dan Korelasi Pesan.

replyToSessionId?: string

Nilai Properti

string

scheduledEnqueueTimeUtc

Tanggal dan waktu dalam UTC di mana pesan akan diantrekan. Properti ini mengembalikan waktu dalam UTC; saat mengatur properti, nilai DateTime yang disediakan juga harus dalam UTC. Nilai ini untuk pengiriman pesan yang tertunda. Ini digunakan untuk menunda pengiriman pesan ke waktu tertentu di masa mendatang. Waktu antrean pesan tidak berarti bahwa pesan akan dikirim secara bersamaan. Ini akan diantrekan, tetapi waktu pengiriman aktual tergantung pada beban kerja antrean dan statusnya.

scheduledEnqueueTimeUtc?: Date

Nilai Properti

Date

sessionId

Pengidentifikasi sesi untuk entitas yang sadar sesi. Panjang maksimum adalah 128 karakter. Untuk entitas yang mengetahui sesi, nilai yang ditentukan aplikasi ini menentukan afiliasi sesi pesan. Pesan dengan pengidentifikasi sesi yang sama tunduk pada penguncian ringkasan dan mengaktifkan pemrosesan dan demultiplexing dalam urutan yang tepat. Untuk entitas yang tidak sadar sesi, nilai ini diabaikan. Sesi Pesan.

sessionId?: string

Nilai Properti

string

subject

Label khusus aplikasi. Properti ini memungkinkan aplikasi untuk menunjukkan tujuan pesan kepada penerima dalam standar. mode, mirip dengan baris subjek email. Properti AMQP yang dipetakan adalah "subjek".

subject?: string

Nilai Properti

string

timeToLive

Waktu pesan untuk nilai hidup. Nilai ini adalah durasi relatif setelah pesan kedaluwarsa, mulai dari instan pesan telah diterima dan disimpan oleh broker, seperti yang diambil dalam enqueuedTimeUtc. Ketika tidak diatur secara eksplisit, nilai yang diasumsikan adalah DefaultTimeToLive untuk masing-masing antrean atau topik. Nilai tingkat timeToLive pesan tidak boleh lebih panjang dari pengaturan DefaultTimeToLive entitas dan diam-diam disesuaikan jika sesuai. Lihat Kedaluwarsa.

timeToLive?: number

Nilai Properti

number

to

Alamat "ke". Properti ini dicadangkan untuk digunakan di masa mendatang dalam skenario perutean dan saat ini diabaikan oleh broker itu sendiri. Aplikasi dapat menggunakan nilai ini dalam skenario rantai penerusan otomatis berbasis aturan untuk menunjukkan tujuan logis pesan yang dimaksudkan.

to?: string

Nilai Properti

string