ServiceBusClient class

Pakket:

@azure/service-bus

Een client die afzenderexemplaren kan maken voor het verzenden van berichten naar wachtrijen en onderwerpen, evenals ontvangersexemplaren om berichten van wachtrijen en abonnementen te ontvangen.

Constructors

ServiceBusClient(string, ServiceBusClientOptions)	Hiermee maakt u een exemplaar van de klasse ServiceBusClient die kan worden gebruikt om afzenders en ontvangers te maken voor de Azure Service Bus naamruimte die is opgegeven in de connection string. Er wordt geen verbinding met de service gemaakt totdat de afzenders/ontvangers die met de client zijn gemaakt, worden gebruikt om berichten te verzenden/ontvangen.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)	Hiermee maakt u een exemplaar van de ServiceBusClient-klasse die kan worden gebruikt om afzenders en ontvangers te maken voor de Azure Service Bus opgegeven naamruimte. Er wordt geen verbinding met de service gemaakt totdat de afzenders/ontvangers die met de client zijn gemaakt, worden gebruikt om berichten te verzenden/ontvangen.

Eigenschappen

fullyQualifiedNamespace	De volledig gekwalificeerde naamruimte van het Service Bus-exemplaar waarvoor deze client is gemaakt. Dit is waarschijnlijk vergelijkbaar met .servicebus.windows.net.
identifier	De naam die wordt gebruikt om deze ServiceBusClient te identificeren. Als dit niet is opgegeven of leeg is, wordt er een willekeurige unieke gegenereerd.

Methoden

acceptNextSession(string, ServiceBusSessionReceiverOptions)	Hiermee maakt u een ontvanger voor de volgende beschikbare sessie in een Azure Service Bus wachtrij met sessiemogelijkheden. U kunt kiezen tussen twee ontvangstmodi: 'peekLock' (standaard) en 'receiveAndDelete'. In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij. In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen. U kunt een bericht vereffenen door de methoden completeMessage(), abandonMessage(), deferMessage() of deadletterMessage() aan te roepen op de ontvanger. Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)	Hiermee maakt u een ontvanger voor de volgende beschikbare sessie in een Azure Service Bus-abonnement waarvoor een sessie is ingeschakeld. U kunt kiezen tussen twee ontvangstmodi: 'peekLock' (standaard) en 'receiveAndDelete'. In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij. In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen. U kunt een bericht vereffenen door de methoden completeMessage(), abandonMessage(), deferMessage() of deadletterMessage() aan te roepen op de ontvanger. Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)	Hiermee maakt u een ontvanger voor een sessie die is ingeschakeld Azure Service Bus wachtrij. U kunt kiezen tussen twee ontvangstmodi: 'peekLock' (standaard) en 'receiveAndDelete'. In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij. In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen. U kunt een bericht vereffenen door de methoden completeMessage(), abandonMessage(), deferMessage() of deadletterMessage() aan te roepen op de ontvanger. Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)	Hiermee maakt u een ontvanger voor een sessie die is ingeschakeld Azure Service Bus abonnement. U kunt kiezen tussen twee ontvangstmodi: 'peekLock' (standaard) en 'receiveAndDelete'. In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij. In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen. U kunt een bericht vereffenen door de methoden completeMessage(), abandonMessage(), deferMessage() of deadletterMessage() aan te roepen op de ontvanger. Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()	Hiermee wordt de onderliggende AMQP-verbinding gesloten. OPMERKING: hiermee wordt ook de verbinding verbroken van alle instanties van de ontvanger of afzender die op basis van dit exemplaar zijn gemaakt.
createReceiver(string, ServiceBusReceiverOptions)	Hiermee maakt u een ontvanger voor een Azure Service Bus wachtrij. Er wordt geen verbinding gemaakt met de service totdat een van de methoden op de ontvanger wordt aangeroepen. Als u subwachtrijen wilt targeten, zoals de wachtrij met onbestelbare berichten of de wachtrij voor overdracht van onbestelbare berichten, geeft u de subQueue op in de opties. Zie voor meer informatie over wachtrijen voor onbestelbare berichten https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues U kunt kiezen tussen twee ontvangstmodi: 'peekLock' (standaard) en 'receiveAndDelete'. In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij. In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen. Berichten die niet binnen de vergrendelingsduur zijn vereffend, worden net zo vaak opnieuw bezorgd als het maximale aantal bezorgingen dat is ingesteld voor de wachtrij, waarna ze naar een afzonderlijke wachtrij met onbestelbare berichten worden verzonden. U kunt een bericht vereffenen door de methoden completeMessage(), abandonMessage(), deferMessage() of deadletterMessage() aan te roepen op de ontvanger. Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)	Hiermee maakt u een ontvanger voor een Azure Service Bus-abonnement. Er wordt geen verbinding gemaakt met de service totdat een van de methoden op de ontvanger wordt aangeroepen. Als u subwachtrijen wilt targeten, zoals de wachtrij met onbestelbare berichten of de wachtrij voor overdracht van onbestelbare berichten, geeft u de subQueue op in de opties. Zie voor meer informatie over wachtrijen voor onbestelbare berichten https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues U kunt kiezen tussen twee ontvangstmodi: 'peekLock' (standaard) en 'receiveAndDelete'. In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij. In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen. Berichten die niet binnen de vergrendelingsduur zijn vereffend, worden net zo vaak opnieuw bezorgd als het maximale aantal bezorgingen dat is ingesteld voor het abonnement, waarna ze naar een afzonderlijke wachtrij met onbestelbare berichten worden verzonden. U kunt een bericht vereffenen door de methoden completeMessage(), abandonMessage(), deferMessage() of deadletterMessage() aan te roepen op de ontvanger. Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)	Hiermee maakt u een exemplaar van ServiceBusRuleManager dat wordt gebruikt voor het beheren van de regels voor een abonnement.
createSender(string, ServiceBusSenderOptions)	Hiermee maakt u een afzender die kan worden gebruikt om berichten te verzenden, te plannen dat berichten op een later tijdstip worden verzonden en dergelijke geplande berichten te annuleren. Er wordt geen verbinding gemaakt met de service totdat een van de methoden op de afzender wordt aangeroepen.

