ServiceBusClient class

Paket:

@azure/service-bus

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.

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)	ServiceBusClient sınıfının, sağlanan Azure Service Bus ad alanına gönderenler ve alıcılar oluşturmak için kullanılabilecek 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 yournamespace.servicebus.windows.net> ile <benzer olacaktır.
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 etkin 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 iletide bir kilidi vardır. receiveAndDelete modunda iletiler alındıkça Service Bus'tan silinir. Alıcı üzerinde completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi çözebilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)	Oturum etkinleştirilmiş 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 iletide bir kilidi vardır. receiveAndDelete modunda iletiler alındıkça Service Bus'tan silinir. Alıcı üzerinde completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi çözebilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)	Oturumun etkinleştirildiği Azure Service Bus kuyruğu için bir 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 iletide bir kilidi vardır. receiveAndDelete modunda iletiler alındıkça Service Bus'tan silinir. Alıcı üzerinde completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi çözebilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)	Oturumun etkinleştirildiği Azure Service Bus aboneliği için bir 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 iletide bir kilidi vardır. receiveAndDelete modunda iletiler alındıkça Service Bus'tan silinir. Alıcı üzerinde completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi çözebilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: 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 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 aktarma kuyruğu gibi alt kuyrukları hedeflemek için seçeneklerde 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 iletide bir kilidi vardır. receiveAndDelete modunda iletiler alındıkça Service Bus'tan silinir. Kilit süresi içinde kapatılmayan iletiler, kuyrukta ayarlanan en yüksek teslim sayısı kadar yeniden teslim edilir ve daha sonra ayrı bir teslim edilemeyen ileti kuyruğuna gönderilir. Alıcı üzerinde completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi çözebilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: 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 aktarma kuyruğu gibi alt kuyrukları hedeflemek için seçeneklerde 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 iletide bir kilidi vardır. receiveAndDelete modunda iletiler alındıkça 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ı üzerinde completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi çözebilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: 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 ServiceBusRuleManager örneği oluşturur.
createSender(string, ServiceBusSenderOptions)	İleti göndermek, iletileri daha sonra gönderilecek şekilde 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 için seçenekler.

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

ServiceBusClient sınıfının, sağlanan Azure Service Bus ad alanına gönderenler ve alıcılar oluşturmak için kullanılabilecek 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 yournamespace.servicebus.windows.net> benzer olabilecek <tam ad alanı.

credential

TokenCredential | NamedKeyCredential | SASCredential

İstemci tarafından Azure Service Bus ile bağlantının kimliğini doğrulamak üzere belirteci almak için kullanılan bir kimlik bilgisi nesnesi. Kimlik bilgilerini oluşturmak için bkz. @azure/kimlik. AAD'de TokenCredential arabiriminin 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 geçirmek ve bağlantı dizesi kullanmadan SharedAccessKeyName geçirmek istiyorsanız @azure/core-auth'dan SharedAccessKey kullanın. Bu alanlar, namesırasıyla key ve AzureNamedKeyCredential alanıyla eşler. Bağlantı dizesi kullanmadan bir AzureSASCredential geçirmek istiyorsanız @azure/core-auth'dan SharedAccessSignature kullanın. Bu alan, signatureiçindeki AzureSASCredential eş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 }.
• webSocketOptions: AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırı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 yournamespace.servicebus.windows.net> ile <benzer olacaktır.

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 etkin 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 iletide bir kilidi vardır.
• receiveAndDelete modunda iletiler alındıkça Service Bus'tan silinir.

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

PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: 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ştir), oturum alıcısı oluşturma seçenekleri bulunur.

Döndürülenler

Promise<ServiceBusSessionReceiver>

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

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Oturum etkinleştirilmiş 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 iletide bir kilidi vardır.
• receiveAndDelete modunda iletiler alındıkça Service Bus'tan silinir.

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

PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: 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 adı (topicaltında).

options

ServiceBusSessionReceiverOptions

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

Döndürülenler

Promise<ServiceBusSessionReceiver>

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

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Oturumun etkinleştirildiği Azure Service Bus kuyruğu için bir 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 iletide bir kilidi vardır.
• receiveAndDelete modunda iletiler alındıkça Service Bus'tan silinir.

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

PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: 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ştir), oturum alıcısı oluşturma seçenekleri bulunur.

Döndürülenler

Promise<ServiceBusSessionReceiver>

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

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Oturumun etkinleştirildiği Azure Service Bus aboneliği için bir 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 iletide bir kilidi vardır.
• receiveAndDelete modunda iletiler alındıkça Service Bus'tan silinir.

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

PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: 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 adı (topicaltında).

sessionId

string

İletilerin alınması gereken oturumun kimliği

options

ServiceBusSessionReceiverOptions

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

Döndürülenler

Promise<ServiceBusSessionReceiver>

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

close()

Temel alınan AMQP bağlantısını kapatır. NOT: Bu, bu örnekten oluşturulan 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 aktarma kuyruğu gibi alt kuyrukları hedeflemek için seçeneklerde 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 iletide bir kilidi vardır.
• receiveAndDelete modunda iletiler alındıkça Service Bus'tan silinir.

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

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

PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: 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 geçirme seçenekleri.

Döndürülenler

ServiceBusReceiver

İletileri almak, göz atmak ve çözmek 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 aktarma kuyruğu gibi alt kuyrukları hedeflemek için seçeneklerde 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 iletide bir kilidi vardır.
• receiveAndDelete modunda iletiler alındıkça 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ı üzerinde completeMessage(), abandonMessage(), deferMessage() veya deadletterMessage() yöntemlerini çağırarak iletiyi çözebilirsiniz.

PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: 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 konusunun adı.

subscriptionName

string

Almak istediğimiz aboneliğin adı (topicaltında).

options

ServiceBusReceiverOptions

varsayılan olarak peekLock olarak belirlenmiş olan receiveMode 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 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önderilecek şekilde 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öndermek için bir kuyruğun veya konunun adı.

options

ServiceBusSenderOptions

Döndürülenler

ServiceBusSender