Delen via

ServiceBusClient class

  • Referentie
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 ServiceBusClient-klasse die kan worden gebruikt om afzenders en ontvangers te maken voor de Azure Service Bus-naamruimte die is opgegeven in de verbindingsreeks. Er wordt geen verbinding gemaakt met de service totdat de afzenders/ontvangers die met de client zijn gemaakt, worden gebruikt voor het verzenden/ontvangen van berichten.
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 opgegeven Azure Service Bus-naamruimte. Er wordt geen verbinding gemaakt met de service totdat de afzenders/ontvangers die met de client zijn gemaakt, worden gebruikt voor het verzenden/ontvangen van berichten.

Eigenschappen

fullyQualifiedNamespace

De volledig gekwalificeerde naamruimte van het Service Bus-exemplaar waarvoor deze client wordt 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 wanneer ze worden ontvangen.

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

Meer informatie over hoe peekLock en berichtafhandeling werkt 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 wanneer ze worden ontvangen.

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

Meer informatie over hoe peekLock en berichtafhandeling werkt 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 Azure Service Bus-wachtrij 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 wanneer ze worden ontvangen.

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

Meer informatie over hoe peekLock en berichtafhandeling werkt 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 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 wanneer ze worden ontvangen.

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

Meer informatie over hoe peekLock en berichtafhandeling werkt hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()

Hiermee sluit u de onderliggende AMQP-verbinding. OPMERKING: hiermee wordt ook de verbinding verbroken tussen ontvangers of afzenderexemplaren die zijn gemaakt op basis van dit exemplaar.
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.

Geef de subQueue op in de opties om subwachtrijen, zoals de wachtrij voor dode letters of de wachtrij met dode letters, te richten. Zie https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues voor meer informatie over wachtrijen met dode letters

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 wanneer ze worden ontvangen.

Berichten die niet binnen de vergrendelingsduur zijn vereffend, worden zo vaak opnieuw verzonden als het maximale aantal bezorgingen dat is ingesteld in de wachtrij, waarna ze naar een aparte wachtrij met dode brieven worden verzonden.

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

Meer informatie over hoe peekLock en berichtafhandeling werkt 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.

Geef de subQueue op in de opties om subwachtrijen, zoals de wachtrij voor dode letters of de wachtrij met dode letters, te richten. Zie https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues voor meer informatie over wachtrijen met dode letters

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 wanneer ze worden ontvangen.

Berichten die niet binnen de vergrendelingsduur zijn geregeld, worden zo vaak opnieuw verzonden als het maximale aantal bezorgingen dat is ingesteld voor het abonnement, waarna ze worden verzonden naar een aparte wachtrij met dode brieven.

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

Meer informatie over hoe peekLock en berichtafhandeling werkt 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 om de regels voor een abonnement te beheren.
createSender(string, ServiceBusSenderOptions)

Hiermee maakt u een afzender die kan worden gebruikt om berichten te verzenden, berichten te plannen die op een later tijdstip moeten 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 ServiceBusClient-klasse die kan worden gebruikt om afzenders en ontvangers te maken voor de Azure Service Bus-naamruimte die is opgegeven in de verbindingsreeks. Er wordt geen verbinding gemaakt met de service totdat de afzenders/ontvangers die met de client zijn gemaakt, worden gebruikt voor het verzenden/ontvangen van berichten.

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

Parameters

connectionString

string

Een verbindingsreeks voor Azure Service Bus-naamruimte. OPMERKING: deze verbindingsreeks kan een EntityPath bevatten, wat 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 opgegeven Azure Service Bus-naamruimte. Er wordt geen verbinding gemaakt met de service totdat de afzenders/ontvangers die met de client zijn gemaakt, worden gebruikt voor het verzenden/ontvangen van berichten.

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 Azure Service Bus te verifiëren. Zie @azure/identiteit voor het maken van de referenties. Als u een eigen implementatie van de TokenCredential-interface voor AAD gebruikt, stelt u de 'bereiken' in voor service-bus die moet worden ["https://servicebus.azure.net//user_impersonation"] om het juiste token op te halen. Gebruik de AzureNamedKeyCredential van @azure/core-verificatie als u een SharedAccessKeyName en SharedAccessKey wilt doorgeven zonder een verbindingsreeks te gebruiken. Deze velden worden respectievelijk toegewezen aan het name- en key veld in AzureNamedKeyCredential. Gebruik de AzureSASCredential van @azure/core-verificatie als u een SharedAccessSignature wilt doorgeven zonder een verbindingsreeks te gebruiken. Dit veld wordt toegewezen aan signature in AzureSASCredential.

options
ServiceBusClientOptions

