ServiceBusClient class

Csomag:

@azure/service-bus

Olyan ügyfél, amely képes feladópéldányokat létrehozni az üzenetsorokra és témakörökre, valamint fogadópéldányokra az üzenetsorokból és előfizetésekből érkező üzenetek fogadásához.

Konstruktorok

ServiceBusClient(string, ServiceBusClientOptions)	Létrehozza a ServiceBusClient osztály egy példányát, amely a kapcsolati sztringben megadott Azure Service Bus-névtér küldőinek és fogadóinak létrehozására használható. Nem jön létre kapcsolat a szolgáltatással, amíg az ügyféllel létrehozott küldőket/fogadókat nem használják az üzenetek küldésére/fogadására.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)	Létrehozza a ServiceBusClient osztály egy példányát, amely segítségével küldőket és fogadókat hozhat létre a megadott Azure Service Bus-névtérben. Nem jön létre kapcsolat a szolgáltatással, amíg az ügyféllel létrehozott küldőket/fogadókat nem használják az üzenetek küldésére/fogadására.

Tulajdonságok

fullyQualifiedNamespace	Annak a Service Bus-példánynak a teljes névtere, amelyhez az ügyfél létre van hozva. Ez valószínűleg hasonló lesz a yournamespace.servicebus.windows.net> értékhez<.
identifier	A ServiceBusClient azonosításához használt név. Ha nincs megadva vagy üres, a rendszer létrehoz egy véletlenszerű egyedit.

Metódusok

