ServiceBusSender interface

Paket:

@azure/service-bus

Gönderen, ileti göndermek, iletileri daha sonra gönderilecek şekilde zamanlamak ve bu zamanlanmış iletileri iptal etmek için kullanılabilir. Bir Gönderen örneği oluşturmak için ServiceBusClient'da createSender işlevini kullanın. Sender sınıfı, temel alınan AMQP gönderen bağlantısı üzerinde bir soyutlamadır.

Özellikler

entityPath	Gönderenin oluşturulduğu varlığın yolu.
identifier	Göndereni tanımlamak için kullanılan ad. Bu, günlükleri ve özel durumları ilişkilendirmek için kullanılabilir. Belirtilmezse veya boşsa rastgele benzersiz bir tane oluşturulur.
isClosed	Gönderen veya oluşturan istemci kapatılmışsa true döndürür.

Yöntemler

cancelScheduledMessages(Long | Long[], OperationOptionsBase)	ServiceBus Kuyruğunda/Aboneliğinde görünmesi planlanan birden çok iletiyi iptal eder.
close()	Temel alınan AMQP gönderen bağlantısını kapatır. Kapatıldıktan sonra, gönderen başka işlemler için kullanılamaz. Yeni bir Gönderen örneği oluşturmak için QueueClient veya TopicClient üzerindeki createSender işlevini kullanın
createMessageBatch(CreateMessageBatchOptions)	Desteklenen boyut üst sınırına ulaşılana kadar ileti ekleyebilen bir ServiceBusMessageBatch örneği oluşturur. Toplu iş, iletileri Azure Service Bus'a göndermek için <xref:send> yöntemine geçirilebilir.
scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)	Verilen iletilerin daha sonra Service Bus Kuyruğunda/Aboneliğinde gösterilmesini zamanlar.
sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)	Henüz yoksa, amqp gönderen bağlantısı oluşturduktan sonra verilen iletileri gönderir. session ve/veya partition etkin bir Kuyruk/Konu Başlığına ileti göndermek için, iletilerde sırasıyla sessionId ve/veya partitionKey özelliklerini ayarlayın. Aynı sendMessages() çağrısına geçirilen tüm iletiler aynı sessionId (oturum kullanıyorsa) ve aynı partitionKey (bölümler kullanılıyorsa) olmalıdır. Not: Boyutu 1 MB'tan büyük iletiler göndermek istiyorsanız, toplu ileti veya aşağıdaki gibi bir ileti dizisi göndermek yerine tek tek iletiler gönderin. await sender.sendMessages(message); Bunun nedeni toplu iletilerin henüz daha büyük iletileri gönderememesidir. Aksi takdirde bu durumda force detached hatasına isabet edersiniz. service-bus-premium-messaging#large-messages-support okuyun. daha fazla bilgi için #23014.

Özellik Ayrıntıları

entityPath

Gönderenin oluşturulduğu varlığın yolu.

entityPath: string

Özellik Değeri

string

identifier

Göndereni tanımlamak için kullanılan ad. Bu, günlükleri ve özel durumları ilişkilendirmek için kullanılabilir. Belirtilmezse veya boşsa rastgele benzersiz bir tane oluşturulur.

identifier: string

Özellik Değeri

string

isClosed

Gönderen veya oluşturan istemci kapatılmışsa true döndürür.

isClosed: boolean

Özellik Değeri

boolean

Yöntem Ayrıntıları

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

ServiceBus Kuyruğunda/Aboneliğinde görünmesi planlanan birden çok iletiyi iptal eder.

function cancelScheduledMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<void>

Parametreler

sequenceNumbers

Long | Long[]

sıra numarası veya iptal edilecek iletilerin dizi numaraları dizisi.

options

OperationOptionsBase

Seçenekler, durdurma sinyali veya izleme seçeneklerini geçirmek için hazır.

Döndürülenler

Promise<void>

close()

Temel alınan AMQP gönderen bağlantısını kapatır. Kapatıldıktan sonra, gönderen başka işlemler için kullanılamaz. Yeni bir Gönderen örneği oluşturmak için QueueClient veya TopicClient üzerindeki createSender işlevini kullanın

function close(): Promise<void>

Döndürülenler

Promise<void>

createMessageBatch(CreateMessageBatchOptions)

Desteklenen boyut üst sınırına ulaşılana kadar ileti ekleyebilen bir ServiceBusMessageBatch örneği oluşturur. Toplu iş, iletileri Azure Service Bus'a göndermek için <xref:send> yöntemine geçirilebilir.

function createMessageBatch(options?: CreateMessageBatchOptions): Promise<ServiceBusMessageBatch>

Parametreler

options

CreateMessageBatchOptions

Toplu iş davranışını yapılandırılır.

• maxSizeInBytes: Toplu iş boyutu için üst sınır. bu sınıra ulaşıldıktan sonra tryAdd işlevi false döndürür.

Döndürülenler

Promise<ServiceBusMessageBatch>

scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Verilen iletilerin daha sonra Service Bus Kuyruğunda/Aboneliğinde gösterilmesini zamanlar.

function scheduleMessages(messages: ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], scheduledEnqueueTimeUtc: Date, options?: OperationOptionsBase): Promise<Long[]>

Parametreler

messages

ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

zamanlanması gereken ileti veya ileti dizisi.

scheduledEnqueueTimeUtc

Date

İletilerin sıralanması gereken UTC saati.

options

OperationOptionsBase

Seçenekler, durdurma sinyali veya izleme seçeneklerini geçirmek için hazır.

Döndürülenler

Promise<Long[]>

Zamanlanmış iletilerin sıra numaraları. İletilerin zamanlamasını iptal etmek istiyorsanız, sıra numarasına ihtiyacınız olacaktır. Sayıya dönüştürmeden uygulamanıza as-is Long türünü kaydedin. JavaScript yalnızca 53 bit sayıları desteklediğinden, Long sayıya dönüştürmek duyarlık kaybına neden olur.

sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Henüz yoksa, amqp gönderen bağlantısı oluşturduktan sonra verilen iletileri gönderir.

• session ve/veya partition etkin bir Kuyruk/Konu Başlığına ileti göndermek için, iletilerde sırasıyla sessionId ve/veya partitionKey özelliklerini ayarlayın.
• Aynı sendMessages() çağrısına geçirilen tüm iletiler aynı sessionId (oturum kullanıyorsa) ve aynı partitionKey (bölümler kullanılıyorsa) olmalıdır.

Not:

Boyutu 1 MB'tan büyük iletiler göndermek istiyorsanız, toplu ileti veya aşağıdaki gibi bir ileti dizisi göndermek yerine tek tek iletiler gönderin.

await sender.sendMessages(message);

Bunun nedeni toplu iletilerin henüz daha büyük iletileri gönderememesidir. Aksi takdirde bu durumda force detached hatasına isabet edersiniz. service-bus-premium-messaging#large-messages-support okuyun. daha fazla bilgi için #23014.

function sendMessages(messages: ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], options?: OperationOptionsBase): Promise<void>

Parametreler

messages

ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Göndermek için createBatch() yöntemiyle oluşturulan tek bir ileti veya ileti dizisi ya da toplu ileti.

options

OperationOptionsBase

Seçenekler, durdurma sinyali veya izleme seçeneklerini geçirmek için hazır.

Döndürülenler

Promise<void>