ServiceBusClient class
Клиент, который может создавать экземпляры отправителя для отправки сообщений в очереди и разделы, а также экземпляры получателя для получения сообщений из очередей и подписок.
Конструкторы
Service |
Создает экземпляр класса ServiceBusClient, который можно использовать для создания отправителей и получателей в пространстве имен служебной шины Azure, предоставленном в строке подключения. Подключение к службе не выполняется до тех пор, пока отправители или получатели, созданные с клиентом, не будут использоваться для отправки и получения сообщений. |
Service |
Создает экземпляр класса ServiceBusClient, который можно использовать для создания отправителей и получателей в предоставленном пространстве имен служебной шины Azure. Подключение к службе не выполняется до тех пор, пока отправители или получатели, созданные с клиентом, не будут использоваться для отправки и получения сообщений. |
Свойства
fully |
Полное пространство имен экземпляра служебной шины, для которого создается этот клиент. Скорее всего, это похоже на .servicebus.windows.net. |
identifier | Имя, используемое для идентификации этого ServiceBusClient. Если он не указан или не указан, будет создан случайный уникальный. |
Методы
accept |
Создает приемник для следующего доступного сеанса в очереди служебной шины Azure с поддержкой сеанса. Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".
Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на приемнике. Дополнительные сведения о том, как работает проверка блокировки и урегулирования сообщений здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
accept |
Создает приемник для следующего доступного сеанса в подписке служебной шины Azure с поддержкой сеанса. Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".
Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на приемнике. Дополнительные сведения о том, как работает проверка блокировки и урегулирования сообщений здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
accept |
Создает приемник для очереди служебной шины Azure с поддержкой сеанса. Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".
Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на приемнике. Дополнительные сведения о том, как работает проверка блокировки и урегулирования сообщений здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
accept |
Создает приемник для подписки служебной шины Azure с поддержкой сеанса. Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".
Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на приемнике. Дополнительные сведения о том, как работает проверка блокировки и урегулирования сообщений здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
close() | Закрывает базовое подключение AMQP. ПРИМЕЧАНИЕ. Это также отключает все экземпляры получателя или отправителя, созданные из этого экземпляра. |
create |
Создает приемник для очереди служебной шины Azure. Подключение к службе не выполняется до вызова одного из методов приемника. Чтобы настроить целевые вложенные очереди, такие как очередь недоставленных писем или очередь передачи недоставленных писем, укажите Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".
Сообщения, которые не урегулированы в течение длительности блокировки, будут повторяться столько раз, сколько максимальное число доставки в очереди, после чего они отправляются в отдельную очередь недоставленных писем. Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на приемнике. Дополнительные сведения о том, как работает проверка блокировки и урегулирования сообщений здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
create |
Создает приемник для подписки служебной шины Azure. Подключение к службе не выполняется до вызова одного из методов приемника. Чтобы настроить целевые вложенные очереди, такие как очередь недоставленных писем или очередь передачи недоставленных писем, укажите Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".
Сообщения, которые не урегулированы в течение длительности блокировки, будут повторно созданы столько раз, сколько максимальное количество доставки в подписке, после чего они отправляются в отдельную очередь недоставленных писем. Вы можете урегулировать сообщение, вызвав методы completeMessage(), abandonMessage(), deferMessage() или deadletterMessage() на приемнике. Дополнительные сведения о том, как работает проверка блокировки и урегулирования сообщений здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
create |
Создает экземпляр ServiceBusRuleManager, который используется для управления правилами подписки. |
create |
Создает отправителя, который можно использовать для отправки сообщений, планирования отправки сообщений позже и отмены таких запланированных сообщений. Подключение к службе не выполняется до вызова одного из методов отправителя. |
Сведения о конструкторе
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
Объект учетных данных, используемый клиентом для проверки подлинности соединения с служебной шиной Azure. Сведения о создании учетных данных см. в разделе @azure/identity.
Если вы используете собственную реализацию интерфейса TokenCredential
для AAD, задайте для служебной шины ["https://servicebus.azure.net//user_impersonation"]
, чтобы получить соответствующий маркер.
Используйте AzureNamedKeyCredential
из @azure/core-auth, если вы хотите передать SharedAccessKeyName
и SharedAccessKey
без использования строки подключения. Эти поля сопоставляют с полем name
и key
соответственно в AzureNamedKeyCredential
.
Используйте AzureSASCredential
из @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".
- В режиме просмотраLock получатель имеет блокировку сообщения в течение длительности, указанной в очереди.
- В режиме полученияAndDelete сообщения удаляются из служебной шины по мере их получения.
Вы можете урегулировать сообщение, вызвав методы 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(по умолчанию для просмотра), параметры для создания приемника сеансов.
Возвращаемое значение
Promise<ServiceBusSessionReceiver>
Получатель, который можно использовать для получения, просмотра и урегулирования сообщений.
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)
Создает приемник для следующего доступного сеанса в подписке служебной шины Azure с поддержкой сеанса.
Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".
- В режиме просмотраLock получатель имеет блокировку сообщения в течение длительности, указанной в очереди.
- В режиме полученияAndDelete сообщения удаляются из служебной шины по мере их получения.
Вы можете урегулировать сообщение, вызвав методы 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(по умолчанию для просмотра), параметры для создания приемника сеансов.
Возвращаемое значение
Promise<ServiceBusSessionReceiver>
Получатель, который можно использовать для получения, просмотра и урегулирования сообщений.
acceptSession(string, string, ServiceBusSessionReceiverOptions)
Создает приемник для очереди служебной шины Azure с поддержкой сеанса.
Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".
- В режиме просмотраLock получатель имеет блокировку сообщения в течение длительности, указанной в очереди.
- В режиме полученияAndDelete сообщения удаляются из служебной шины по мере их получения.
Вы можете урегулировать сообщение, вызвав методы 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(по умолчанию для просмотра), параметры для создания приемника сеансов.
Возвращаемое значение
Promise<ServiceBusSessionReceiver>
Получатель, который можно использовать для получения, просмотра и урегулирования сообщений.
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)
Создает приемник для подписки служебной шины Azure с поддержкой сеанса.
Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".
- В режиме просмотраLock получатель имеет блокировку сообщения в течение длительности, указанной в очереди.
- В режиме полученияAndDelete сообщения удаляются из служебной шины по мере их получения.
Вы можете урегулировать сообщение, вызвав методы 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(по умолчанию для просмотра), параметры для создания приемника сеансов.
Возвращаемое значение
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".
- В режиме просмотраLock получатель имеет блокировку сообщения в течение длительности, указанной в очереди.
- В режиме полученияAndDelete сообщения удаляются из служебной шины по мере их получения.
Сообщения, которые не урегулированы в течение длительности блокировки, будут повторяться столько раз, сколько максимальное число доставки в очереди, после чего они отправляются в отдельную очередь недоставленных писем.
Вы можете урегулировать сообщение, вызвав методы 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 по умолчанию для просмотра.
Возвращаемое значение
Получатель, который можно использовать для получения, просмотра и урегулирования сообщений.
createReceiver(string, string, ServiceBusReceiverOptions)
Создает приемник для подписки служебной шины Azure. Подключение к службе не выполняется до вызова одного из методов приемника.
Чтобы настроить целевые вложенные очереди, такие как очередь недоставленных писем или очередь передачи недоставленных писем, укажите subQueue
в параметрах. Дополнительные сведения о очередях недоставленных писем см. в https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues
Вы можете выбрать один из двух режимов получения: "peekLock" (по умолчанию) и "receiveAndDelete".
- В режиме просмотраLock получатель имеет блокировку сообщения в течение длительности, указанной в очереди.
- В режиме полученияAndDelete сообщения удаляются из служебной шины по мере их получения.
Сообщения, которые не урегулированы в течение длительности блокировки, будут повторно созданы столько раз, сколько максимальное количество доставки в подписке, после чего они отправляются в отдельную очередь недоставленных писем.
Вы можете урегулировать сообщение, вызвав методы 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 по умолчанию для просмотра.
Возвращаемое значение
Получатель, который можно использовать для получения, просмотра и урегулирования сообщений.
createRuleManager(string, string)
Создает экземпляр ServiceBusRuleManager, который используется для управления правилами подписки.
function createRuleManager(topicName: string, subscriptionName: string): ServiceBusRuleManager
Параметры
- topicName
-
string
Раздел для создания ServiceBusRuleManager
- subscriptionName
-
string
подписка, относяскаяся к указанному разделу, для создания ServiceBusRuleManager.
Возвращаемое значение
ServiceBusRuleManager в пределах указанной подписки и раздела.
createSender(string, ServiceBusSenderOptions)
Создает отправителя, который можно использовать для отправки сообщений, планирования отправки сообщений позже и отмены таких запланированных сообщений. Подключение к службе не выполняется до вызова одного из методов отправителя.
function createSender(queueOrTopicName: string, options?: ServiceBusSenderOptions): ServiceBusSender
Параметры
- queueOrTopicName
-
string
Имя очереди или раздела для отправки сообщений.
- options
- ServiceBusSenderOptions