acceptNextSession(string, ServiceBusSessionReceiverOptions)	Létrehoz egy fogadót a munkamenet-kompatibilis Azure Service Bus-üzenetsor következő elérhető munkamenetéhez. Két fogadási mód közül választhat: "peekLock" (alapértelmezett) és "receiveAndDelete". PeekLock módban a fogadó zárolva van az üzeneten az üzenetsorban megadott időtartamra. A receiveAndDelete módban az üzenetek a fogadásuk során törlődnek a Service Busból. Az üzeneteket úgy rendezheti ki, hogy meghívja completeMessage(), abandonMessage(), deferMessage() vagy deadletterMessage() metódusokat a fogadón. További információ a peekLock és az üzenetegyenlítés működéséről: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)	Létrehoz egy fogadót a munkamenet-kompatibilis Azure Service Bus-előfizetés következő elérhető munkamenetéhez. Két fogadási mód közül választhat: "peekLock" (alapértelmezett) és "receiveAndDelete". PeekLock módban a fogadó zárolva van az üzeneten az üzenetsorban megadott időtartamra. A receiveAndDelete módban az üzenetek a fogadásuk során törlődnek a Service Busból. Az üzeneteket úgy rendezheti ki, hogy meghívja completeMessage(), abandonMessage(), deferMessage() vagy deadletterMessage() metódusokat a fogadón. További információ a peekLock és az üzenetegyenlítés működéséről: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)	Létrehoz egy fogadót egy munkamenet-kompatibilis Azure Service Bus-üzenetsorhoz. Két fogadási mód közül választhat: "peekLock" (alapértelmezett) és "receiveAndDelete". PeekLock módban a fogadó zárolva van az üzeneten az üzenetsorban megadott időtartamra. A receiveAndDelete módban az üzenetek a fogadásuk során törlődnek a Service Busból. Az üzeneteket úgy rendezheti ki, hogy meghívja completeMessage(), abandonMessage(), deferMessage() vagy deadletterMessage() metódusokat a fogadón. További információ a peekLock és az üzenetegyenlítés működéséről: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)	Létrehoz egy fogadót egy munkamenet-kompatibilis Azure Service Bus-előfizetéshez. Két fogadási mód közül választhat: "peekLock" (alapértelmezett) és "receiveAndDelete". PeekLock módban a fogadó zárolva van az üzeneten az üzenetsorban megadott időtartamra. A receiveAndDelete módban az üzenetek a fogadásuk során törlődnek a Service Busból. Az üzeneteket úgy rendezheti ki, hogy meghívja completeMessage(), abandonMessage(), deferMessage() vagy deadletterMessage() metódusokat a fogadón. További információ a peekLock és az üzenetegyenlítés működéséről: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()	Bezárja a mögöttes AMQP-kapcsolatot. MEGJEGYZÉS: ez leválasztja az ebből a példányból létrehozott Receiver vagy Sender példányokat is.
createReceiver(string, ServiceBusReceiverOptions)	Létrehoz egy fogadót egy Azure Service Bus-üzenetsorhoz. A szolgáltatás csak akkor jön létre, ha a vevő egyik metódusát hívják meg. Az alvárólisták, például a kézbesítetlen levelek várólistája vagy a kézbesítetlen levelek átviteli várólistája megcélzásához adja meg a subQueue beállításokat. A kézbesítetlen levelek üzenetsorairól további információt a https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues Két fogadási mód közül választhat: "peekLock" (alapértelmezett) és "receiveAndDelete". PeekLock módban a fogadó zárolva van az üzeneten az üzenetsorban megadott időtartamra. A receiveAndDelete módban az üzenetek a fogadásuk során törlődnek a Service Busból. A zárolási időtartamon belül nem rendezett üzeneteket a rendszer a várólistán beállított maximális kézbesítési szám után küldi el őket egy külön kézbesítetlen levelek várólistájába. Az üzeneteket úgy rendezheti ki, hogy meghívja completeMessage(), abandonMessage(), deferMessage() vagy deadletterMessage() metódusokat a fogadón. További információ a peekLock és az üzenetegyenlítés működéséről: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)	Létrehoz egy fogadót egy Azure Service Bus-előfizetéshez. A szolgáltatás csak akkor jön létre, ha a vevő egyik metódusát hívják meg. Az alvárólisták, például a kézbesítetlen levelek várólistája vagy a kézbesítetlen levelek átviteli várólistája megcélzásához adja meg a subQueue beállításokat. A kézbesítetlen levelek üzenetsorairól további információt a https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues Két fogadási mód közül választhat: "peekLock" (alapértelmezett) és "receiveAndDelete". PeekLock módban a fogadó zárolva van az üzeneten az üzenetsorban megadott időtartamra. A receiveAndDelete módban az üzenetek a fogadásuk során törlődnek a Service Busból. A zárolási időtartamon belül nem rendezett üzeneteket a rendszer az előfizetésben beállított maximális kézbesítési számmal együtt kézbesíti újra, majd egy külön kézbesítetlen levelek várólistájába küldi őket. Az üzeneteket úgy rendezheti ki, hogy meghívja completeMessage(), abandonMessage(), deferMessage() vagy deadletterMessage() metódusokat a fogadón. További információ a peekLock és az üzenetegyenlítés működéséről: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)	Létrehoz egy ServiceBusRuleManager-példányt , amely egy előfizetés szabályainak kezelésére szolgál.
createSender(string, ServiceBusSenderOptions)	Létrehoz egy feladót, amely üzenetek küldésére, későbbi küldésre ütemezhető és az ütemezett üzenetek törlésére használható. A szolgáltatás csak akkor jön létre, ha a küldő egyik metódusát hívja meg.

Konstruktor adatai

ServiceBusClient(string, ServiceBusClientOptions)

Létrehozza a ServiceBusClient osztály egy példányát, amely a kapcsolati sztringben megadott Azure Service Bus-névtér küldőinek és fogadóinak létrehozására használható. Nem jön létre kapcsolat a szolgáltatással, amíg az ügyféllel létrehozott küldőket/fogadókat nem használják az üzenetek küldésére/fogadására.

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

Paraméterek

connectionString

string

Kapcsolati sztring az Azure Service Bus névtérhez. MEGJEGYZÉS: ez a kapcsolati sztring tartalmazhat egy EntityPath-ot, amelyet a rendszer figyelmen kívül hagy.

