ServiceBusClient class

Пакет:

@azure/service-bus

Клиент, который может создавать экземпляры отправителей для отправки сообщений в очереди и разделы, а также экземпляры получателя для получения сообщений из очередей и подписок.

Конструкторы

ServiceBusClient(string, ServiceBusClientOptions)	Создает экземпляр класса ServiceBusClient, который можно использовать для создания отправителей и получателей для Служебная шина Azure пространства имен, предоставленного в строке подключения. Подключение к службе не выполняется до тех пор, пока для отправки и получения сообщений не будут использоваться отправители и получатели, созданные с помощью клиента.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)	Создает экземпляр класса ServiceBusClient, который можно использовать для создания отправителей и получателей для предоставленного пространства имен Служебная шина Azure. Подключение к службе не выполняется до тех пор, пока для отправки и получения сообщений не будут использоваться отправители и получатели, созданные с помощью клиента.

Свойства

fullyQualifiedNamespace	Полное пространство имен экземпляра служебной шины, для которого создается этот клиент. Скорее всего, это будет похоже на .servicebus.windows.net.
identifier	Имя, используемое для идентификации этого объекта ServiceBusClient. Если он не указан или пуст, будет создан случайный уникальный.

Методы

acceptNextSession(string, ServiceBusSessionReceiverOptions)	Создает приемник для следующего доступного сеанса в очереди Служебная шина Azure с поддержкой сеанса. Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete". В режиме peekLock получатель блокирует сообщение на время, указанное в очереди. В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения. Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на получателе. Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)	Создает приемник для следующего доступного сеанса в подписке Служебная шина Azure с поддержкой сеанса. Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete". В режиме peekLock получатель блокирует сообщение на время, указанное в очереди. В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения. Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на получателе. Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)	Создает приемник для очереди Служебная шина Azure с поддержкой сеанса. Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete". В режиме peekLock получатель блокирует сообщение на время, указанное в очереди. В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения. Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на получателе. Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)	Создает приемник для подписки Служебная шина Azure с поддержкой сеанса. Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete". В режиме peekLock получатель блокирует сообщение на время, указанное в очереди. В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения. Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на получателе. Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()	Закрывает базовое подключение AMQP. ПРИМЕЧАНИЕ. Это также отключит все экземпляры получателя или отправителя, созданные из этого экземпляра.
createReceiver(string, ServiceBusReceiverOptions)	Создает приемник для очереди Служебная шина Azure. Подключение к службе не выполняется, пока не будет вызван один из методов на получателе. Для целевых вложенных очередей, таких как очередь недоставленных сообщений или очередь недоставленных сообщений для передачи, укажите subQueue в параметрах . Дополнительные сведения об очередях недоставленных сообщений см. в разделе https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete". В режиме peekLock получатель блокирует сообщение на время, указанное в очереди. В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения. Сообщения, которые не были урегулированы в течение срока блокировки, будут повторно доставлены столько раз, сколько и максимальное количество доставок, установленное в очереди, после чего они будут отправлены в отдельную очередь недоставленных сообщений. Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на получателе. Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)	Создает получателя для подписки Служебная шина Azure. Подключение к службе не выполняется, пока не будет вызван один из методов на получателе. Для целевых вложенных очередей, таких как очередь недоставленных сообщений или очередь недоставленных сообщений для передачи, укажите subQueue в параметрах . Дополнительные сведения об очередях недоставленных сообщений см. в разделе https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete". В режиме peekLock получатель блокирует сообщение на время, указанное в очереди. В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения. Сообщения, которые не были урегулированы в течение срока блокировки, будут повторно доставлены столько раз, сколько установлено максимальное количество доставок в подписке, после чего они будут отправлены в отдельную очередь недоставленных сообщений. Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на получателе. Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)	Создает экземпляр ServiceBusRuleManager , используемый для управления правилами для подписки.
createSender(string, ServiceBusSenderOptions)	Создает отправитель, который можно использовать для отправки сообщений, планирования отправки сообщений на более позднее время и отмены таких запланированных сообщений. Подключение к службе не выполняется до тех пор, пока не будет вызван один из методов отправителя.

Сведения о конструкторе

ServiceBusClient(string, ServiceBusClientOptions)

