ServiceBusMessage interface

Paket:

@azure/service-bus

Service Bus'a gönderilecek iletiyi açıklar.

Özellikler

applicationProperties	Özel ileti meta verileri için kullanılabilecek uygulamaya özgü özellikler.
body	Gönderilmesi gereken veya alınması gereken ileti gövdesi. İletiyi alan uygulama bu SDK'yı kullanmıyorsa, daha iyi diller arası uyumluluk için gövde yükünüzü bir bayt dizisine veya Arabellek'e dönüştürün.
contentType	İletinin içerik türü. İsteğe bağlı olarak, "application/json" gibi RFC2045, Bölüm 5 biçimini izleyen bir tanımlayıcı ile iletinin yükünü açıklar.
correlationId	Bir uygulamanın bağıntı amacıyla ileti için bir bağlam belirtmesine olanak tanıyan bağıntı tanımlayıcısı, örneğin yanıtlanan iletinin MessageId değerini yansıtır. bkz. İleti Yönlendirme ve Bağıntı .
messageId	İleti tanımlayıcısı, iletiyi ve yükünü benzersiz olarak tanımlayan uygulama tanımlı bir değerdir. Not: Tamsayı olmayan sayılara izin verilmez.
partitionKey	Bölümlenmiş varlığa ileti göndermek için bölüm anahtarı. Uzunluk üst sınırı 128 karakterdir. bölümlenmişvarlıklar için, bu değerin ayarlanması ilgili iletilerin aynı iç bölüme atanarak gönderim sırası sırasının doğru şekilde kaydedilmesini sağlar. Bölüm bu değer üzerinde bir karma işlevi tarafından seçilir ve doğrudan seçilemez. Oturum kullanan varlıklar için sessionId özelliği bu değeri geçersiz kılar. Bölümlenmemiş varlıklar için bölüm anahtarı yoksayılır
replyTo	Yanıtların gönderleneceği varlığın adresi. Bu isteğe bağlı ve uygulama tanımlı değer, iletinin alıcısına bir yanıt yolu ifade etmenin standart bir yoludur. Bir gönderen yanıt beklediğinde değeri, yanıtın gönderilmesini beklediği kuyruğun veya konunun mutlak veya göreli yoluna ayarlar. bkz. İleti Yönlendirme ve Bağıntı .
replyToSessionId	replyTo adresini genişleten oturum tanımlayıcısı. Uzunluk üst sınırı 128 karakterdir. Bu değer ReplyTo bilgilerini genişletir ve yanıt varlığına gönderildiğinde yanıt için hangi SessionId değerinin ayarlanması gerektiğini belirtir. bkz. İleti Yönlendirme ve Bağıntı .
scheduledEnqueueTimeUtc	İletinin sıralanacağı UTC'deki tarih ve saat. Bu özellik UTC olarak saati döndürür; özelliği ayarlanırken, sağlanan DateTime değerinin de UTC olarak olması gerekir. Bu değer gecikmeli ileti gönderme içindir. Gelecekte belirli bir zamana gönderilen iletileri geciktirmek için kullanılır. İletinin sıralanma süresi, iletinin aynı anda gönderileceği anlamına gelmez. Sorgulanır, ancak gerçek gönderme süresi kuyruğun iş yüküne ve durumuna bağlıdır.
sessionId	Oturum kullanan bir varlığın oturum tanımlayıcısı. Uzunluk üst sınırı 128 karakterdir. Oturum kullanan varlıklar için, bu uygulama tanımlı değer iletinin oturum ilişkilendirmesini belirtir. Aynı oturum tanımlayıcısına sahip iletiler özet kilitlemeye tabidir ve tam olarak sıralı işlemeyi ve çift yönlü işlemi etkinleştirir. Oturum bilgisi olmayan varlıklar için bu değer yoksayılır. İleti Oturumlarını.
subject	Uygulamaya özgü etiket. Bu özellik, uygulamanın iletinin amacını alıcıya standartlaştırılmış olarak belirtmesini sağlar. moda, e-posta konu satırına benzer. Eşlenen AMQP özelliği "subject" şeklindedir.
timeToLive	İletinin yaşam süresi değeri. Bu değer, iletinin süresinin dolmasına ilişkin göreli süredir ve iletinin aracı tarafından kabul edildiği ve depolandığı anından başlayarak enqueuedTimeUtciçinde yakalanır. Açıkça ayarlanmadığında, varsayılan değer ilgili kuyruk veya konu için DefaultTimeToLive değeridir. İleti düzeyi timeToLive değeri varlığın DefaultTimeToLive ayarından uzun olamaz ve varsa sessizce ayarlanır. Bkz. Süre Sonu.
to	"To" adresi. Bu özellik, yönlendirme senaryolarında gelecekteki kullanım için ayrılmıştır ve şu anda aracı tarafından yoksayılır. Uygulamalar, iletinin hedeflenen mantıksal hedefini göstermek için kural temelli otomatik iletme zincirleme senaryolarında bu değeri kullanabilir.

Özellik Ayrıntıları

applicationProperties

Özel ileti meta verileri için kullanılabilecek uygulamaya özgü özellikler.

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

Özellik Değeri

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

body