Een set 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 kanaalling van de AMQP-verbinding via Web Sockets.

Eigenschapdetails

fullyQualifiedNamespace

De volledig gekwalificeerde naamruimte van het Service Bus-exemplaar waarvoor deze client wordt 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 wanneer ze worden ontvangen.

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

Meer informatie over hoe peekLock en berichtafhandeling werkt 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 waaruit moet worden ontvangen.

options
ServiceBusSessionReceiverOptions

Opties zijn onder andere receiveMode(standaard om peekLock te bekijken), opties voor het maken van sessieontvanger.

Retouren

Promise<ServiceBusSessionReceiver>

Een ontvanger die kan worden gebruikt voor het ontvangen, bekijken en vereffenen van berichten.

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 wanneer ze worden ontvangen.

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

Meer informatie over hoe peekLock en berichtafhandeling werkt 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 om peekLock te bekijken), opties voor het maken van sessieontvanger.

Retouren

Promise<ServiceBusSessionReceiver>

Een ontvanger die kan worden gebruikt voor het ontvangen, bekijken en vereffenen van berichten.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Hiermee maakt u een ontvanger voor een Azure Service Bus-wachtrij 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 wanneer ze worden ontvangen.

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

Meer informatie over hoe peekLock en berichtafhandeling werkt 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 waaruit moet worden ontvangen.

sessionId

string

De id van de sessie waaruit berichten moeten worden ontvangen

options
ServiceBusSessionReceiverOptions

Opties zijn onder andere receiveMode(standaard om peekLock te bekijken), opties voor het maken van sessieontvanger.

Retouren

Promise<ServiceBusSessionReceiver>

Een ontvanger die kan worden gebruikt voor het ontvangen, bekijken en vereffenen van berichten.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Hiermee maakt u een ontvanger voor 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 wanneer ze worden ontvangen.

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

Meer informatie over hoe peekLock en berichtafhandeling werkt 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 waaruit berichten moeten worden ontvangen

options
ServiceBusSessionReceiverOptions

Opties zijn onder andere receiveMode(standaard om peekLock te bekijken), opties voor het maken van sessieontvanger.

Retouren

Promise<ServiceBusSessionReceiver>

Een ontvanger die kan worden gebruikt voor het ontvangen, bekijken en vereffenen van berichten.

close()

Hiermee sluit u de onderliggende AMQP-verbinding. OPMERKING: hiermee wordt ook de verbinding verbroken tussen ontvangers of afzenderexemplaren die zijn gemaakt op basis van dit exemplaar.

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.

Geef de subQueue op in de opties om subwachtrijen, zoals de wachtrij voor dode letters of de wachtrij met dode letters, te richten. Zie https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues voor meer informatie over wachtrijen met dode letters

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 wanneer ze worden ontvangen.

Berichten die niet binnen de vergrendelingsduur zijn vereffend, worden zo vaak opnieuw verzonden als het maximale aantal bezorgingen dat is ingesteld in de wachtrij, waarna ze naar een aparte wachtrij met dode brieven worden verzonden.

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

Meer informatie over hoe peekLock en berichtafhandeling werkt 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 waaruit moet worden ontvangen.

options
ServiceBusReceiverOptions

Opties om de receiveMode door te geven, standaard ingesteld op peekLock.

Retouren

ServiceBusReceiver

Een ontvanger die kan worden gebruikt voor het ontvangen, bekijken en vereffenen van berichten.

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.

Geef de subQueue op in de opties om subwachtrijen, zoals de wachtrij voor dode letters of de wachtrij met dode letters, te richten. Zie https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues voor meer informatie over wachtrijen met dode letters

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 wanneer ze worden ontvangen.

Berichten die niet binnen de vergrendelingsduur zijn geregeld, worden zo vaak opnieuw verzonden als het maximale aantal bezorgingen dat is ingesteld voor het abonnement, waarna ze worden verzonden naar een aparte wachtrij met dode brieven.

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

Meer informatie over hoe peekLock en berichtafhandeling werkt 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 om de receiveMode door te geven, standaard ingesteld op peekLock.

Retouren

ServiceBusReceiver

Een ontvanger die kan worden gebruikt voor het ontvangen, bekijken en vereffenen van berichten.

createRuleManager(string, string)

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

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 voor het maken van een ServiceBusRuleManager.

Retouren

ServiceBusRuleManager

een ServiceBusRuleManager gericht op het opgegeven abonnement en onderwerp.

createSender(string, ServiceBusSenderOptions)

Hiermee maakt u een afzender die kan worden gebruikt om berichten te verzenden, berichten te plannen die op een later tijdstip moeten 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