Создает экземпляр класса ServiceBusClient, который можно использовать для создания отправителей и получателей для Служебная шина Azure пространства имен, предоставленного в строке подключения. Подключение к службе не выполняется до тех пор, пока для отправки и получения сообщений не будут использоваться отправители и получатели, созданные с помощью клиента.

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

Параметры

connectionString

string

Строка подключения для пространства имен Служебная шина Azure. ПРИМЕЧАНИЕ. Эта строка подключения может содержать EntityPath, который игнорируется.

options

ServiceBusClientOptions

Параметры для клиента служебной шины.

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

Создает экземпляр класса ServiceBusClient, который можно использовать для создания отправителей и получателей для предоставленного пространства имен Служебная шина Azure. Подключение к службе не выполняется до тех пор, пока для отправки и получения сообщений не будут использоваться отправители и получатели, созданные с помощью клиента.

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

Параметры

fullyQualifiedNamespace

string

Полное пространство имен экземпляра служебной шины, которое, скорее всего, будет похоже на .servicebus.windows.net.

credential

TokenCredential | NamedKeyCredential | SASCredential

Объект учетных данных, используемый клиентом для получения маркера для проверки подлинности соединения с Служебная шина Azure. Сведения о создании учетных данных см. в разделе @azure/identity. Если вы используете собственную реализацию TokenCredential интерфейса для AAD, задайте "области" для служебной шины ["https://servicebus.azure.net//user_impersonation"] , чтобы получить соответствующий маркер. AzureNamedKeyCredential Используйте параметр from @azure/core-auth, если вы хотите передать SharedAccessKeyName и SharedAccessKey без использования строки подключения. Эти поля сопоставляют с полем name и key соответственно в AzureNamedKeyCredential. AzureSASCredential Используйте параметр from @azure/core-auth, если требуется передать SharedAccessSignature без использования строки подключения. Это поле сопоставляется с signature в AzureSASCredential.

options

ServiceBusClientOptions

Набор параметров, применяемых при настройке клиента.

