ServiceBusClient class

Paket:

@azure/service-bus

Kuyruklara ve konulara ileti göndermek için Gönderen örnekleri ve kuyruklardan ve aboneliklerden ileti almak üzere Alıcı örnekleri oluşturabilen bir istemci.

Oluşturucular

ServiceBusClient(string, ServiceBusClientOptions)	Bağlantı dizesinde sağlanan Azure Service Bus ad alanına gönderenler ve alıcılar oluşturmak için kullanılabilecek serviceBusClient sınıfının bir örneğini oluşturur. İstemciyle oluşturulan gönderenler/alıcılar ileti göndermek/almak için kullanılana kadar hizmetle bağlantı yapılmaz.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)	Sağlanan Azure Service Bus ad alanına gönderenler ve alıcılar oluşturmak için kullanılabilecek ServiceBusClient sınıfının bir örneğini oluşturur. İstemciyle oluşturulan gönderenler/alıcılar ileti göndermek/almak için kullanılana kadar hizmetle bağlantı yapılmaz.

Özellikler

fullyQualifiedNamespace	Bu istemcinin oluşturulduğu Service Bus örneğinin tam ad alanı. Bu büyük olasılıkla .servicebus.windows.net'a benzer.
identifier	Bu ServiceBusClient'ı tanımlamak için kullanılan ad. Belirtilmezse veya boşsa rastgele benzersiz bir tane oluşturulur.

Yöntemler

acceptNextSession(string, ServiceBusSessionReceiverOptions)	Oturum etkinleştirilmiş bir Azure Service Bus kuyruğunda bir sonraki kullanılabilir oturum için alıcı oluşturur. İki alma modu arasında seçim yapabilirsiniz: "peekLock" (varsayılan) ve "receiveAndDelete". PeekLock modunda, alıcının kuyrukta belirtilen süre boyunca ileti üzerinde bir kilidi vardır. receiveAndDelete modunda iletiler alındıklarında Service Bus'tan silinir. Alıcıda completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi kapatabilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgiyi burada bulabilirsiniz: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)	Oturum özellikli bir Azure Service Bus aboneliğinde bir sonraki kullanılabilir oturum için alıcı oluşturur. İki alma modu arasında seçim yapabilirsiniz: "peekLock" (varsayılan) ve "receiveAndDelete". PeekLock modunda, alıcının kuyrukta belirtilen süre boyunca ileti üzerinde bir kilidi vardır. receiveAndDelete modunda iletiler alındıklarında Service Bus'tan silinir. Alıcıda completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi kapatabilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgiyi burada bulabilirsiniz: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)	Oturum etkinleştirilmiş Azure Service Bus kuyruğu için alıcı oluşturur. İki alma modu arasında seçim yapabilirsiniz: "peekLock" (varsayılan) ve "receiveAndDelete". PeekLock modunda, alıcının kuyrukta belirtilen süre boyunca ileti üzerinde bir kilidi vardır. receiveAndDelete modunda iletiler alındıklarında Service Bus'tan silinir. Alıcıda completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi kapatabilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgiyi burada bulabilirsiniz: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)	Oturum etkinleştirilmiş Azure Service Bus abonelik için alıcı oluşturur. İki alma modu arasında seçim yapabilirsiniz: "peekLock" (varsayılan) ve "receiveAndDelete". PeekLock modunda, alıcının kuyrukta belirtilen süre boyunca ileti üzerinde bir kilidi vardır. receiveAndDelete modunda iletiler alındıklarında Service Bus'tan silinir. Alıcıda completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi kapatabilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgiyi burada bulabilirsiniz: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()	Temel alınan AMQP bağlantısını kapatır. NOT: Bu, bu örnekten oluşturulan tüm Alıcı veya Gönderen örneklerinin bağlantısını da keser.
createReceiver(string, ServiceBusReceiverOptions)	Azure Service Bus kuyruğu için alıcı oluşturur. Alıcıdaki yöntemlerden biri çağrılana kadar hizmete bağlantı yapılmaz. Teslim edilemeyen ileti kuyruğu veya teslim edilemeyen ileti kuyruğu gibi alt kuyrukları hedeflemek için seçeneklerinde öğesini subQueue sağlayın. Teslim edilemeyen ileti kuyrukları hakkında daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues İki alma modu arasında seçim yapabilirsiniz: "peekLock" (varsayılan) ve "receiveAndDelete". PeekLock modunda, alıcının kuyrukta belirtilen süre boyunca ileti üzerinde bir kilidi vardır. receiveAndDelete modunda iletiler alındıklarında Service Bus'tan silinir. Kilit süresi içinde kapatılmayan iletiler, kuyrukta ayarlanan teslim sayısı üst sınırı kadar tekrar teslim edilir ve daha sonra ayrı bir teslim edilemeyen ileti kuyruğuna gönderilir. Alıcıda completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi kapatabilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgiyi burada bulabilirsiniz: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)	Azure Service Bus aboneliği için alıcı oluşturur. Alıcıdaki yöntemlerden biri çağrılana kadar hizmete bağlantı yapılmaz. Teslim edilemeyen ileti kuyruğu veya teslim edilemeyen ileti kuyruğu gibi alt kuyrukları hedeflemek için seçeneklerinde öğesini subQueue sağlayın. Teslim edilemeyen ileti kuyrukları hakkında daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues İki alma modu arasında seçim yapabilirsiniz: "peekLock" (varsayılan) ve "receiveAndDelete". PeekLock modunda, alıcının kuyrukta belirtilen süre boyunca ileti üzerinde bir kilidi vardır. receiveAndDelete modunda iletiler alındıklarında Service Bus'tan silinir. Kilit süresi içinde kapatılmayan iletiler, abonelikte ayarlanan maksimum teslim sayısı kadar tekrar teslim edilir ve daha sonra ayrı bir teslim edilemeyen ileti kuyruğuna gönderilir. Alıcıda completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi kapatabilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgiyi burada bulabilirsiniz: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)	Bir aboneliğin kurallarını yönetmek için kullanılan bir ServiceBusRuleManager örneği oluşturur.
createSender(string, ServiceBusSenderOptions)	İleti göndermek, iletileri daha sonra gönderilmek üzere zamanlamak ve bu zamanlanmış iletileri iptal etmek için kullanılabilecek bir Gönderen oluşturur. Gönderendeki yöntemlerden biri çağrılana kadar hizmetle bağlantı yapılmaz.

