ServiceBusClient class

Balíček:

@azure/service-bus

Klient, který může vytvořit instance odesílatele pro odesílání zpráv do front a témat a také instance příjemce pro příjem zpráv z front a odběrů.

Konstruktory

ServiceBusClient(string, ServiceBusClientOptions)	Vytvoří instanci třídy ServiceBusClient, která se dá použít k vytvoření odesílatelů a příjemců do oboru názvů služby Azure Service Bus poskytnutého v připojovacím řetězci. Ke službě se nepřidá žádné připojení, dokud nebudou odesílatelé a příjemci vytvořená pomocí klienta použity k odesílání a přijímání zpráv.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)	Vytvoří instanci třídy ServiceBusClient, která se dá použít k vytvoření odesílatelů a příjemců do poskytnutého oboru názvů služby Azure Service Bus. Ke službě se nepřidá žádné připojení, dokud nebudou odesílatelé a příjemci vytvořená pomocí klienta použity k odesílání a přijímání zpráv.

Vlastnosti

fullyQualifiedNamespace	Plně kvalifikovaný obor názvů instance služby Service Bus, pro kterou je tento klient vytvořen. Pravděpodobně se bude podobat funkci <yournamespace.servicebus.windows.net>.
identifier	Název použitý k identifikaci tohoto serviceBusClient. Pokud není zadaný nebo prázdný, vygeneruje se náhodný jedinečný.

Metody

acceptNextSession(string, ServiceBusSessionReceiverOptions)	Vytvoří příjemce pro další dostupnou relaci ve frontě Azure Service Bus s podporou relace. Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete". V režimu peekLock má příjemce zámek zprávy po dobu trvání určenou ve frontě. V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí. Zprávu můžete vyřešit voláním metody completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na přijímači. Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)	Vytvoří příjemce pro další dostupnou relaci v předplatném Azure Service Bus s podporou relace. Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete". V režimu peekLock má příjemce zámek zprávy po dobu trvání určenou ve frontě. V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí. Zprávu můžete vyřešit voláním metody completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na přijímači. Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)	Vytvoří příjemce pro frontu Azure Service Bus s povolenou relací. Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete". V režimu peekLock má příjemce zámek zprávy po dobu trvání určenou ve frontě. V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí. Zprávu můžete vyřešit voláním metody completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na přijímači. Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)	Vytvoří příjemce pro předplatné služby Azure Service Bus s povolenou relací. Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete". V režimu peekLock má příjemce zámek zprávy po dobu trvání určenou ve frontě. V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí. Zprávu můžete vyřešit voláním metody completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na přijímači. Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()	Zavře základní připojení AMQP. POZNÁMKA: Tím se také odpojí všechny instance příjemce nebo odesílatele vytvořené z této instance.
createReceiver(string, ServiceBusReceiverOptions)	Vytvoří příjemce pro frontu služby Azure Service Bus. Ke službě není provedeno žádné připojení, dokud není volána jedna z metod příjemce. Pokud chcete cílit na dílčí fronty, jako je fronta nedoručených zpráv nebo fronta pro přenos nedoručených zpráv, zadejte subQueue v možnostech. Další informace o frontách nedoručených zpráv najdete v tématu https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete". V režimu peekLock má příjemce zámek zprávy po dobu trvání určenou ve frontě. V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí. Zprávy, které nejsou v rámci doby trvání uzamčení vyřešeny, budou znovu vydány tolikrát, kolikrát je maximální počet doručení nastavený ve frontě, po které se odešlou do samostatné fronty nedoručených zpráv. Zprávu můžete vyřešit voláním metody completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na přijímači. Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)	Vytvoří příjemce pro předplatné služby Azure Service Bus. Ke službě není provedeno žádné připojení, dokud není volána jedna z metod příjemce. Pokud chcete cílit na dílčí fronty, jako je fronta nedoručených zpráv nebo fronta pro přenos nedoručených zpráv, zadejte subQueue v možnostech. Další informace o frontách nedoručených zpráv najdete v tématu https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete". V režimu peekLock má příjemce zámek zprávy po dobu trvání určenou ve frontě. V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí. Zprávy, které nejsou v době uzamčení vyřešeny, budou znovu předány tolikrát, kolikrát je maximální počet doručení nastavený v předplatném, po kterém se odešlou do samostatné fronty nedoručených zpráv. Zprávu můžete vyřešit voláním metody completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na přijímači. Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)	Vytvoří instanci ServiceBusRuleManager, která slouží ke správě pravidel pro předplatné.
createSender(string, ServiceBusSenderOptions)	Vytvoří odesílatele, který lze použít k odesílání zpráv, naplánování odesílání zpráv později a zrušení takových naplánovaných zpráv. Ke službě není provedeno žádné připojení, dokud se nevyvolá jedna z metod odesílatele.

