@azure/service-bus package

Sınıflar

MessagingError	Mesajlaşma Hatası için temel sınıfı açıklar.
ServiceBusAdministrationClient	Tüm işlemler, ilgili çıkışa sahip bir nesneye çözümleyen vaatler döndürür. Bu nesneler, hizmetten doğrudan yanıta erişmek istiyorsanız kullanabileceğiniz _response adlı bir özelliğe de sahiptir.
ServiceBusClient	Kuyruklara ve konulara ileti göndermek için Gönderen örnekleri ve kuyruklardan ve aboneliklerden ileti almak için Alıcı örnekleri oluşturabilen bir istemci.
ServiceBusError	Service Bus içinde oluşan hatalar.

Arabirimler

AuthorizationRule	ATOM tabanlı yönetim işlemlerinde AuthorizationRule türünü temsil eder.
CorrelationRuleFilter	Bağıntı filtresi ifadesini temsil eder. CorrelationRuleFilter, Abonelikten gelen iletilerin kullanıcı ve sistem özellikleriyle eşleşen bir dizi koşul içerir.
CreateMessageBatchOptions	createBatch Sender yöntemini yapılandırma seçenekleri. maxSizeInBytes: Toplu iş boyutu için üst sınır. Örnek kullanım: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Kuyrukta ayarlanabilir seçenekleri temsil eder
CreateSubscriptionOptions	Abonelikte ayarlanabilir seçenekleri temsil eder
CreateTopicOptions	Bir konudaki ayarlanabilir seçenekleri temsil eder
DeadLetterOptions	Service Bus'tan alınan iletide deadLetter() yöntemini kullanarak iletinin teslim edilmeme nedenini ve hata açıklamasını açıklar.
Delivery
GetMessageIteratorOptions	Service Bus'tan yinelenebilir bir yineleyici alma seçenekleri.
HttpHeader	HttpHeaders koleksiyonundaki tek bir üst bilgi.
HttpHeadersLike	HTTP üst bilgi anahtarı/değer çiftleri koleksiyonu.
HttpResponse	Http yanıtlarında her zaman mevcut olacak özellikler.
MessageHandlers	Genel ileti işleyici arabirimi (streamMessages için kullanılır).
NamespaceProperties	Service Bus ad alanıyla ilgili meta verileri temsil eder.
OperationOptions	Tüm işlemler için temel seçenekler türü.
PeekMessagesOptions	Bir alıcıdaki peekMessages yöntemine geçirilen seçenekleri açıklar.
ProcessErrorArgs	processError geri çağırma bağımsız değişkenleri.
QueueProperties	updateQueue girişini temsil eder.
QueueRuntimeProperties	Kuyruk varlığının çalışma zamanı bilgi özniteliklerini temsil eder
ReceiveMessagesOptions	Service Bus'tan toplu ileti alırken seçenekler.
RetryOptions	Modu, yeniden deneme sayısını, yeniden deneme aralığını vb. belirleyen yeniden deneme ilkesi seçenekleri.
RuleProperties	Bir kuralın tüm özniteliklerini temsil eder.
ServiceBusAdministrationClientOptions	ServiceBusAdministrationClientistemci seçeneklerini temsil eder.
ServiceBusClientOptions	ServiceBusClient oluşturulurken sağlanacak seçenekleri açıklar. webSocketOptions: AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırma seçenekleri. websocket: WebSocket üzerinden bağlantı oluşturmayı seçerseniz AMQP bağlantısı oluşturmak için kullanılan WebSocket oluşturucu. webSocketConstructorOptions: Bağlantıyı bir WebSocket üzerinden yapmayı seçtiğinizde Websocket oluşturucusna geçirme seçenekleri. retryOptions: İstemcideki tüm işlemler için yeniden deneme seçenekleri. maxRetries: Yeniden denenebilir bir hata durumunda işlemin yeniden denenme sayısı. maxRetryDelayInMs: Yeniden denemeler arasındaki en uzun gecikme. Yalnızca üstel yeniden denemeler gerçekleştirilirken geçerlidir. mode: Uygulanacak yeniden deneme modu, RetryMode sabit listesi tarafından belirtilir. Seçenekler Exponential ve Fixed. varsayılan olarak Fixed. retryDelayInMs: Bir sonraki denemeyi yapmadan önce milisaniye cinsinden beklenen süre. mode Exponentialolarak ayarlandığında, bu, yeniden denemeler arasındaki üstel olarak artan gecikmeleri hesaplamak için kullanılır. Varsayılan: 30000 milisaniye. timeoutInMs: İşlemin zaman aşımına uğraması için milisaniye cinsinden beklenme süresi. Bu, kalan yeniden deneme girişimleri varsa yeniden denemeyi tetikler. En düşük değer: 60000 milisaniye.
ServiceBusConnectionStringProperties	Service Bus bağlantı dizesini oluşturan özellikler kümesi.
ServiceBusMessage	Service Bus'a gönderilecek iletiyi açıklar.
ServiceBusMessageBatch	<xref:createBatch> yöntemini kullanarak oluşturabileceğiniz bir grup ileti.
ServiceBusReceivedMessage	Göz atma işlemleri sırasında Service Bus'tan alınan iletiyi açıklar ve bu nedenle kapatılamaz.
ServiceBusReceiver	Oturumları işlemeyen bir alıcı.
ServiceBusReceiverOptions	Alıcı oluştururken kullanılacak seçenekler.
ServiceBusRuleManager	Bir aboneliğin yönetilmesine yönelik kurallara izin verir. Bu kural yöneticisi yalnızca Dinleme talepleri gerektirirken, ServiceBusAdministrationClient Talepleri yönetmeyi gerektirir.
ServiceBusSender	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.
ServiceBusSenderOptions	Gönderen oluştururken kullanılacak seçenekler.
ServiceBusSessionReceiver	Oturum kilidini yenileme dahil olmak üzere oturumları işleyen bir alıcı.
ServiceBusSessionReceiverOptions	Oturumları etkinleştirilmiş bir Kuyruk/Abonelik kullanılırken acceptSession ve acceptNextSession yöntemlerine geçirilen seçenekleri açıklar.
SqlRuleFilter	SqlRuleFilter'da tüm olası alanları temsil eder
SubscribeOptions	Service Bus kuyruğuna veya aboneliğine abone olduğunuzda kullanılan seçenekler.
SubscriptionProperties	updateSubscription girişini temsil eder.
SubscriptionRuntimeProperties	Abonelik varlığının çalışma zamanı bilgi özniteliklerini temsil eder
TokenCredential	Kimlik doğrulama belirteci sağlayabilen bir kimlik bilgilerini temsil eder.
TopicProperties	updateTopic girişini temsil eder.
TopicRuntimeProperties	Konu varlığının çalışma zamanı bilgi özniteliklerini temsil eder
TryAddOptions	Dağıtılmış izleme için Span bağlamı el ile yayma seçenekleri kümesi.
WebResourceLike	Uzak sunucuya yapılacak HTTP isteğinin açıklaması.
WebSocketImpl	WebSocket oluşturucularının gerekli şeklini açıklar.
WebSocketOptions	AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırma seçenekleri.