Oluşturucu Ayrıntıları

ServiceBusClient(string, ServiceBusClientOptions)

Bağlantı dizesinde sağlanan Azure Service Bus ad alanına gönderenler ve alıcılar oluşturmak için kullanılabilecek serviceBusClient sınıfının bir örneğini oluşturur. İstemciyle oluşturulan gönderenler/alıcılar ileti göndermek/almak için kullanılana kadar hizmetle bağlantı yapılmaz.

new ServiceBusClient(connectionString: string, options?: ServiceBusClientOptions)

Parametreler

connectionString

string

Azure Service Bus ad alanı için bir bağlantı dizesi. NOT: Bu bağlantı dizesi yoksayılan bir EntityPath içerebilir.

options

ServiceBusClientOptions

Service Bus istemcisi seçenekleri.

ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

Sağlanan Azure Service Bus ad alanına gönderenler ve alıcılar oluşturmak için kullanılabilecek ServiceBusClient sınıfının bir örneğini oluşturur. İstemciyle oluşturulan gönderenler/alıcılar ileti göndermek/almak için kullanılana kadar hizmetle bağlantı yapılmaz.

new ServiceBusClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: ServiceBusClientOptions)

Parametreler

fullyQualifiedNamespace

string

Service Bus örneğinizin .servicebus.windows.net'a benzer tam ad alanı.

credential

TokenCredential | NamedKeyCredential | SASCredential

Azure Service Bus ile bağlantının kimliğini doğrulamak üzere belirteci almak için istemci tarafından kullanılan bir kimlik bilgisi nesnesi. Kimlik bilgilerini oluşturmak için bkz. @azure/kimlik. AAD'de arabirimin TokenCredential kendi uygulamasını kullanıyorsanız uygun belirteci almak için service-bus için "kapsamları ["https://servicebus.azure.net//user_impersonation"] " olarak ayarlayın. AzureNamedKeyCredential bağlantı dizesi kullanmadan ve SharedAccessKey geçirmek istiyorsanız SharedAccessKeyName from @azure/core-auth komutunu kullanın. Bu alanlar, içinde sırasıyla ve key alanıyla AzureNamedKeyCredentialeşlername. AzureSASCredential Bağlantı dizesi kullanmadan geçirmek istiyorsanız SharedAccessSignature from @azure/core-auth komutunu kullanın. Bu alan içinde ile signatureAzureSASCredentialeşler.

options

ServiceBusClientOptions

İstemciyi yapılandırırken uygulanacak bir dizi seçenek.

• retryOptions : İstemcideki tüm işlemler için yeniden deneme ilkesini yapılandırılır. Örneğin { "maxRetries": 4 } veya { "maxRetries": 4, "retryDelayInMs": 30000 } olabilir.
• webSocketOptions: AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırılır.

Özellik Ayrıntıları

fullyQualifiedNamespace