• retryOptions : настраивает политику повторных попыток для всех операций на клиенте. Например, { "maxRetries": 4 } или { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: настраивает ченнелинг подключения AMQP через веб-сокеты.

Сведения о свойстве

fullyQualifiedNamespace

Полное пространство имен экземпляра служебной шины, для которого создается этот клиент. Скорее всего, это будет похоже на .servicebus.windows.net.

fullyQualifiedNamespace: string

Значение свойства

string

identifier

Имя, используемое для идентификации этого объекта ServiceBusClient. Если он не указан или пуст, будет создан случайный уникальный.

identifier: string

Значение свойства

string

Сведения о методе

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Создает приемник для следующего доступного сеанса в очереди Служебная шина Azure с поддержкой сеанса.

Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".

• В режиме peekLock получатель блокирует сообщение на время, указанное в очереди.
• В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения.

Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на получателе.

Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Параметры

queueName

string

Имя очереди для получения.

options

ServiceBusSessionReceiverOptions

К параметрам относятся receiveMode (по умолчанию — peekLock), параметры для создания приемника сеанса.

Возвращаемое значение

Promise<ServiceBusSessionReceiver>

Получатель, который может использоваться для получения, просмотра и урегулирования сообщений.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Создает приемник для следующего доступного сеанса в подписке Служебная шина Azure с поддержкой сеанса.

Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".

• В режиме peekLock получатель блокирует сообщение на время, указанное в очереди.
• В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения.

Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на получателе.

Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Параметры

topicName

string

Имя раздела для подписки, которую мы хотим получить.

subscriptionName

string

Имя подписки (в разделе topic), которую мы хотим получить.

options

ServiceBusSessionReceiverOptions

К параметрам относятся receiveMode (по умолчанию — peekLock), параметры для создания приемника сеанса.

Возвращаемое значение

Promise<ServiceBusSessionReceiver>

Получатель, который может использоваться для получения, просмотра и урегулирования сообщений.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Создает приемник для очереди Служебная шина Azure с поддержкой сеанса.

Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".

• В режиме peekLock получатель блокирует сообщение на время, указанное в очереди.
• В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения.

Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на получателе.

Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Параметры

queueName

string

Имя очереди для получения.

sessionId

string

Идентификатор сеанса, из которого должны быть получены сообщения.

options

ServiceBusSessionReceiverOptions

К параметрам относятся receiveMode (по умолчанию — peekLock), параметры для создания приемника сеанса.

Возвращаемое значение

Promise<ServiceBusSessionReceiver>

Получатель, который может использоваться для получения, просмотра и урегулирования сообщений.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Создает приемник для подписки Служебная шина Azure с поддержкой сеанса.

Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".

• В режиме peekLock получатель блокирует сообщение на время, указанное в очереди.
• В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения.

Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на получателе.

Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: 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>

Параметры

topicName

string

Имя раздела для подписки, которую мы хотим получить.

subscriptionName

string

Имя подписки (в разделе topic), которую мы хотим получить.

sessionId

string

Идентификатор сеанса, из которого должны быть получены сообщения.

options

ServiceBusSessionReceiverOptions

К параметрам относятся receiveMode (по умолчанию — peekLock), параметры для создания приемника сеанса.

Возвращаемое значение

Promise<ServiceBusSessionReceiver>

Получатель, который может использоваться для получения, просмотра и урегулирования сообщений.

close()

Закрывает базовое подключение AMQP. ПРИМЕЧАНИЕ. Это также отключит все экземпляры получателя или отправителя, созданные из этого экземпляра.

function close(): Promise<void>

Возвращаемое значение

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Создает приемник для очереди Служебная шина Azure. Подключение к службе не выполняется, пока не будет вызван один из методов на получателе.

Для целевых вложенных очередей, таких как очередь недоставленных сообщений или очередь недоставленных сообщений для передачи, укажите subQueue в параметрах . Дополнительные сведения об очередях недоставленных сообщений см. в разделе https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".

• В режиме peekLock получатель блокирует сообщение на время, указанное в очереди.
• В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения.

Сообщения, которые не были урегулированы в течение срока блокировки, будут повторно доставлены столько раз, сколько и максимальное количество доставок, установленное в очереди, после чего они будут отправлены в отдельную очередь недоставленных сообщений.

Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на получателе.

Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Параметры

queueName

string

Имя очереди для получения.

options

ServiceBusReceiverOptions

Параметры передачи receiveMode по умолчанию — peekLock.

Возвращаемое значение

ServiceBusReceiver

Получатель, который может использоваться для получения, просмотра и урегулирования сообщений.

createReceiver(string, string, ServiceBusReceiverOptions)

Создает получателя для подписки Служебная шина Azure. Подключение к службе не выполняется, пока не будет вызван один из методов на получателе.

Для целевых вложенных очередей, таких как очередь недоставленных сообщений или очередь недоставленных сообщений для передачи, укажите subQueue в параметрах . Дополнительные сведения об очередях недоставленных сообщений см. в разделе https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".

• В режиме peekLock получатель блокирует сообщение на время, указанное в очереди.
• В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения.

Сообщения, которые не были урегулированы в течение срока блокировки, будут повторно доставлены столько раз, сколько установлено максимальное количество доставок в подписке, после чего они будут отправлены в отдельную очередь недоставленных сообщений.

Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на получателе.

Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Параметры

topicName

string

Имя раздела для подписки, которую мы хотим получить.

subscriptionName

string

Имя подписки (в разделе topic), которую мы хотим получить.

options

ServiceBusReceiverOptions

Параметры передачи receiveMode по умолчанию — peekLock.

Возвращаемое значение

ServiceBusReceiver

Получатель, который может использоваться для получения, просмотра и урегулирования сообщений.

createRuleManager(string, string)

Создает экземпляр ServiceBusRuleManager , используемый для управления правилами для подписки.

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

Параметры

topicName

string

раздел для создания ServiceBusRuleManager

subscriptionName

string

подписка, относяскаяся к указанному разделу для создания ServiceBusRuleManager .

Возвращаемое значение

ServiceBusRuleManager

Объект ServiceBusRuleManager, ограниченный указанной подпиской и разделом.

createSender(string, ServiceBusSenderOptions)

Создает отправитель, который можно использовать для отправки сообщений, планирования отправки сообщений на более позднее время и отмены таких запланированных сообщений. Подключение к службе не выполняется до тех пор, пока не будет вызван один из методов отправителя.

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

Параметры

queueOrTopicName

string

Имя очереди или раздела для отправки сообщений.

options

ServiceBusSenderOptions

Возвращаемое значение

ServiceBusSender