Tür Diğer Adları

EntitiesResponse	Üzerinde yinelemeye başlamak için continuationToken de içeren varlıklardaki liste işleminin sonucunu temsil eder.
EntityAvailabilityStatus	Service Bus mesajlaşma varlıklarının availabilityStatus için olası değerler.
EntityStatus	Service Bus mesajlaşma varlıklarının status için olası değerler.
OperationOptionsBase	NOT: Bu tür, @azure/core-client OperationOptions'tan ilgili alanları ve yapıyı yansıtmak için tasarlanmıştır İzlemeyi ve abortSignal'ı yapılandırma seçenekleri.
RawHttpHeaders	Basit bir JSON nesnesi olarak temsil edilen httpheaders koleksiyonu.
ServiceBusErrorCode	Service Bus hata kodları.
SqlRuleAction	SqlRuleAction'da tüm olası alanları temsil eder
TransferProgressEvent	Karşıya yükleme veya indirme ilerlemesine yanıt olarak tetiklenir.
WithResponse	ham yanıtla birlikte işlemin döndürülen yanıtını temsil eder.

Numaralandırmalar

RetryMode	Yeniden Deneme Modu türünü açıklar
TokenType	Desteklenen belirteçlerin türünü açıklar.

İşlevler

delay<T>(number, AbortSignalLike, string, T)	t milisaniyeden sonra bir promise'i çözümleyen setTimeout için sarmalayıcı.
isServiceBusError(unknown)	Hatanın ServiceBusError türünde olup olmadığını belirler
parseServiceBusConnectionString(string)	Verilen bağlantı dizesini Azure Service Bus için geçerli olan farklı özelliklere ayrıştırıyor. Özellikler daha sonra bir ServiceBusClient oluşturmak için yararlıdır.

İşlev Ayrıntıları

delay<T>(number, AbortSignalLike, string, T)

t milisaniyeden sonra bir promise'i çözümleyen setTimeout için sarmalayıcı.

function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>

Parametreler

delayInMs

number

Ertelenecek milisaniye sayısı.

abortSignal

AbortSignalLike

içeren işlemle ilişkili abortSignal.

abortErrorMsg

string

İşlemi içeren işlemle ilişkili durdurma hata iletisi.

value

T

T milisaniyelik zaman aşımından sonra çözümlenecek değer.

Döndürülenler

Promise<T | void>

• Çözümlenen söz

isServiceBusError(unknown)

Hatanın ServiceBusError türünde olup olmadığını belirler

function isServiceBusError(err: unknown): err

Parametreler

err

unknown

ServiceBusError türünde olup olmadığını denetleme hatası

Döndürülenler

err

parseServiceBusConnectionString(string)

Verilen bağlantı dizesini Azure Service Bus için geçerli olan farklı özelliklere ayrıştırıyor. Özellikler daha sonra bir ServiceBusClient oluşturmak için yararlıdır.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Parametreler

connectionString

string

Service Bus ad alanı, kuyruğu veya konusu için oluşturulan Paylaşılan Erişim İlkesi ile ilişkili bağlantı dizesi.

Döndürülenler

ServiceBusConnectionStringProperties