ServiceBusReceivedMessage interface

Paket:

@azure/service-bus

Göz atma işlemleri sırasında Service Bus'tan alınan iletiyi açıklar ve bu nedenle kapatılamaz.

Extends

ServiceBusMessage

Özellikler

deadLetterErrorDescription	İletinin geçersiz olduğuna ilişkin hata açıklaması.
deadLetterReason	Mesajın geçersiz olmasının nedeni.
deadLetterSource	Bu iletinin teslim edilmeden önce kuyruğa alındığı kuyruğun veya aboneliğin adı. Yalnızca teslim edilemeyen ve sonradan teslim edilemeyen ileti alt kuyruğundan başka bir varlığa otomatik olarak iletilen iletilerde ayarlanır. İletinin teslim edilmediği varlığı gösterir.
deliveryCount	Bu ileti için denenen teslimat sayısı. İleti kilidinin süresi dolduğunda veya ileti, iletideki yöntem kullanılarak abandon() açıkça terk edildiğinde sayı artırılır.
enqueuedSequenceNumber	İletinin özgün sıra numarası. Otomatik olarak iletilen iletiler için, bu özellik iletiye ilk olarak özgün gönderim noktasında atanmış olan sıra numarasını yansıtır.
enqueuedTimeUtc	İletinin kabul edildiği ve Service Bus'ta depolandığı UTC anlık örneği.
expiresAtUtc	İletinin kaldırılmak üzere işaretlendiği ve süre sonu nedeniyle varlıktan alınamayacak şekilde işaretlendiği UTC anlık örneği. Bu özellik, iletideki diğer 2 özellikten hesaplanır: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	İletinin kuyrukta/abonelikte kilitli tutıldığı UTC anında. Kilidin süresi dolduğunda, deliveryCount etkinleştirilir ve ileti yeniden alınabilir. İleti alma modunda alındığında receiveAndDelete geçerli değildir. mod.
lockToken	Kilit belirteci, aracı peekLock tarafından alma modunda tutulan kilide yapılan bir başvurudur. Kilitler, ürün belgelerinde daha ayrıntılı olarak açıklandığı gibi mesajları dahili olarak yerleştirmek için kullanılır İleti alma modunda alındığında receiveAndDelete geçerli değildir. mod.
sequenceNumber	Service Bus tarafından bir iletiye atanan benzersiz numara. Sıra numarası, bir iletiye atanan benzersiz bir 64 bitlik tamsayıdır; aracı tarafından kabul edilir ve gerçek tanımlayıcısı olarak depolanır. Bölümlenmiş varlıklar için en üstteki 16 bit bölüm tanımlayıcısını yansıtır. Sıra sayıları monoton olarak artar. 48-64 bit aralığı tükendiğinde 0'a yuvarlanır. Javascript'in şu anda desteklediği maksimum güvenli tamsayı 'dir2^53 - 1. Sıra numarası, 64 bit uzunluğuna kadar olabilen bir AMQP Long türüdür. Bunu temsil etmek için long.jsadlı bir kütüphane kullanıyoruz. Müşterilerin bu kitaplık tarafından dışa aktarılan türü kullanmasını Long bekliyoruz.
state	İletinin durumu etkin, ertelenmiş veya zamanlanmış olabilir. Ertelenen iletiler ertelenmiş duruma, zamanlanmış iletiler zamanlanmış duruma, diğer tüm iletiler etkin duruma sahiptir.

Devralınan Ö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 atanmasını sağlar, böylece gönderim sırası sırası doğru bir şekilde kaydedilir. 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ı

deadLetterErrorDescription

İletinin geçersiz olduğuna ilişkin hata açıklaması.

deadLetterErrorDescription?: string

Özellik Değeri

string

deadLetterReason

Mesajın geçersiz olmasının nedeni.

deadLetterReason?: string

Özellik Değeri

string

deadLetterSource

Bu iletinin teslim edilmeden önce kuyruğa alındığı kuyruğun veya aboneliğin adı. Yalnızca teslim edilemeyen ve sonradan teslim edilemeyen ileti alt kuyruğundan başka bir varlığa otomatik olarak iletilen iletilerde ayarlanır. İletinin teslim edilmediği varlığı gösterir.

