ServiceBusClient class

Balíček:

@azure/service-bus

Klient, který může vytvářet 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ů Azure Service Bus zadaného v připojovacím řetězci. Ke službě není vytvořeno žádné připojení, dokud se odesílatelé nebo příjemci vytvořené pomocí klienta nepoužívají 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 zadaného oboru názvů Azure Service Bus. Ke službě není vytvořeno žádné připojení, dokud se odesílatelé nebo příjemci vytvořené pomocí klienta nepoužívají 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. Je pravděpodobné, že se bude podobat .servicebus.windows.net.
identifier	Název použitý k identifikaci tohoto ServiceBusClient. Pokud není zadán 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 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 u zprávy zámek po dobu uvedenou ve frontě. V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí. Zprávu můžete vyřešit voláním metod completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na příjemci. Další informace o tom, jak funguje 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 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 u zprávy zámek po dobu uvedenou ve frontě. V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí. Zprávu můžete vyřešit voláním metod completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na příjemci. Další informace o tom, jak funguje 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 relaci povolenou Azure Service Bus frontě. Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete". V režimu peekLock má příjemce u zprávy zámek po dobu uvedenou ve frontě. V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí. Zprávu můžete vyřešit voláním metod completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na příjemci. Další informace o tom, jak funguje 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 relaci povolenou Azure Service Bus předplatného. Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete". V režimu peekLock má příjemce u zprávy zámek po dobu uvedenou ve frontě. V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí. Zprávu můžete vyřešit voláním metod completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na příjemci. Další informace o tom, jak funguje peekLock a vypořádání zpráv, najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()	Ukončí základní připojení AMQP. POZNÁMKA: Tím se také odpojí všechny instance Receiver nebo Sender vytvořené z této instance.
createReceiver(string, ServiceBusReceiverOptions)	Vytvoří příjemce pro frontu Azure Service Bus. Ke službě se nesvedou žádné připojení, dokud není volána jedna z metod na přijímači. Pokud chcete cílit na dílčí fronty, jako je fronta nedoručených zpráv nebo fronta nedoručených zpráv přenosu, zadejte subQueue v možnostech hodnotu . 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 u zprávy zámek po dobu uvedenou ve frontě. V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí. Zprávy, které nejsou vyřešené v rámci doby trvání zámku, se znovu vrátí tolikrát, kolikrát je nastavený maximální počet doručení ve frontě, a potom se odešlou do samostatné fronty nedoručených zpráv. Zprávu můžete vyřešit voláním metod completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na příjemci. Další informace o tom, jak funguje 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é Azure Service Bus. Ke službě se nesvedou žádné připojení, dokud není volána jedna z metod na přijímači. Pokud chcete cílit na dílčí fronty, jako je fronta nedoručených zpráv nebo fronta nedoručených zpráv přenosu, zadejte subQueue v možnostech hodnotu . 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 u zprávy zámek po dobu uvedenou ve frontě. V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí. Zprávy, které nejsou vyřešené v rámci doby trvání zámku, se znovu vrátí tolikrát, kolikrát je nastavený maximální počet doručení v předplatném, a potom se odešlou do samostatné fronty nedoručených zpráv. Zprávu můžete vyřešit voláním metod completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na příjemci. Další informace o tom, jak funguje 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á se používá ke správě pravidel pro předplatné.
createSender(string, ServiceBusSenderOptions)	Vytvoří odesílatele, který lze použít k odesílání zpráv, plánování odesílání zpráv na později a zrušení takových naplánovaných zpráv. Ke službě se nenasadí žádné připojení, dokud není volána 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ů Azure Service Bus zadaného v připojovacím řetězci. Ke službě není vytvořeno žádné připojení, dokud se odesílatelé nebo příjemci vytvořené pomocí klienta nepoužívají 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ů Azure Service Bus. POZNÁMKA: Tento připojovací řetězec může obsahovat EntityPath, která je ignorována.

options

ServiceBusClientOptions

Možnosti pro 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 zadaného oboru názvů Azure Service Bus. Ke službě není vytvořeno žádné připojení, dokud se odesílatelé nebo příjemci vytvořené pomocí klienta nepoužívají 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ý se bude pravděpodobně podobat .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í k Azure Service Bus. Informace o vytvoření přihlašovacích údajů najdete v tématu @azure/identity. Pokud používáte vlastní implementaci TokenCredential rozhraní pro AAD, nastavte obory pro service-bus tak, aby ["https://servicebus.azure.net//user_impersonation"] získaly příslušný token. AzureNamedKeyCredential Pokud chcete předat SharedAccessKeyName a SharedAccessKey bez použití připojovacího řetězce, použijte @azure/core-auth. Tato pole se mapují na name pole a key v AzureNamedKeyCredential. AzureSASCredential Pokud chcete předat SharedAccessSignature soubor bez použití připojovacího řetězce, použijte příkaz from @azure/core-auth. Toto pole se mapuje na signature v AzureSASCredential.