options

ServiceBusClientOptions

A Service Bus-ügyfél beállításai.

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

Létrehozza a ServiceBusClient osztály egy példányát, amely segítségével küldőket és fogadókat hozhat létre a megadott Azure Service Bus-névtérben. Nem jön létre kapcsolat a szolgáltatással, amíg az ügyféllel létrehozott küldőket/fogadókat nem használják az üzenetek küldésére/fogadására.

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

Paraméterek

fullyQualifiedNamespace

string

A Service Bus-példány teljes névtere, amely valószínűleg hasonló a yournamespace.servicebus.windows.net <névtérhez>.

credential

TokenCredential | NamedKeyCredential | SASCredential

Egy hitelesítő objektum, amellyel az ügyfél lekérheti a jogkivonatot az Azure Service Bus-kapcsolat hitelesítéséhez. A hitelesítő adatok létrehozásához tekintse meg a @azure/identitást. Ha a TokenCredential felület saját implementációját használja az AAD-n, állítsa be a service-bus ["https://servicebus.azure.net//user_impersonation"] "hatókörét" a megfelelő jogkivonat lekéréséhez. A @azure/core-auth AzureNamedKeyCredential akkor használja, ha kapcsolati sztring használata nélkül szeretne átadni egy SharedAccessKeyName és SharedAccessKey. Ezek a mezők a namekey és AzureNamedKeyCredential mezőjére vannak megfeleltetve. Ha kapcsolati sztring használata nélkül szeretne átadni egy AzureSASCredential, használja a SharedAccessSignature @azure/core-hitelesítésből. Ez a mező signatureAzureSASCredential képez le.

options

ServiceBusClientOptions

Az ügyfél konfigurálásakor alkalmazandó beállítások készlete.