Constructordetails

ServiceBusClient(string, ServiceBusClientOptions)

Hiermee maakt u een exemplaar van de klasse ServiceBusClient die kan worden gebruikt om afzenders en ontvangers te maken voor de Azure Service Bus naamruimte die is opgegeven in de connection string. Er wordt geen verbinding met de service gemaakt totdat de afzenders/ontvangers die met de client zijn gemaakt, worden gebruikt om berichten te verzenden/ontvangen.

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

Parameters

connectionString

string

Een connection string voor Azure Service Bus naamruimte. OPMERKING: deze connection string kan een EntityPath bevatten, dat wordt genegeerd.

options

ServiceBusClientOptions

Opties voor de Service Bus-client.

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

Hiermee maakt u een exemplaar van de ServiceBusClient-klasse die kan worden gebruikt om afzenders en ontvangers te maken voor de Azure Service Bus opgegeven naamruimte. Er wordt geen verbinding met de service gemaakt totdat de afzenders/ontvangers die met de client zijn gemaakt, worden gebruikt om berichten te verzenden/ontvangen.

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

Parameters

fullyQualifiedNamespace

string

De volledige naamruimte van uw Service Bus-exemplaar die waarschijnlijk vergelijkbaar is met .servicebus.windows.net.

credential

TokenCredential | NamedKeyCredential | SASCredential

Een referentieobject dat door de client wordt gebruikt om het token op te halen om de verbinding met de Azure Service Bus te verifiëren. Zie @azure/identity voor het maken van de referenties. Als u een eigen implementatie van de TokenCredential interface tegen AAD gebruikt, stelt u de 'bereiken' voor Service Bus in op ["https://servicebus.azure.net//user_impersonation"] om het juiste token op te halen. Gebruik de AzureNamedKeyCredential from @azure/core-auth als u een SharedAccessKeyName en SharedAccessKey wilt doorgeven zonder een connection string te gebruiken. Deze velden worden respectievelijk toegewezen aan het name veld en key in AzureNamedKeyCredential. Gebruik de AzureSASCredential van @azure/core-auth als u een SharedAccessSignature wilt doorgeven zonder een connection string te gebruiken. Dit veld wordt toegewezen aan signature in AzureSASCredential.

options

ServiceBusClientOptions

Een reeks opties die moeten worden toegepast bij het configureren van de client.