Podrobnosti konstruktoru

ServiceBusClient(string, ServiceBusClientOptions)

Vytvoří instanci třídy ServiceBusClient, která se dá použít k vytvoření odesílatelů a příjemců do oboru názvů služby Azure Service Bus poskytnutého v připojovacím řetězci. Ke službě se nepřidá žádné připojení, dokud nebudou odesílatelé a příjemci vytvořená pomocí klienta použity k odesílání a přijímání zpráv.

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

Parametry

connectionString

string

Připojovací řetězec pro obor názvů služby Azure Service Bus. POZNÁMKA: Tento připojovací řetězec může obsahovat EntityPath, který je ignorován.

options

ServiceBusClientOptions

Možnosti klienta služby Service Bus

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

Vytvoří instanci třídy ServiceBusClient, která se dá použít k vytvoření odesílatelů a příjemců do poskytnutého oboru názvů služby Azure Service Bus. Ke službě se nepřidá žádné připojení, dokud nebudou odesílatelé a příjemci vytvořená pomocí klienta použity k odesílání a přijímání zpráv.

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

Parametry

fullyQualifiedNamespace

string

Úplný obor názvů vaší instance služby Service Bus, který bude pravděpodobně podobný <službě yournamespace.servicebus.windows.net>.

credential

TokenCredential | NamedKeyCredential | SASCredential

Objekt přihlašovacích údajů používaný klientem k získání tokenu pro ověření připojení ke službě Azure Service Bus. Informace o vytvoření přihlašovacích údajů najdete v tématu @azure/identita. Pokud používáte vlastní implementaci TokenCredential rozhraní pro AAD, nastavte obory pro service-bus tak, aby se ["https://servicebus.azure.net//user_impersonation"] získat příslušný token. Pokud chcete předat AzureNamedKeyCredential a SharedAccessKeyName bez použití připojovacího řetězce, použijte SharedAccessKey z ověřování @azure/core-auth. Tato pole se mapují na pole name a key v AzureNamedKeyCredential. Pokud chcete předat AzureSASCredential bez použití připojovacího řetězce, použijte SharedAccessSignature z ověřování @azure/core-auth. Toto pole se mapuje na signature v AzureSASCredential.

options

ServiceBusClientOptions

Sada možností, které se mají použít při konfiguraci klienta.