deadLetterSource?: string

Özellik Değeri

string

deliveryCount

Bu ileti için denenen teslimat sayısı. İleti kilidinin süresi dolduğunda veya ileti, iletideki yöntem kullanılarak abandon() açıkça terk edildiğinde sayı artırılır.

deliveryCount?: number

Özellik Değeri

number

enqueuedSequenceNumber

İletinin özgün sıra numarası. Otomatik olarak iletilen iletiler için, bu özellik iletiye ilk olarak özgün gönderim noktasında atanmış olan sıra numarasını yansıtır.

enqueuedSequenceNumber?: number

Özellik Değeri

number

enqueuedTimeUtc

İletinin kabul edildiği ve Service Bus'ta depolandığı UTC anlık örneği.

enqueuedTimeUtc?: Date

Özellik Değeri

Date

expiresAtUtc

İletinin kaldırılmak üzere işaretlendiği ve süre sonu nedeniyle varlıktan alınamayacak şekilde işaretlendiği UTC anlık örneği. Bu özellik, iletideki diğer 2 özellikten hesaplanır: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Özellik Değeri

Date

lockedUntilUtc

İletinin kuyrukta/abonelikte kilitli tutıldığı UTC anında. Kilidin süresi dolduğunda, deliveryCount etkinleştirilir ve ileti yeniden alınabilir.

• İleti alma modunda alındığında receiveAndDelete geçerli değildir. mod.

lockedUntilUtc?: Date

Özellik Değeri

Date

lockToken

Kilit belirteci, aracı peekLock tarafından alma modunda tutulan kilide yapılan bir başvurudur. Kilitler, ürün belgelerinde daha ayrıntılı olarak açıklandığı gibi mesajları dahili olarak yerleştirmek için kullanılır

• İleti alma modunda alındığında receiveAndDelete geçerli değildir. mod.

lockToken?: string

Özellik Değeri

string

sequenceNumber

Service Bus tarafından bir iletiye atanan benzersiz numara. Sıra numarası, bir iletiye atanan benzersiz bir 64 bitlik tamsayıdır; aracı tarafından kabul edilir ve gerçek tanımlayıcısı olarak depolanır. Bölümlenmiş varlıklar için en üstteki 16 bit bölüm tanımlayıcısını yansıtır. Sıra sayıları monoton olarak artar. 48-64 bit aralığı tükendiğinde 0'a yuvarlanır.

Javascript'in şu anda desteklediği maksimum güvenli tamsayı 'dir2^53 - 1. Sıra numarası, 64 bit uzunluğuna kadar olabilen bir AMQP Long türüdür. Bunu temsil etmek için long.jsadlı bir kütüphane kullanıyoruz. Müşterilerin bu kitaplık tarafından dışa aktarılan türü kullanmasını Long bekliyoruz.

sequenceNumber?: Long

Özellik Değeri

Long

state

İletinin durumu etkin, ertelenmiş veya zamanlanmış olabilir. Ertelenen iletiler ertelenmiş duruma, zamanlanmış iletiler zamanlanmış duruma, diğer tüm iletiler etkin duruma sahiptir.

state: "active" | "deferred" | "scheduled"

Özellik Değeri

"active" | "deferred" | "scheduled"

Devralınan Özellik Detayları

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}

Devralındığı yer:ServiceBusMessage.applicationProperties

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

Devralındığı yer:ServiceBusMessage.body

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

Devralındığı yer:ServiceBusMessage.contentType

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

Devralındığı yer:ServiceBusMessage.correlationId

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

Devralındığı yer:ServiceBusMessage.messageId

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 atanmasını sağlar, böylece gönderim sırası sırası doğru bir şekilde kaydedilir. 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

Devralındığı yer:ServiceBusMessage.partitionKey

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

Devralındığı yer:ServiceBusMessage.replyTo

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

Devralındığı yer:ServiceBusMessage.replyToSessionId

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

Devralındığı yer:ServiceBusMessage.scheduledEnqueueTimeUtc

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

Devralındığı yer:ServiceBusMessage.sessionId

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

Devralındığı yer:ServiceBusMessage.subject

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

Devralındığı yer:ServiceBusMessage.timeToLive

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

Devralındığı yer:ServiceBusMessage.to