• retryOptions : hiermee configureert u het beleid voor opnieuw proberen voor alle bewerkingen op de client. Bijvoorbeeld { "maxRetries": 4 } of { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: hiermee configureert u de channeling van de AMQP-verbinding via Web Sockets.

Eigenschapdetails

fullyQualifiedNamespace

De volledig gekwalificeerde naamruimte van het Service Bus-exemplaar waarvoor deze client is gemaakt. Dit is waarschijnlijk vergelijkbaar met .servicebus.windows.net.

fullyQualifiedNamespace: string

Waarde van eigenschap

string

identifier

De naam die wordt gebruikt om deze ServiceBusClient te identificeren. Als dit niet is opgegeven of leeg is, wordt er een willekeurige unieke gegenereerd.

identifier: string

Waarde van eigenschap

string

Methodedetails

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Hiermee maakt u een ontvanger voor de volgende beschikbare sessie in een Azure Service Bus wachtrij met sessiemogelijkheden.

U kunt kiezen tussen twee ontvangstmodi: 'peekLock' (standaard) en 'receiveAndDelete'.

• In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij.
• In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen.

U kunt een bericht vereffenen door de methoden completeMessage(), abandonMessage(), deferMessage() of deadletterMessage() aan te roepen op de ontvanger.

Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parameters

queueName

string

De naam van de wachtrij waarvan u wilt ontvangen.

options

ServiceBusSessionReceiverOptions

Opties zijn onder andere receiveMode (standaard ingesteld op peekLock), opties om sessieontvanger te maken.

Retouren

Promise<ServiceBusSessionReceiver>

Een ontvanger die kan worden gebruikt om berichten te ontvangen, te bekijken en te vereffenen.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Hiermee maakt u een ontvanger voor de volgende beschikbare sessie in een Azure Service Bus-abonnement waarvoor een sessie is ingeschakeld.

U kunt kiezen tussen twee ontvangstmodi: 'peekLock' (standaard) en 'receiveAndDelete'.

• In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij.
• In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen.

U kunt een bericht vereffenen door de methoden completeMessage(), abandonMessage(), deferMessage() of deadletterMessage() aan te roepen op de ontvanger.

Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parameters

topicName

string

Naam van het onderwerp voor het abonnement waarvan we willen ontvangen.

subscriptionName

string

Naam van het abonnement (onder de topic) waarvan we willen ontvangen.

options

ServiceBusSessionReceiverOptions

Opties zijn onder andere receiveMode (standaard ingesteld op peekLock), opties om sessieontvanger te maken.

Retouren

Promise<ServiceBusSessionReceiver>

Een ontvanger die kan worden gebruikt om berichten te ontvangen, te bekijken en te vereffenen.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Hiermee maakt u een ontvanger voor een sessie die is ingeschakeld Azure Service Bus wachtrij.

U kunt kiezen tussen twee ontvangstmodi: 'peekLock' (standaard) en 'receiveAndDelete'.

• In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij.
• In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen.

U kunt een bericht vereffenen door de methoden completeMessage(), abandonMessage(), deferMessage() of deadletterMessage() aan te roepen op de ontvanger.

Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parameters

queueName

string

De naam van de wachtrij waarvan u wilt ontvangen.

sessionId

string

De id van de sessie van waaruit berichten moeten worden ontvangen

options

ServiceBusSessionReceiverOptions

Opties zijn onder andere receiveMode (standaard ingesteld op peekLock), opties om sessieontvanger te maken.

Retouren

Promise<ServiceBusSessionReceiver>

Een ontvanger die kan worden gebruikt om berichten te ontvangen, te bekijken en te vereffenen.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Hiermee maakt u een ontvanger voor een sessie die is ingeschakeld Azure Service Bus abonnement.

U kunt kiezen tussen twee ontvangstmodi: 'peekLock' (standaard) en 'receiveAndDelete'.

• In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij.
• In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen.

U kunt een bericht vereffenen door de methoden completeMessage(), abandonMessage(), deferMessage() of deadletterMessage() aan te roepen op de ontvanger.

Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: 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>

Parameters

topicName

string

Naam van het onderwerp voor het abonnement waarvan we willen ontvangen.

subscriptionName

string

Naam van het abonnement (onder de topic) waarvan we willen ontvangen.

sessionId

string

De id van de sessie van waaruit berichten moeten worden ontvangen

options

ServiceBusSessionReceiverOptions

Opties zijn onder andere receiveMode (standaard ingesteld op peekLock), opties om sessieontvanger te maken.

Retouren

Promise<ServiceBusSessionReceiver>

Een ontvanger die kan worden gebruikt om berichten te ontvangen, te bekijken en te vereffenen.

close()

Hiermee wordt de onderliggende AMQP-verbinding gesloten. OPMERKING: hiermee wordt ook de verbinding verbroken van alle instanties van de ontvanger of afzender die op basis van dit exemplaar zijn gemaakt.

function close(): Promise<void>

Retouren

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Hiermee maakt u een ontvanger voor een Azure Service Bus wachtrij. Er wordt geen verbinding gemaakt met de service totdat een van de methoden op de ontvanger wordt aangeroepen.

Als u subwachtrijen wilt targeten, zoals de wachtrij met onbestelbare berichten of de wachtrij voor overdracht van onbestelbare berichten, geeft u de subQueue op in de opties. Zie voor meer informatie over wachtrijen voor onbestelbare berichten https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

U kunt kiezen tussen twee ontvangstmodi: 'peekLock' (standaard) en 'receiveAndDelete'.

• In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij.
• In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen.

Berichten die niet binnen de vergrendelingsduur zijn vereffend, worden net zo vaak opnieuw bezorgd als het maximale aantal bezorgingen dat is ingesteld voor de wachtrij, waarna ze naar een afzonderlijke wachtrij met onbestelbare berichten worden verzonden.

U kunt een bericht vereffenen door de methoden completeMessage(), abandonMessage(), deferMessage() of deadletterMessage() aan te roepen op de ontvanger.

Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parameters

queueName

string

De naam van de wachtrij waarvan u wilt ontvangen.

options

ServiceBusReceiverOptions

Opties voor het doorgeven van de receiveMode, standaard ingesteld op peekLock.

Retouren

ServiceBusReceiver

Een ontvanger die kan worden gebruikt om berichten te ontvangen, te bekijken en te vereffenen.

createReceiver(string, string, ServiceBusReceiverOptions)

Hiermee maakt u een ontvanger voor een Azure Service Bus-abonnement. Er wordt geen verbinding gemaakt met de service totdat een van de methoden op de ontvanger wordt aangeroepen.

Als u subwachtrijen wilt targeten, zoals de wachtrij met onbestelbare berichten of de wachtrij voor overdracht van onbestelbare berichten, geeft u de subQueue op in de opties. Zie voor meer informatie over wachtrijen voor onbestelbare berichten https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

U kunt kiezen tussen twee ontvangstmodi: 'peekLock' (standaard) en 'receiveAndDelete'.

• In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij.
• In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen.

Berichten die niet binnen de vergrendelingsduur zijn vereffend, worden net zo vaak opnieuw bezorgd als het maximale aantal bezorgingen dat is ingesteld voor het abonnement, waarna ze naar een afzonderlijke wachtrij met onbestelbare berichten worden verzonden.

U kunt een bericht vereffenen door de methoden completeMessage(), abandonMessage(), deferMessage() of deadletterMessage() aan te roepen op de ontvanger.

Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parameters

topicName

string

Naam van het onderwerp voor het abonnement waarvan we willen ontvangen.

subscriptionName

string

Naam van het abonnement (onder de topic) waarvan we willen ontvangen.

options

ServiceBusReceiverOptions

Opties voor het doorgeven van de receiveMode, standaard ingesteld op peekLock.

Retouren

ServiceBusReceiver

Een ontvanger die kan worden gebruikt om berichten te ontvangen, te bekijken en te vereffenen.

createRuleManager(string, string)

Hiermee maakt u een exemplaar van ServiceBusRuleManager dat wordt gebruikt voor het beheren van de regels voor een abonnement.

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

Parameters

topicName

string

het onderwerp voor het maken van ServiceBusRuleManager

subscriptionName

string

het abonnement dat specifiek is voor het opgegeven onderwerp waarvoor u een ServiceBusRuleManager wilt maken.

Retouren

ServiceBusRuleManager

een ServiceBusRuleManager die is afgestemd op het opgegeven abonnement en onderwerp.

createSender(string, ServiceBusSenderOptions)

Hiermee maakt u een afzender die kan worden gebruikt om berichten te verzenden, te plannen dat berichten op een later tijdstip worden verzonden en dergelijke geplande berichten te annuleren. Er wordt geen verbinding gemaakt met de service totdat een van de methoden op de afzender wordt aangeroepen.

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

Parameters

queueOrTopicName

string

De naam van een wachtrij of onderwerp waar berichten naartoe moeten worden verzonden.

options

ServiceBusSenderOptions

Retouren

ServiceBusSender