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ğu hata açıklaması.
deadLetterReason	Mesajın geçersiz olmasının sebebi.
deadLetterSource	Bu iletinin teslim edilemeden önce sıraya alındığı kuyruğun veya aboneliğin adı. Yalnızca teslim edilemeyen ve sonra 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 teslimatların sayısı. İleti kilidinin süresi dolduğunda veya iletideki yöntemi kullanılarak abandon() açıkça bırakıldığında sayı artırılır.
enqueuedSequenceNumber	İletinin özgün sıra numarası. Otomatik olarak iletilen iletiler için, bu özellik ilk gönderim noktasında iletiye atanmış olan sıra numarasını yansıtır.
enqueuedTimeUtc	İletinin kabul edildiği ve Service Bus'ta depolandığı UTC anında.
expiresAtUtc	İletinin kaldırılmak üzere işaretlendiği ve süre sonu nedeniyle varlıktan alınamayacağı UTC anında. Bu özellik, iletideki diğer 2 özellikten hesaplanır: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	İletinin kuyrukta/abonelikte kilitli tutulduğu utc anında. Kilidin süresi dolduğunda, deliveryCount değeri artırılır ve ileti yeniden alınabilir. İleti alma modunda alındığında receiveAndDelete geçerli değildir. Modu.
lockToken	Kilit belirteci, aracı tarafından alma modunda tutulan kilide peekLock bir başvurudur. Kilitler, ürün belgelerinde daha ayrıntılı olarak açıklandığı gibi dahili olarak kapatma iletileri kullanılır İleti alma modunda alındığında receiveAndDelete geçerli değildir. Modu.
sequenceNumber	Service Bus tarafından iletiye atanan benzersiz numara. Sıra numarası, bir iletiye atanan benzersiz bir 64 bitlik tamsayıdır, aracı tarafından kabul edilir ve depolanır ve gerçek tanımlayıcısı olarak işlev görü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ırlar. Javascript'in şu anda desteklediği maksimum güvenli tamsayıdır2^53 - 1. Sıra numarası, en fazla 64 bit uzunluğunda olabilecek bir AMQP Long türüdür. long.jsadlı bir kitaplık kullandığımızı göstermek için. Müşterilerin bu kitaplık tarafından dışarı aktarılan türü kullanmasını Long bekliyoruz.
state	İletinin durumu etkin, ertelenmiş veya zamanlanmış olabilir. Ertelenen iletiler ertelenmiş duruma sahiptir, zamanlanmış iletiler zamanlanmış duruma sahiptir, 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 iletinin yükünü, RFC2045, Bölüm 5 biçimini izleyen bir tanımlayıcıyla (örneğin, "application/json") açıklar.
correlationId	Bir uygulamanın bağıntı amacıyla ileti için bağlam belirtmesine olanak tanıyan bağıntı tanımlayıcısı, örneğin yanıtlanan iletinin MessageId değerini yansıtmak. 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ı, gönderme sırası sırasının doğru şekilde kaydedilmesi için ilgili iletilerin aynı iç bölüme atanabilmesini 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 sessionId için ö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ıt gönderilecek 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. 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	Adresi genişleten oturum tanımlayıcısı replyTo . 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ıraya alınacağı UTC'deki tarih ve saat. Bu özellik UTC olarak saati döndürür; özelliği ayarlanırken, sağlanan DateTime değeri de UTC'de olmalıdır. Bu değer gecikmeli ileti göndermeye yöneliktir. Gelecekte belirli bir zamana gönderilen iletileri geciktirmek için kullanılır. İletinin sıraya alınması, iletinin aynı anda gönderileceği anlamına gelmez. Sıraya alınacaktı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 bağlantısını belirtir. Aynı oturum tanımlayıcısına sahip iletiler özet kilitlemeye tabidir ve tam olarak sıralı işlemeyi ve yinelenenleri kaldırmayı etkinleştirir. Oturum bilgisi olmayan varlıklar için bu değer yoksayılır. İleti Oturumları.
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üresi sona erdikten sonra, iletinin aracı tarafından kabul edildiği ve depolandığı anından başlayarak içinde yakalandığı göreli süredir enqueuedTimeUtc. 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 daha uzun olamaz ve varsa sessizce ayarlanır. Bkz . Süre Sonu.
to	"Son" adresi. Bu özellik, yönlendirme senaryolarında gelecekte kullanılmak üzere ayrılmıştır ve aracı tarafından şu anda yoksayılır. Uygulamalar, iletinin hedeflenen mantıksal hedefini belirtmek için kural temelli otomatik iletme zincirleme senaryolarında bu değeri kullanabilir.

Özellik Ayrıntıları

deadLetterErrorDescription