• retryOptions: Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például, { "maxRetries": 4 } vagy { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.

Tulajdonság adatai

fullyQualifiedNamespace

Annak a Service Bus-példánynak a teljes névtere, amelyhez az ügyfél létre van hozva. Ez valószínűleg hasonló lesz a yournamespace.servicebus.windows.net> értékhez<.

fullyQualifiedNamespace: string

Tulajdonság értéke

string

identifier

A ServiceBusClient azonosításához használt név. Ha nincs megadva vagy üres, a rendszer létrehoz egy véletlenszerű egyedit.

identifier: string

Tulajdonság értéke

string

Metódus adatai

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Létrehoz egy fogadót a munkamenet-kompatibilis Azure Service Bus-üzenetsor következő elérhető munkamenetéhez.

Két fogadási mód közül választhat: "peekLock" (alapértelmezett) és "receiveAndDelete".

• PeekLock módban a fogadó zárolva van az üzeneten az üzenetsorban megadott időtartamra.
• A receiveAndDelete módban az üzenetek a fogadásuk során törlődnek a Service Busból.

Az üzeneteket úgy rendezheti ki, hogy meghívja completeMessage(), abandonMessage(), deferMessage() vagy deadletterMessage() metódusokat a fogadón.

További információ a peekLock és az üzenetegyenlítés működéséről: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Paraméterek

queueName

string

Annak a várólistának a neve, amelyből fogadni szeretné.

options

ServiceBusSessionReceiverOptions

A lehetőségek közé tartozik a receiveMode(alapértelmezés szerint peekLock), a munkamenet-fogadó létrehozásának lehetőségei.

Válaszok

Promise<ServiceBusSessionReceiver>

Fogadó, amely üzenetek fogadására, betekintésére és rendezésére használható.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Létrehoz egy fogadót a munkamenet-kompatibilis Azure Service Bus-előfizetés következő elérhető munkamenetéhez.

Két fogadási mód közül választhat: "peekLock" (alapértelmezett) és "receiveAndDelete".

• PeekLock módban a fogadó zárolva van az üzeneten az üzenetsorban megadott időtartamra.
• A receiveAndDelete módban az üzenetek a fogadásuk során törlődnek a Service Busból.

Az üzeneteket úgy rendezheti ki, hogy meghívja completeMessage(), abandonMessage(), deferMessage() vagy deadletterMessage() metódusokat a fogadón.

További információ a peekLock és az üzenetegyenlítés működéséről: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Paraméterek

topicName

string

Az előfizetés témakörének neve, amelyből fogadni szeretnénk.

subscriptionName

string

Annak az előfizetésnek a neve (a topic) alatt, amelyből kapni szeretnénk.

options

ServiceBusSessionReceiverOptions

A lehetőségek közé tartozik a receiveMode(alapértelmezés szerint peekLock), a munkamenet-fogadó létrehozásának lehetőségei.

Válaszok

Promise<ServiceBusSessionReceiver>

Fogadó, amely üzenetek fogadására, betekintésére és rendezésére használható.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Létrehoz egy fogadót egy munkamenet-kompatibilis Azure Service Bus-üzenetsorhoz.

Két fogadási mód közül választhat: "peekLock" (alapértelmezett) és "receiveAndDelete".

• PeekLock módban a fogadó zárolva van az üzeneten az üzenetsorban megadott időtartamra.
• A receiveAndDelete módban az üzenetek a fogadásuk során törlődnek a Service Busból.

Az üzeneteket úgy rendezheti ki, hogy meghívja completeMessage(), abandonMessage(), deferMessage() vagy deadletterMessage() metódusokat a fogadón.

További információ a peekLock és az üzenetegyenlítés működéséről: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Paraméterek

queueName

string

Annak a várólistának a neve, amelyből fogadni szeretné.

sessionId

string

Annak a munkamenetnek az azonosítója, amelyből üzeneteket kell fogadni

options

ServiceBusSessionReceiverOptions

A lehetőségek közé tartozik a receiveMode(alapértelmezés szerint peekLock), a munkamenet-fogadó létrehozásának lehetőségei.

Válaszok

Promise<ServiceBusSessionReceiver>

Fogadó, amely üzenetek fogadására, betekintésére és rendezésére használható.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Létrehoz egy fogadót egy munkamenet-kompatibilis Azure Service Bus-előfizetéshez.

Két fogadási mód közül választhat: "peekLock" (alapértelmezett) és "receiveAndDelete".

• PeekLock módban a fogadó zárolva van az üzeneten az üzenetsorban megadott időtartamra.
• A receiveAndDelete módban az üzenetek a fogadásuk során törlődnek a Service Busból.

Az üzeneteket úgy rendezheti ki, hogy meghívja completeMessage(), abandonMessage(), deferMessage() vagy deadletterMessage() metódusokat a fogadón.

További információ a peekLock és az üzenetegyenlítés működéséről: 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>

Paraméterek

topicName

string

Az előfizetés témakörének neve, amelyből fogadni szeretnénk.

subscriptionName

string

Annak az előfizetésnek a neve (a topic) alatt, amelyből kapni szeretnénk.

sessionId

string

Annak a munkamenetnek az azonosítója, amelyből üzeneteket kell fogadni

options

ServiceBusSessionReceiverOptions

A lehetőségek közé tartozik a receiveMode(alapértelmezés szerint peekLock), a munkamenet-fogadó létrehozásának lehetőségei.

Válaszok

Promise<ServiceBusSessionReceiver>

Fogadó, amely üzenetek fogadására, betekintésére és rendezésére használható.

close()

Bezárja a mögöttes AMQP-kapcsolatot. MEGJEGYZÉS: ez leválasztja az ebből a példányból létrehozott Receiver vagy Sender példányokat is.

function close(): Promise<void>

Válaszok

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Létrehoz egy fogadót egy Azure Service Bus-üzenetsorhoz. A szolgáltatás csak akkor jön létre, ha a vevő egyik metódusát hívják meg.

Az alvárólisták, például a kézbesítetlen levelek várólistája vagy a kézbesítetlen levelek átviteli várólistája megcélzásához adja meg a subQueue beállításokat. A kézbesítetlen levelek üzenetsorairól további információt a https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Két fogadási mód közül választhat: "peekLock" (alapértelmezett) és "receiveAndDelete".

• PeekLock módban a fogadó zárolva van az üzeneten az üzenetsorban megadott időtartamra.
• A receiveAndDelete módban az üzenetek a fogadásuk során törlődnek a Service Busból.

A zárolási időtartamon belül nem rendezett üzeneteket a rendszer a várólistán beállított maximális kézbesítési szám után küldi el őket egy külön kézbesítetlen levelek várólistájába.

Az üzeneteket úgy rendezheti ki, hogy meghívja completeMessage(), abandonMessage(), deferMessage() vagy deadletterMessage() metódusokat a fogadón.

További információ a peekLock és az üzenetegyenlítés működéséről: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Paraméterek

queueName

string

Annak a várólistának a neve, amelyből fogadni szeretné.

options

ServiceBusReceiverOptions

A receiveMode átadásának beállításai, alapértelmezés szerint a peekLock.

Válaszok

ServiceBusReceiver

Fogadó, amely üzenetek fogadására, betekintésére és rendezésére használható.

createReceiver(string, string, ServiceBusReceiverOptions)

Létrehoz egy fogadót egy Azure Service Bus-előfizetéshez. A szolgáltatás csak akkor jön létre, ha a vevő egyik metódusát hívják meg.

Az alvárólisták, például a kézbesítetlen levelek várólistája vagy a kézbesítetlen levelek átviteli várólistája megcélzásához adja meg a subQueue beállításokat. A kézbesítetlen levelek üzenetsorairól további információt a https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Két fogadási mód közül választhat: "peekLock" (alapértelmezett) és "receiveAndDelete".

• PeekLock módban a fogadó zárolva van az üzeneten az üzenetsorban megadott időtartamra.
• A receiveAndDelete módban az üzenetek a fogadásuk során törlődnek a Service Busból.

A zárolási időtartamon belül nem rendezett üzeneteket a rendszer az előfizetésben beállított maximális kézbesítési számmal együtt kézbesíti újra, majd egy külön kézbesítetlen levelek várólistájába küldi őket.

Az üzeneteket úgy rendezheti ki, hogy meghívja completeMessage(), abandonMessage(), deferMessage() vagy deadletterMessage() metódusokat a fogadón.

További információ a peekLock és az üzenetegyenlítés működéséről: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Paraméterek

topicName

string

Az előfizetés témakörének neve, amelyből fogadni szeretnénk.

subscriptionName

string

Annak az előfizetésnek a neve (a topic) alatt, amelyből kapni szeretnénk.

options

ServiceBusReceiverOptions

A receiveMode átadásának beállításai, alapértelmezés szerint a peekLock.

Válaszok

ServiceBusReceiver

Fogadó, amely üzenetek fogadására, betekintésére és rendezésére használható.

createRuleManager(string, string)

Létrehoz egy ServiceBusRuleManager-példányt , amely egy előfizetés szabályainak kezelésére szolgál.

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

Paraméterek

topicName

string

a ServiceBusRuleManager létrehozásának témaköre

subscriptionName

string

a megadott témakörre jellemző előfizetés, amelyhez ServiceBusRuleManagert szeretne létrehozni.

Válaszok

ServiceBusRuleManager

egy ServiceBusRuleManager, amely a megadott előfizetésre és témakörre terjed ki.

createSender(string, ServiceBusSenderOptions)

Létrehoz egy feladót, amely üzenetek küldésére, későbbi küldésre ütemezhető és az ütemezett üzenetek törlésére használható. A szolgáltatás csak akkor jön létre, ha a küldő egyik metódusát hívja meg.

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

Paraméterek

queueOrTopicName

string

Annak a várólistának vagy témakörnek a neve, amelybe üzeneteket szeretne küldeni.

options

ServiceBusSenderOptions

Válaszok

ServiceBusSender