Gönderilmesi gereken veya alınması gereken ileti gövdesi. İletiyi alan uygulama bu SDK'yı kullanmıyorsa, daha iyi diller arası uyumluluk için gövde yükünüzü bir bayt dizisine veya Arabellek'e dönüştürün.

body: any

Özellik Değeri

any

contentType

İletinin içerik türü. İsteğe bağlı olarak, "application/json" gibi RFC2045, Bölüm 5 biçimini izleyen bir tanımlayıcı ile iletinin yükünü açıklar.

contentType?: string

Özellik Değeri

string

correlationId

Bir uygulamanın bağıntı amacıyla ileti için bir bağlam belirtmesine olanak tanıyan bağıntı tanımlayıcısı, örneğin yanıtlanan iletinin MessageId değerini yansıtır. bkz. İleti Yönlendirme ve Bağıntı .

correlationId?: string | number | Buffer

Özellik Değeri

string | number | Buffer

messageId

İleti tanımlayıcısı, iletiyi ve yükünü benzersiz olarak tanımlayan uygulama tanımlı bir değerdir.

Not: Tamsayı olmayan sayılara izin verilmez.

messageId?: string | number | Buffer

Özellik Değeri

string | number | Buffer

partitionKey

Bölümlenmiş varlığa ileti göndermek için bölüm anahtarı. Uzunluk üst sınırı 128 karakterdir. bölümlenmişvarlıklar için, bu değerin ayarlanması ilgili iletilerin aynı iç bölüme atanarak gönderim sırası sırasının doğru şekilde kaydedilmesini sağlar. Bölüm bu değer üzerinde bir karma işlevi tarafından seçilir ve doğrudan seçilemez.

• Oturum kullanan varlıklar için sessionId özelliği bu değeri geçersiz kılar.
• Bölümlenmemiş varlıklar için bölüm anahtarı yoksayılır

partitionKey?: string

Özellik Değeri

string

replyTo

Yanıtların gönderleneceği varlığın adresi. Bu isteğe bağlı ve uygulama tanımlı değer, iletinin alıcısına bir yanıt yolu ifade etmenin standart bir yoludur. Bir gönderen yanıt beklediğinde değeri, yanıtın gönderilmesini beklediği kuyruğun veya konunun mutlak veya göreli yoluna ayarlar. bkz. İleti Yönlendirme ve Bağıntı .

replyTo?: string

Özellik Değeri

string

replyToSessionId

replyTo adresini genişleten oturum tanımlayıcısı. Uzunluk üst sınırı 128 karakterdir. Bu değer ReplyTo bilgilerini genişletir ve yanıt varlığına gönderildiğinde yanıt için hangi SessionId değerinin ayarlanması gerektiğini belirtir. bkz. İleti Yönlendirme ve Bağıntı .

replyToSessionId?: string

Özellik Değeri

string

scheduledEnqueueTimeUtc

İletinin sıralanacağı UTC'deki tarih ve saat. Bu özellik UTC olarak saati döndürür; özelliği ayarlanırken, sağlanan DateTime değerinin de UTC olarak olması gerekir. Bu değer gecikmeli ileti gönderme içindir. Gelecekte belirli bir zamana gönderilen iletileri geciktirmek için kullanılır. İletinin sıralanma süresi, iletinin aynı anda gönderileceği anlamına gelmez. Sorgulanır, ancak gerçek gönderme süresi kuyruğun iş yüküne ve durumuna bağlıdır.

scheduledEnqueueTimeUtc?: Date

Özellik Değeri

Date

sessionId

Oturum kullanan bir varlığın oturum tanımlayıcısı. Uzunluk üst sınırı 128 karakterdir. Oturum kullanan varlıklar için, bu uygulama tanımlı değer iletinin oturum ilişkilendirmesini belirtir. Aynı oturum tanımlayıcısına sahip iletiler özet kilitlemeye tabidir ve tam olarak sıralı işlemeyi ve çift yönlü işlemi etkinleştirir. Oturum bilgisi olmayan varlıklar için bu değer yoksayılır. İleti Oturumlarını.

sessionId?: string

Özellik Değeri

string

subject

Uygulamaya özgü etiket. Bu özellik, uygulamanın iletinin amacını alıcıya standartlaştırılmış olarak belirtmesini sağlar. moda, e-posta konu satırına benzer. Eşlenen AMQP özelliği "subject" şeklindedir.

subject?: string

Özellik Değeri

string

timeToLive

İletinin yaşam süresi değeri. Bu değer, iletinin süresinin dolmasına ilişkin göreli süredir ve iletinin aracı tarafından kabul edildiği ve depolandığı anından başlayarak enqueuedTimeUtciçinde yakalanır. Açıkça ayarlanmadığında, varsayılan değer ilgili kuyruk veya konu için DefaultTimeToLive değeridir. İleti düzeyi timeToLive değeri varlığın DefaultTimeToLive ayarından uzun olamaz ve varsa sessizce ayarlanır. Bkz. Süre Sonu.

timeToLive?: number

Özellik Değeri

number

to

"To" adresi. Bu özellik, yönlendirme senaryolarında gelecekteki kullanım için ayrılmıştır ve şu anda aracı tarafından yoksayılır. Uygulamalar, iletinin hedeflenen mantıksal hedefini göstermek için kural temelli otomatik iletme zincirleme senaryolarında bu değeri kullanabilir.

to?: string

Özellik Değeri

string