İletinin geçersiz olduğu hata açıklaması.

deadLetterErrorDescription?: string

Özellik Değeri

string

deadLetterReason

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

deadLetterReason?: string

Özellik Değeri

string

deadLetterSource

Bu iletinin teslim edilemeden önce sıraya alındığı kuyruğun veya aboneliğin adı. Yalnızca teslim edilemeyen ve sonra 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 teslimatların sayısı. İleti kilidinin süresi dolduğunda veya iletideki yöntemi kullanılarak abandon() açıkça bırakıldığında 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 ilk gönderim noktasında iletiye 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 anında.

enqueuedTimeUtc?: Date

Özellik Değeri

Date

expiresAtUtc

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

expiresAtUtc?: Date

Özellik Değeri

Date

lockedUntilUtc

İletinin kuyrukta/abonelikte kilitli tutulduğu utc anında. Kilidin süresi dolduğunda, deliveryCount değeri artırılır ve ileti yeniden alınabilir.

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

lockedUntilUtc?: Date

Özellik Değeri

Date

lockToken

Kilit belirteci, aracı tarafından alma modunda tutulan kilide peekLock bir başvurudur. Kilitler, ürün belgelerinde daha ayrıntılı olarak açıklandığı gibi dahili olarak kapatma iletileri kullanılır

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

lockToken?: string

Özellik Değeri

string

sequenceNumber

Service Bus tarafından iletiye atanan benzersiz numara. Sıra numarası, bir iletiye atanan benzersiz bir 64 bitlik tamsayıdır, aracı tarafından kabul edilir ve depolanır ve gerçek tanımlayıcısı olarak işlev görü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ırlar.

Javascript'in şu anda desteklediği maksimum güvenli tamsayıdır2^53 - 1. Sıra numarası, en fazla 64 bit uzunluğunda olabilecek bir AMQP Long türüdür. long.jsadlı bir kitaplık kullandığımızı göstermek için. Müşterilerin bu kitaplık tarafından dışarı 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 sahiptir, zamanlanmış iletiler zamanlanmış duruma sahiptir, 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}

ServiceBusMessage.applicationProperties'tenDevralındı

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

ServiceBusMessage.body'denDevralındı

contentType

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

contentType?: string

Özellik Değeri

string

ServiceBusMessage.contentType'tanDevralındı

correlationId

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

correlationId?: string | number | Buffer

Özellik Değeri

string | number | Buffer

ServiceBusMessage.correlationId'denDevralındı

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

ServiceBusMessage.messageId'denDevralındı

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ı, gönderme sırası sırasının doğru şekilde kaydedilmesi için ilgili iletilerin aynı iç bölüme atanabilmesini 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 sessionId için ö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

ServiceBusMessage.partitionKey'denDevralındı

replyTo

Yanıt gönderilecek 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. 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

ServiceBusMessage.replyTo'danDevralındı

replyToSessionId

Adresi genişleten oturum tanımlayıcısı replyTo . 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

ServiceBusMessage.replyToSessionId'denDevralındı

scheduledEnqueueTimeUtc

İletinin sıraya alınacağı UTC'deki tarih ve saat. Bu özellik UTC olarak saati döndürür; özelliği ayarlanırken, sağlanan DateTime değeri de UTC'de olmalıdır. Bu değer gecikmeli ileti göndermeye yöneliktir. Gelecekte belirli bir zamana gönderilen iletileri geciktirmek için kullanılır. İletinin sıraya alınması, iletinin aynı anda gönderileceği anlamına gelmez. Sıraya alınacaktı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

ServiceBusMessage.scheduledEnqueueTimeUtc'denDevralındı

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 bağlantısını belirtir. Aynı oturum tanımlayıcısına sahip iletiler özet kilitlemeye tabidir ve tam olarak sıralı işlemeyi ve yinelenenleri kaldırmayı etkinleştirir. Oturum bilgisi olmayan varlıklar için bu değer yoksayılır. İleti Oturumları.

sessionId?: string

Özellik Değeri

string

ServiceBusMessage.sessionId'denDevralındı

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

ServiceBusMessage.subject'danDevralındı

timeToLive

İletinin yaşam süresi değeri. Bu değer, iletinin süresi sona erdikten sonra, iletinin aracı tarafından kabul edildiği ve depolandığı anından başlayarak içinde yakalandığı göreli süredir enqueuedTimeUtc. 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 daha uzun olamaz ve varsa sessizce ayarlanır. Bkz . Süre Sonu.

timeToLive?: number

Özellik Değeri

number

ServiceBusMessage.timeToLive'danDevralındı

to

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

to?: string

Özellik Değeri

string

ServiceBusMessage.to Devralındı