options

ServiceBusClientOptions

Možnosti pro klienta služby Service Bus

Podrobnosti vlastnosti

fullyQualifiedNamespace

Plně kvalifikovaný obor názvů instance služby Service Bus, pro kterou je tento klient vytvořen. Je pravděpodobné, že se bude podobat .servicebus.windows.net.

fullyQualifiedNamespace: string

Hodnota vlastnosti

string

identifier

Název použitý k identifikaci tohoto ServiceBusClient. Pokud není zadán 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 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 u zprávy zámek po dobu uvedenou ve frontě.
• V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí.

Zprávu můžete vyřešit voláním metod completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na příjemci.

Další informace o tom, jak funguje 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é chcete přijímat.

options

ServiceBusSessionReceiverOptions

Mezi možnosti patří receiveMode (ve výchozím nastavení peekLock) a 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 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 u zprávy zámek po dobu uvedenou ve frontě.
• V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí.

Zprávu můžete vyřešit voláním metod completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na příjemci.

Další informace o tom, jak funguje 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, ze kterého chceme získat informace.

subscriptionName

string

Název předplatného (v části topic), ze kterého chceme získat.

options

ServiceBusSessionReceiverOptions

Mezi možnosti patří receiveMode (ve výchozím nastavení peekLock) a 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 relaci povolenou Azure Service Bus frontě. Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete".

• V režimu peekLock má příjemce u zprávy zámek po dobu uvedenou ve frontě.
• V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí.

Zprávu můžete vyřešit voláním metod completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na příjemci.

Další informace o tom, jak funguje 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é chcete přijímat.

sessionId

string

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

options

ServiceBusSessionReceiverOptions

Mezi možnosti patří receiveMode (ve výchozím nastavení peekLock) a 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 relaci povolenou Azure Service Bus předplatného. Můžete si vybrat mezi dvěma režimy příjmu: "peekLock" (výchozí) a "receiveAndDelete".

• V režimu peekLock má příjemce u zprávy zámek po dobu uvedenou ve frontě.
• V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí.

Zprávu můžete vyřešit voláním metod completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na příjemci.

Další informace o tom, jak funguje 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, ze kterého chceme získat informace.

subscriptionName

string

Název předplatného (v části topic), ze 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 (ve výchozím nastavení peekLock) a 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()

Ukončí základní připojení AMQP. POZNÁMKA: Tím se také odpojí všechny instance Receiver nebo Sender vytvořené z této instance.

function close(): Promise<void>

Návraty

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Vytvoří příjemce pro frontu Azure Service Bus. Ke službě se nesvedou žádné připojení, dokud není volána jedna z metod na přijímači. Pokud chcete cílit na dílčí fronty, jako je fronta nedoručených zpráv nebo fronta nedoručených zpráv přenosu, zadejte subQueue v možnostech hodnotu . 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 u zprávy zámek po dobu uvedenou ve frontě.
• V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí.

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

Zprávu můžete vyřešit voláním metod completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na příjemci.

Další informace o tom, jak funguje 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é chcete přijímat.

options

ServiceBusReceiverOptions

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

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é Azure Service Bus. Ke službě se nesvedou žádné připojení, dokud není volána jedna z metod na přijímači. Pokud chcete cílit na dílčí fronty, jako je fronta nedoručených zpráv nebo fronta nedoručených zpráv přenosu, zadejte subQueue v možnostech hodnotu . 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 u zprávy zámek po dobu uvedenou ve frontě.
• V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí.

Zprávy, které nejsou vyřešené v rámci doby trvání zámku, se znovu vrátí tolikrát, kolikrát je nastavený maximální počet doručení v předplatném, a potom se odešlou do samostatné fronty nedoručených zpráv.

Zprávu můžete vyřešit voláním metod completeMessage(), abandonMessage(), deferMessage() nebo deadletterMessage() na příjemci.

Další informace o tom, jak funguje 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, ze kterého chceme získat informace.

subscriptionName

string

Název předplatného (v části topic), ze kterého chceme získat.

options

ServiceBusReceiverOptions

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

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á se používá ke správě pravidel pro předplatné.

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

Parametry

topicName

string

téma, které chcete vytvořit ServiceBusRuleManager

subscriptionName

string

předplatné specifické pro zadané téma, které se má ServiceBusRuleManager vytvořit pro.

Návraty

ServiceBusRuleManager

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

createSender(string, ServiceBusSenderOptions)

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

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

Parametry

queueOrTopicName

string

Název fronty nebo tématu, do které se mají odesílat zprávy.

options

ServiceBusSenderOptions

Návraty

ServiceBusSender