• retryOptions: Nakonfiguruje zásadu opakování pro všechny operace v klientovi. Například { "maxRetries": 4 } nebo { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: Konfiguruje kanálování připojení AMQP přes webové sokety.

Podrobnosti vlastnosti

fullyQualifiedNamespace

Plně kvalifikovaný obor názvů instance služby Service Bus, pro kterou je tento klient vytvořen. Pravděpodobně se bude podobat funkci <yournamespace.servicebus.windows.net>.

fullyQualifiedNamespace: string

Hodnota vlastnosti

string

identifier

Název použitý k identifikaci tohoto serviceBusClient. Pokud není zadaný nebo prázdný, vygeneruje se náhodný jedinečný.

identifier: string

Hodnota vlastnosti

string

Podrobnosti metody

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Vytvoří příjemce pro další dostupnou relaci ve frontě Azure Service Bus s podporou relace.

Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete".

• V režimu peekLock má příjemce zámek zprávy po dobu trvání určenou ve frontě.
• V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí.

Zprávu můžete vyřešit voláním metody completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na přijímači.

Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parametry

queueName

string

Název fronty, ze které se má přijímat.

options

ServiceBusSessionReceiverOptions

Mezi možnosti patří receiveMode(výchozí hodnota pro peekLock), možnosti pro vytvoření příjemce relace.

Návraty

Promise<ServiceBusSessionReceiver>

Příjemce, který lze použít k příjmu, náhledu a vyrovnání zpráv.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Vytvoří příjemce pro další dostupnou relaci v předplatném Azure Service Bus s podporou relace.

Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete".

• V režimu peekLock má příjemce zámek zprávy po dobu trvání určenou ve frontě.
• V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí.

Zprávu můžete vyřešit voláním metody completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na přijímači.

Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parametry

topicName

string

Název tématu předplatného, od kterého chceme získat.

subscriptionName

string

Název předplatného (pod topic), od kterého chceme získat.

options

ServiceBusSessionReceiverOptions

Mezi možnosti patří receiveMode(výchozí hodnota pro peekLock), možnosti pro vytvoření příjemce relace.

Návraty

Promise<ServiceBusSessionReceiver>

Příjemce, který lze použít k příjmu, náhledu a vyrovnání zpráv.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Vytvoří příjemce pro frontu Azure Service Bus s povolenou relací.

Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete".

• V režimu peekLock má příjemce zámek zprávy po dobu trvání určenou ve frontě.
• V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí.

Zprávu můžete vyřešit voláním metody completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na přijímači.

Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parametry

queueName

string

Název fronty, ze které se má přijímat.

sessionId

string

ID relace, ze které je potřeba přijímat zprávy

options

ServiceBusSessionReceiverOptions

Mezi možnosti patří receiveMode(výchozí hodnota pro peekLock), možnosti pro vytvoření příjemce relace.

Návraty

Promise<ServiceBusSessionReceiver>

Příjemce, který lze použít k příjmu, náhledu a vyrovnání zpráv.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Vytvoří příjemce pro předplatné služby Azure Service Bus s povolenou relací.

Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete".

• V režimu peekLock má příjemce zámek zprávy po dobu trvání určenou ve frontě.
• V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí.

Zprávu můžete vyřešit voláním metody completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na přijímači.

Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: 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>

Parametry

topicName

string

Název tématu předplatného, od kterého chceme získat.

subscriptionName

string

Název předplatného (pod topic), od kterého chceme získat.

sessionId

string

ID relace, ze které je potřeba přijímat zprávy

options

ServiceBusSessionReceiverOptions

Mezi možnosti patří receiveMode(výchozí hodnota pro peekLock), možnosti pro vytvoření příjemce relace.

Návraty

Promise<ServiceBusSessionReceiver>

Příjemce, který lze použít k příjmu, náhledu a vyrovnání zpráv.

close()

Zavře základní připojení AMQP. POZNÁMKA: Tím se také odpojí všechny instance příjemce nebo odesílatele vytvořené z této instance.

function close(): Promise<void>

Návraty

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Vytvoří příjemce pro frontu služby Azure Service Bus. Ke službě není provedeno žádné připojení, dokud není volána jedna z metod příjemce.

Pokud chcete cílit na dílčí fronty, jako je fronta nedoručených zpráv nebo fronta pro přenos nedoručených zpráv, zadejte subQueue v možnostech. Další informace o frontách nedoručených zpráv najdete v tématu https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete".

• V režimu peekLock má příjemce zámek zprávy po dobu trvání určenou ve frontě.
• V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí.

Zprávy, které nejsou v rámci doby trvání uzamčení vyřešeny, budou znovu vydány tolikrát, kolikrát je maximální počet doručení nastavený ve frontě, po které se odešlou do samostatné fronty nedoručených zpráv.

Zprávu můžete vyřešit voláním metody completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na přijímači.

Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parametry

queueName

string

Název fronty, ze které se má přijímat.

options

ServiceBusReceiverOptions

Možnosti pro předání receiveMode, ve výchozím nastavení na náhledLock.

Návraty

ServiceBusReceiver

Příjemce, který lze použít k příjmu, náhledu a vyrovnání zpráv.

createReceiver(string, string, ServiceBusReceiverOptions)

Vytvoří příjemce pro předplatné služby Azure Service Bus. Ke službě není provedeno žádné připojení, dokud není volána jedna z metod příjemce.

Pokud chcete cílit na dílčí fronty, jako je fronta nedoručených zpráv nebo fronta pro přenos nedoručených zpráv, zadejte subQueue v možnostech. Další informace o frontách nedoručených zpráv najdete v tématu https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete".

• V režimu peekLock má příjemce zámek zprávy po dobu trvání určenou ve frontě.
• V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí.

Zprávy, které nejsou v době uzamčení vyřešeny, budou znovu předány tolikrát, kolikrát je maximální počet doručení nastavený v předplatném, po kterém se odešlou do samostatné fronty nedoručených zpráv.

Zprávu můžete vyřešit voláním metody completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na přijímači.

Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parametry

topicName

string

Název tématu předplatného, od kterého chceme získat.

subscriptionName

string

Název předplatného (pod topic), od kterého chceme získat.

options

ServiceBusReceiverOptions

Možnosti pro předání receiveMode, ve výchozím nastavení na náhledLock.

Návraty

ServiceBusReceiver

Příjemce, který lze použít k příjmu, náhledu a vyrovnání zpráv.

createRuleManager(string, string)

Vytvoří instanci ServiceBusRuleManager, která slouží ke správě pravidel pro předplatné.

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

Parametry

topicName

string

téma pro vytvoření ServiceBusRuleManager

subscriptionName

string

odběr specifický pro zadané téma pro vytvoření ServiceBusRuleManager pro.

Návraty

ServiceBusRuleManager

ServiceBusRuleManager vymezený na zadané předplatné a téma.

createSender(string, ServiceBusSenderOptions)

Vytvoří odesílatele, který lze použít k odesílání zpráv, naplánování odesílání zpráv později a zrušení takových naplánovaných zpráv. Ke službě není provedeno žádné připojení, dokud se nevyvolá jedna z metod odesílatele.

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

Parametry

queueOrTopicName

string

Název fronty nebo tématu pro odesílání zpráv.

options

ServiceBusSenderOptions

Návraty

ServiceBusSender