Bu istemcinin oluşturulduğu Service Bus örneğinin tam ad alanı. Bu büyük olasılıkla .servicebus.windows.net'a benzer.

fullyQualifiedNamespace: string

Özellik Değeri

string

identifier

Bu ServiceBusClient'ı tanımlamak için kullanılan ad. Belirtilmezse veya boşsa rastgele benzersiz bir tane oluşturulur.

identifier: string

Özellik Değeri

string

Yöntem Ayrıntıları

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Oturum etkinleştirilmiş bir Azure Service Bus kuyruğunda bir sonraki kullanılabilir oturum için alıcı oluşturur.

İki alma modu arasında seçim yapabilirsiniz: "peekLock" (varsayılan) ve "receiveAndDelete".

• PeekLock modunda, alıcının kuyrukta belirtilen süre boyunca ileti üzerinde bir kilidi vardır.
• receiveAndDelete modunda iletiler alındıklarında Service Bus'tan silinir.

Alıcıda completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi kapatabilirsiniz.

PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgiyi burada bulabilirsiniz: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(queueName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parametreler

queueName

string

Alınacak kuyruğun adı.

options

ServiceBusSessionReceiverOptions

Seçenekler arasında receiveMode (varsayılan olarak peekLock olarak belirlenmiş), oturum alıcısı oluşturma seçenekleri bulunur.

Döndürülenler

Promise<ServiceBusSessionReceiver>

İletileri almak, göz atmak ve düzeltmek için kullanılabilecek bir alıcı.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Oturum özellikli bir Azure Service Bus aboneliğinde bir sonraki kullanılabilir oturum için alıcı oluşturur.

İki alma modu arasında seçim yapabilirsiniz: "peekLock" (varsayılan) ve "receiveAndDelete".

• PeekLock modunda, alıcının kuyrukta belirtilen süre boyunca ileti üzerinde bir kilidi vardır.
• receiveAndDelete modunda iletiler alındıklarında Service Bus'tan silinir.

Alıcıda completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi kapatabilirsiniz.

PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgiyi burada bulabilirsiniz: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(topicName: string, subscriptionName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parametreler

topicName

string

Almak istediğimiz aboneliğin konusunun adı.

subscriptionName

string

Almak istediğimiz aboneliğin topicadı (altında).

options

ServiceBusSessionReceiverOptions

Seçenekler arasında receiveMode (varsayılan olarak peekLock olarak belirlenmiş), oturum alıcısı oluşturma seçenekleri bulunur.

Döndürülenler

Promise<ServiceBusSessionReceiver>

İletileri almak, göz atmak ve düzeltmek için kullanılabilecek bir alıcı.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Oturum etkinleştirilmiş Azure Service Bus kuyruğu için alıcı oluşturur.

İki alma modu arasında seçim yapabilirsiniz: "peekLock" (varsayılan) ve "receiveAndDelete".

• PeekLock modunda, alıcının kuyrukta belirtilen süre boyunca ileti üzerinde bir kilidi vardır.
• receiveAndDelete modunda iletiler alındıklarında Service Bus'tan silinir.

Alıcıda completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi kapatabilirsiniz.

PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgiyi burada bulabilirsiniz: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(queueName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parametreler

queueName

string

Alınacak kuyruğun adı.

sessionId

string

İletilerin alınması gereken oturumun kimliği

options

ServiceBusSessionReceiverOptions

Seçenekler arasında receiveMode (varsayılan olarak peekLock olarak belirlenmiş), oturum alıcısı oluşturma seçenekleri bulunur.

Döndürülenler

Promise<ServiceBusSessionReceiver>

İletileri almak, göz atmak ve düzeltmek için kullanılabilecek bir alıcı.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Oturum etkinleştirilmiş Azure Service Bus abonelik için alıcı oluşturur.

İki alma modu arasında seçim yapabilirsiniz: "peekLock" (varsayılan) ve "receiveAndDelete".

• PeekLock modunda, alıcının kuyrukta belirtilen süre boyunca ileti üzerinde bir kilidi vardır.
• receiveAndDelete modunda iletiler alındıklarında Service Bus'tan silinir.

Alıcıda completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi kapatabilirsiniz.

PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgiyi burada bulabilirsiniz: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(topicName: string, subscriptionName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parametreler

topicName

string

Almak istediğimiz aboneliğin konusunun adı.

subscriptionName

string

Almak istediğimiz aboneliğin topicadı (altında).

sessionId

string

İletilerin alınması gereken oturumun kimliği

options

ServiceBusSessionReceiverOptions

Seçenekler arasında receiveMode (varsayılan olarak peekLock olarak belirlenmiş), oturum alıcısı oluşturma seçenekleri bulunur.

Döndürülenler

Promise<ServiceBusSessionReceiver>

İletileri almak, göz atmak ve düzeltmek için kullanılabilecek bir alıcı.

close()

Temel alınan AMQP bağlantısını kapatır. NOT: Bu, bu örnekten oluşturulan tüm Alıcı veya Gönderen örneklerinin bağlantısını da keser.

function close(): Promise<void>

Döndürülenler

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Azure Service Bus kuyruğu için alıcı oluşturur. Alıcıdaki yöntemlerden biri çağrılana kadar hizmete bağlantı yapılmaz.

Teslim edilemeyen ileti kuyruğu veya teslim edilemeyen ileti kuyruğu gibi alt kuyrukları hedeflemek için seçeneklerinde öğesini subQueue sağlayın. Teslim edilemeyen ileti kuyrukları hakkında daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

İki alma modu arasında seçim yapabilirsiniz: "peekLock" (varsayılan) ve "receiveAndDelete".

• PeekLock modunda, alıcının kuyrukta belirtilen süre boyunca ileti üzerinde bir kilidi vardır.
• receiveAndDelete modunda iletiler alındıklarında Service Bus'tan silinir.

Kilit süresi içinde kapatılmayan iletiler, kuyrukta ayarlanan teslim sayısı üst sınırı kadar tekrar teslim edilir ve daha sonra ayrı bir teslim edilemeyen ileti kuyruğuna gönderilir.

Alıcıda completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi kapatabilirsiniz.

PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgiyi burada bulabilirsiniz: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(queueName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

Parametreler

queueName

string

Alınacak kuyruğun adı.

options

ServiceBusReceiverOptions

varsayılan olarak peekLock olarak belirlenmiş olan receiveMode'u geçirme seçenekleri.

Döndürülenler

ServiceBusReceiver

İletileri almak, göz atmak ve düzeltmek için kullanılabilecek bir alıcı.

createReceiver(string, string, ServiceBusReceiverOptions)

Azure Service Bus aboneliği için alıcı oluşturur. Alıcıdaki yöntemlerden biri çağrılana kadar hizmete bağlantı yapılmaz.

Teslim edilemeyen ileti kuyruğu veya teslim edilemeyen ileti kuyruğu gibi alt kuyrukları hedeflemek için seçeneklerinde öğesini subQueue sağlayın. Teslim edilemeyen ileti kuyrukları hakkında daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

İki alma modu arasında seçim yapabilirsiniz: "peekLock" (varsayılan) ve "receiveAndDelete".

• PeekLock modunda, alıcının kuyrukta belirtilen süre boyunca ileti üzerinde bir kilidi vardır.
• receiveAndDelete modunda iletiler alındıklarında Service Bus'tan silinir.

Kilit süresi içinde kapatılmayan iletiler, abonelikte ayarlanan maksimum teslim sayısı kadar tekrar teslim edilir ve daha sonra ayrı bir teslim edilemeyen ileti kuyruğuna gönderilir.

Alıcıda completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi kapatabilirsiniz.

PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgiyi burada bulabilirsiniz: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(topicName: string, subscriptionName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

Parametreler

topicName

string

Almak istediğimiz aboneliğin konusu.

subscriptionName

string

Almak istediğimiz aboneliğin topicadı (altında).

options

ServiceBusReceiverOptions

varsayılan olarak peekLock olan receiveMode'u geçirme seçenekleri.

Döndürülenler

ServiceBusReceiver

İletileri almak, göz atmak ve çözmek için kullanılabilecek bir alıcı.

createRuleManager(string, string)

Bir aboneliğin kurallarını yönetmek için kullanılan bir ServiceBusRuleManager örneği oluşturur.

function createRuleManager(topicName: string, subscriptionName: string): ServiceBusRuleManager

Parametreler

topicName

string

ServiceBusRuleManager oluşturma konusu

subscriptionName

string

ServiceBusRuleManager oluşturmak için belirtilen konuya özgü abonelik.

Döndürülenler

ServiceBusRuleManager

Belirtilen abonelik ve konu başlığı kapsamında bir ServiceBusRuleManager .

createSender(string, ServiceBusSenderOptions)

İleti göndermek, iletileri daha sonra gönderilmek üzere zamanlamak ve bu zamanlanmış iletileri iptal etmek için kullanılabilecek bir Gönderen oluşturur. Gönderendeki yöntemlerden biri çağrılana kadar hizmetle bağlantı yapılmaz.

function createSender(queueOrTopicName: string, options?: ServiceBusSenderOptions): ServiceBusSender

Parametreler

queueOrTopicName

string

İleti gönderilecek kuyruğun veya konunun adı.

options

ServiceBusSenderOptions

Döndürülenler

ServiceBusSender