Service Bus
Подключитесь к служебной шине Azure для отправки и получения сообщений. Вы можете выполнять такие действия, как отправка в очередь, отправка в раздел, получение из очереди, получение от подписки и т. д.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC High) |
| Логические приложения | Стандарт | Все регионы Logic Apps |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC High) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC High) |
| Контакт | |
|---|---|
| Имя | Microsoft |
| URL |
Поддержка Microsoft LogicApps Поддержка Microsoft Power Automate Поддержка Microsoft Power Apps |
| Метаданные соединителя | |
|---|---|
| Publisher | Microsoft |
| Веб-сайт | https://azure.microsoft.com/services/service-bus/ |
Общие известные проблемы и ограничения
Бесконечные циклы
Используйте осторожность при выборе триггера и действия с одинаковым типом соединителя и их использовании для работы с одной и той же сущностью, например подпиской на очередь или раздел. Это сочетание может создать бесконечный цикл, который приводит к тому, что рабочий процесс, который никогда не заканчивается.
Например, предположим, что рабочий процесс использует триггер служебной шины, который возвращает только что полученное сообщение в очереди и следует за этим триггером с действием служебной шины, которое отправляет сообщение обратно в ту же очередь. Этот шаблон может создать бесконечный цикл, вызывая незавернутый рабочий процесс.
Ограничение на сохраненные сеансы в кэше соединителей
На сущность обмена сообщениями служебной шины, например подписку или раздел, соединитель служебной шины может сохранять до 1500 уникальных сеансов в кэш соединителя. Если число сеансов превышает это максимальное значение, старые сеансы удаляются из кэша. Дополнительные сведения см. в статье Сеансы обмена сообщениями.
Триггеры длинного опроса
Для управляемого соединителя служебной шины Azure все триггеры являются длительными опросами. Этот тип триггера обрабатывает все сообщения, а затем ожидает 30 секунд, чтобы больше сообщений отображалось в очереди или подписке раздела. Если на протяжении 30 секунд новые сообщения не поступают, триггер больше не срабатывает. В противном случае триггер продолжит считывать сообщения, пока очередь или подписка раздела не опустеет. Следующий опрос триггера основывается на интервале повторения, установленном в свойствах триггера.
Проверка подлинности идентификатора Microsoft Entra
Чтобы использовать проверку подлинности идентификатора Microsoft Entra, учетная запись пользователя требует назначения определенной роли. Дополнительные сведения см. в статье "Назначение роли Azure для прав доступа " Служебная шина Azure".
Аутентификация управляемой идентификации
В настоящее время проверка подлинности управляемого удостоверения поддерживается только для Azure Logic Apps.
Чтобы использовать управляемое удостоверение, которое проверяет подлинность доступа из рабочего процесса приложения логики к пространству имен служебной шины и сущности обмена сообщениями, убедитесь, что вы назначаете разрешения роли на соответствующих уровнях. Например, для доступа к очереди управляемому удостоверению требуется роль, которая имеет необходимые разрешения для этой очереди.
Каждое управляемое удостоверение, которое обращается к другой сущности обмена сообщениями, должно иметь отдельное подключение к этой сущности. Если для отправки и получения сообщений используются различные действия служебной шины Azure, а для этих действий требуются разные разрешения, обязательно используйте разные подключения.
Чтобы включить управляемое удостоверение для использования с служебной шиной Azure, выполните следующие высокоуровневые действия.
Включите или создайте управляемое удостоверение для ресурса приложения логики. Дополнительные сведения см. в статье "Проверка подлинности доступа к ресурсам Azure с управляемыми удостоверениями в Azure Logic Apps".
Предоставьте удостоверению доступ к ресурсам служебной шины Azure. Дополнительные сведения см. в статье "Назначение роли Azure для прав доступа — служебная шина Azure"
Для назначаемого пользователем удостоверения добавьте удостоверение в ресурс приложения логики. Дополнительные сведения об управляемых удостоверениях в Azure Logic Apps см. в статье "Проверка подлинности доступа к ресурсам Azure с помощью управляемых удостоверений в Azure Logic Apps"
Подробное описание соединителя
В этой статье описываются операции управляемого соединителя служебной шины Azure, который доступен для Azure Logic Apps, Power Automate и Power Apps. Встроенный соединитель служебной шины Azure доступен только для рабочих процессов приложений логики уровня "Стандартный" в Azure Logic Apps.
Дополнительные сведения о встроенном соединителе служебной шины Azure и управляемом соединителе в Azure Logic Apps см. в статье "Подключение к служебной шине Azure" из рабочих процессов в Azure Logic Apps.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| ключа доступа | Укажите строку подключения для доступа к служебной шине Azure. | Все регионы, кроме Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и государственных организаций США (GCC-High) | Недоступен для совместного использования |
| Ключ доступа (Azure для государственных организаций) | Укажите строку подключения для доступа к служебной шине Azure. | Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и правительства США (GCC-High) только | Недоступен для совместного использования |
| Проверка подлинности сертификата клиента | Предоставление учетных данных идентификатора Microsoft Entra с помощью сертификата и пароля PFX | Все регионы | Доступный для общего пользования |
| Управляемое удостоверение Logic Apps | Создание подключения с помощью управляемого удостоверения LogicApps | Только LOGICAPPS | Доступный для общего пользования |
| Интегрированный идентификатор Microsoft Entra | Используйте идентификатор Microsoft Entra для доступа к служебной шине Azure. | Все регионы, кроме Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и государственных организаций США (GCC-High) | Недоступен для совместного использования |
| Интегрированная идентификатора Microsoft Entra (Azure для государственных организаций) | Используйте идентификатор Microsoft Entra для доступа к служебной шине Azure. | Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и правительства США (GCC-High) только | Недоступен для совместного использования |
| По умолчанию [не рекомендуется] | Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости. | Все регионы | Недоступен для совместного использования |
Ключ доступа
Идентификатор проверки подлинности: connectionstringauth
Применимо: все регионы, кроме Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и сша (GCC-High)
Укажите строку подключения для доступа к служебной шине Azure.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Строка подключения | securestring | Строка подключения к сервисной шине Azure | True |
Ключ доступа (Azure для государственных организаций)
Идентификатор проверки подлинности: connectionstringauth
Применимо: Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и правительства США (GCC-High) только
Укажите строку подключения для доступа к служебной шине Azure.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Строка подключения | securestring | Строка подключения к сервисной шине Azure | True |
Проверка подлинности сертификата клиента
Идентификатор проверки подлинности: CertOauth
Применимо: все регионы
Предоставление учетных данных идентификатора Microsoft Entra с помощью сертификата и пароля PFX
Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Tenant | струна | True | |
| Идентификатор клиента | струна | Идентификатор клиента для приложения Идентификатора Microsoft Entra | True |
| Секрет сертификата клиента | клиентский сертификат | Секрет сертификата клиента, разрешенный этим приложением | True |
| Конечная точка пространства имен | струна | Укажите конечную точку пространства имен служебной шины (например, sb://testsb.servicebus.windows.net/) | True |
Управляемое удостоверение Logic Apps
Идентификатор проверки подлинности: managedIdentityAuth
Применимо: только LOGICAPPS
Создание подключения с помощью управляемого удостоверения LogicApps
Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Управляемое удостоверение LogicApps | управляемая идентичность | Вход с помощью управляемого удостоверения Logic Apps | True |
| Конечная точка пространства имен | струна | Укажите конечную точку пространства имен служебной шины (например, sb://testsb.servicebus.windows.net/) | True |
Microsoft Entra id Integrated
Идентификатор проверки подлинности: aadAuth
Применимо: все регионы, кроме Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и сша (GCC-High)
Используйте идентификатор Microsoft Entra для доступа к служебной шине Azure.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Конечная точка пространства имен | струна | Укажите конечную точку пространства имен служебной шины (например, sb://testsb.servicebus.windows.net/) | True |
Интегрированная идентификатора Microsoft Entra (Azure для государственных организаций)
Идентификатор проверки подлинности: aadAuth
Применимо: Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и правительства США (GCC-High) только
Используйте идентификатор Microsoft Entra для доступа к служебной шине Azure.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Конечная точка пространства имен | струна | Укажите конечную точку пространства имен служебной шины (например, sb://testsb.servicebus.windows.net/) | True |
По умолчанию [не рекомендуется]
Применимо: все регионы
Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Строка подключения | securestring | Строка подключения к сервисной шине Azure | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 6000 | 60 секунд |
Действия
| Завершение сообщения в очереди |
Операция завершает сообщение в очереди. |
| Завершение сообщения в подписке раздела |
Операция завершает сообщение в подписке раздела. |
| Закрытие сеанса в очереди |
Операция закрывает сеанс в очереди. |
| Закрытие сеанса в разделе |
Операция закрывает сеанс в разделе. |
| Недоставка сообщения в очереди |
Операция перемещает сообщение в очередь Dead-Letter. |
| Недоставка сообщения в подписке на раздел |
Операция перемещает сообщение в раздел Dead-Letter очереди. |
| Отказ от сообщения в очереди |
Операция покидает сообщение в очереди. |
| Отказ от сообщения в подписке раздела |
Операция отказывается от сообщения в подписке раздела. |
| Отложить сообщение в очереди |
Операция откладывает сообщение в очереди. |
| Отложить сообщение в подписке раздела |
Операция откладывает сообщение в подписке раздела. |
| Отправить сообщение |
Эта операция отправляет сообщение в очередь или раздел. |
| Отправка одного или нескольких сообщений |
Эта операция отправляет одно или несколько сообщений в очередь или раздел. |
| Получение отложенного сообщения из очереди |
Операция получает отложенное сообщение из очереди. |
| Получение отложенного сообщения из подписки раздела |
Операция получает отложенное сообщение из подписки раздела. |
| Получение сообщений из очереди (просмотр блокировки) |
Операция получает сообщения из очереди с блокировкой просмотра. Если максимальное число сообщений не указано, оно считывает 20 сообщений. |
| Получение сообщений из подписки раздела (peek-lock) |
Операция получает сообщения из подписки раздела с блокировкой просмотра. Если максимальное число сообщений не указано, оно считывает 20 сообщений. |
| Продление блокировки сеанса в очереди |
Операция обновляет сеанс в очереди. |
| Продление блокировки сеанса в подписке раздела |
Операция обновляет сеанс в подписке раздела. |
| Продление блокировки сообщения в очереди |
Операция обновляет блокировку сообщения в очереди. |
| Продление блокировки сообщения в подписке раздела |
Операция продлевает блокировку сообщения в подписке раздела. |
| Создание подписки раздела |
Операция создает подписку на раздел. |
| Удаление подписки раздела |
Операция удаляет подписку раздела. |
Завершение сообщения в очереди
Операция завершает сообщение в очереди.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Название очереди |
|
Маркер блокировки сообщения
|
lockToken | True | string |
Маркер блокировки сообщения для завершения |
|
Тип очереди
|
queueType | string |
Тип очереди — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
ИД сеанса |
Завершение сообщения в подписке раздела
Операция завершает сообщение в подписке раздела.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
Маркер блокировки сообщения
|
lockToken | True | string |
Маркер блокировки сообщения для завершения |
|
Тип подписки
|
subscriptionType | string |
Тип подписки — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
ИД сеанса |
Закрытие сеанса в очереди
Операция закрывает сеанс в очереди.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Имя очереди |
|
ИД сеанса
|
sessionId | True | string |
ИД сеанса |
Закрытие сеанса в разделе
Операция закрывает сеанс в разделе.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
ИД сеанса
|
sessionId | True | string |
ИД сеанса |
Недоставка сообщения в очереди
Операция перемещает сообщение в очередь Dead-Letter.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Название очереди |
|
Маркер блокировки сообщения
|
lockToken | True | string |
Маркер блокировки сообщения на недоставленную букву |
|
ИД сеанса
|
sessionId | string |
ИД сеанса |
|
|
Причина недоставленных писем
|
deadLetterReason | string |
Причина недоставленных писем |
|
|
Описание ошибки недоставленной буквы
|
deadLetterErrorDescription | string |
Описание ошибки недоставленной буквы |
Недоставка сообщения в подписке на раздел
Операция перемещает сообщение в раздел Dead-Letter очереди.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
Маркер блокировки сообщения
|
lockToken | True | string |
Маркер блокировки сообщения на недоставленную букву |
|
ИД сеанса
|
sessionId | string |
ИД сеанса |
|
|
Причина недоставленных писем
|
deadLetterReason | string |
Причина недоставленных писем |
|
|
Описание ошибки недоставленной буквы
|
deadLetterErrorDescription | string |
Описание ошибки недоставленной буквы |
Отказ от сообщения в очереди
Операция покидает сообщение в очереди.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Название очереди |
|
Маркер блокировки сообщения
|
lockToken | True | string |
Маркер блокировки сообщения, который нужно отказаться |
|
Тип очереди
|
queueType | string |
Тип очереди — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
ИД сеанса |
Отказ от сообщения в подписке раздела
Операция отказывается от сообщения в подписке раздела.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
Маркер блокировки сообщения
|
lockToken | True | string |
Маркер блокировки сообщения, который нужно отказаться |
|
Тип подписки
|
subscriptionType | string |
Тип подписки — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
ИД сеанса |
Отложить сообщение в очереди
Операция откладывает сообщение в очереди.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Название очереди |
|
Маркер блокировки сообщения
|
lockToken | True | string |
Маркер блокировки сообщения для отсрочки |
|
Тип очереди
|
queueType | string |
Тип очереди — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
ИД сеанса |
Отложить сообщение в подписке раздела
Операция откладывает сообщение в подписке раздела.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
Маркер блокировки сообщения
|
lockToken | True | string |
Маркер блокировки сообщения для отсрочки |
|
Тип подписки
|
subscriptionType | string |
Тип подписки — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
ИД сеанса |
Отправить сообщение
Эта операция отправляет сообщение в очередь или раздел.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди и раздела
|
entityName | True | string |
Имя очереди или раздела |
|
Content
|
ContentData | byte |
Содержимое сообщения |
|
|
Тип контента
|
ContentType | string |
Тип контента сообщения |
|
|
Свойства
|
Properties | object |
Пары "ключ-значение" для каждого свойства брокера |
|
|
Идентификатор сообщения
|
MessageId | string |
Это определяемое пользователем значение, которое служебная шина может использовать для идентификации повторяющихся сообщений, если они включены. |
|
|
Кому
|
To | string |
Отправка по адресу |
|
|
Ответить на
|
ReplyTo | string |
Адрес очереди для ответа |
|
|
Ответ на идентификатор сеанса
|
ReplyToSessionId | string |
Идентификатор сеанса для ответа |
|
|
Этикетка
|
Label | string |
Метка конкретного приложения |
|
|
ScheduledEnqueueTimeUtc
|
ScheduledEnqueueTimeUtc | date-time |
Дата и время в формате UTC, когда сообщение будет добавлено в очередь |
|
|
ИД сеанса
|
SessionId | string |
Идентификатор сеанса |
|
|
Идентификатор корреляции
|
CorrelationId | string |
Идентификатор корреляции |
|
|
Порядковый номер
|
SequenceNumber | integer |
Идентификатор номера последовательности |
|
|
Маркер блокировки
|
LockToken | string |
Маркер блокировки сообщения в виде строки. |
|
|
Время жизни
|
TimeToLive | integer |
Это длительность в галках, допустимая сообщение. Длительность начинается с момента отправки сообщения в служебную шину. |
|
|
Свойства системы
|
systemProperties | string |
Системные свойства — нет или сведения о выполнении. Сведения о запуске добавляют сведения о свойстве метаданных запуска в качестве настраиваемых свойств в сообщении. |
Отправка одного или нескольких сообщений
Эта операция отправляет одно или несколько сообщений в очередь или раздел.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди и раздела
|
entityName | True | string |
Имя очереди или раздела |
|
Content
|
ContentData | byte |
Содержимое сообщения |
|
|
Тип контента
|
ContentType | string |
Тип контента сообщения |
|
|
Свойства
|
Properties | object |
Пары "ключ-значение" для каждого свойства брокера |
|
|
Идентификатор сообщения
|
MessageId | string |
Это определяемое пользователем значение, которое служебная шина может использовать для идентификации повторяющихся сообщений, если они включены. |
|
|
Кому
|
To | string |
Отправка по адресу |
|
|
Ответить на
|
ReplyTo | string |
Адрес очереди для ответа |
|
|
Ответ на идентификатор сеанса
|
ReplyToSessionId | string |
Идентификатор сеанса для ответа |
|
|
Этикетка
|
Label | string |
Метка конкретного приложения |
|
|
ScheduledEnqueueTimeUtc
|
ScheduledEnqueueTimeUtc | date-time |
Дата и время в формате UTC, когда сообщение будет добавлено в очередь |
|
|
ИД сеанса
|
SessionId | string |
Идентификатор сеанса |
|
|
Идентификатор корреляции
|
CorrelationId | string |
Идентификатор корреляции |
|
|
Порядковый номер
|
SequenceNumber | integer |
Идентификатор номера последовательности |
|
|
Маркер блокировки
|
LockToken | string |
Маркер блокировки сообщения в виде строки. |
|
|
Время жизни
|
TimeToLive | integer |
Это длительность в галках, допустимая сообщение. Длительность начинается с момента отправки сообщения в служебную шину. |
|
|
Свойства системы
|
systemProperties | string |
Системные свойства — нет или сведения о выполнении. Сведения о запуске добавляют сведения о свойстве метаданных запуска в качестве настраиваемых свойств в сообщении. |
Получение отложенного сообщения из очереди
Операция получает отложенное сообщение из очереди.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Название очереди |
|
Порядковый номер сообщения
|
sequenceNumber | True | integer |
Порядковый номер сообщения |
|
Тип очереди
|
queueType | string |
Тип очереди — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
ИД сеанса |
Возвращаемое значение
Сообщение служебной шины
- Тело
- ServiceBusMessage
Получение отложенного сообщения из подписки раздела
Операция получает отложенное сообщение из подписки раздела.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
Порядковый номер сообщения
|
sequenceNumber | True | integer |
Порядковый номер сообщения |
|
Тип подписки
|
subscriptionType | string |
Тип очереди — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
ИД сеанса |
Возвращаемое значение
Сообщение служебной шины
- Тело
- ServiceBusMessage
Получение сообщений из очереди (просмотр блокировки)
Операция получает сообщения из очереди с блокировкой просмотра. Если максимальное число сообщений не указано, оно считывает 20 сообщений.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Название очереди |
|
Максимальное число сообщений
|
maxMessageCount | integer |
Максимальное количество сообщений, возвращаемых в пакете |
|
|
Тип очереди
|
queueType | string |
Тип очереди — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
ИД сеанса |
Возвращаемое значение
- response
- array of ServiceBusMessage
Получение сообщений из подписки раздела (peek-lock)
Операция получает сообщения из подписки раздела с блокировкой просмотра. Если максимальное число сообщений не указано, оно считывает 20 сообщений.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
Максимальное число сообщений
|
maxMessageCount | integer |
Максимальное количество сообщений, возвращаемых в пакете |
|
|
Тип подписки
|
subscriptionType | string |
Тип подписки — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
ИД сеанса |
Возвращаемое значение
- response
- array of ServiceBusMessage
Продление блокировки сеанса в очереди
Операция обновляет сеанс в очереди.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Название очереди |
|
ИД сеанса
|
sessionId | True | string |
ИД сеанса |
Продление блокировки сеанса в подписке раздела
Операция обновляет сеанс в подписке раздела.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
ИД сеанса
|
sessionId | True | string |
ИД сеанса |
Продление блокировки сообщения в очереди
Операция обновляет блокировку сообщения в очереди.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Название очереди |
|
Маркер блокировки сообщения
|
lockToken | True | string |
Маркер блокировки сообщения для продления блокировки |
|
Тип очереди
|
queueType | string |
Тип очереди — Main или DeadLetter |
Продление блокировки сообщения в подписке раздела
Операция продлевает блокировку сообщения в подписке раздела.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
Маркер блокировки сообщения
|
lockToken | True | string |
Маркер блокировки сообщения для продления блокировки |
|
Тип подписки
|
subscriptionType | string |
Тип подписки — Main или DeadLetter |
Создание подписки раздела
Операция создает подписку на раздел.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
Filter
|
subscriptionFilter | True | dynamic |
Фильтр подписки |
|
Тип фильтра
|
subscriptionFilterType | string |
Тип фильтра |
Возвращаемое значение
Подписка раздела.
- Тело
- Subscription
Удаление подписки раздела
Операция удаляет подписку раздела.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
Триггеры
| При получении сообщения в очереди (автозаверщение) |
Эта операция активирует поток при получении сообщения в очереди и автоматически завершает сообщение. |
| При получении сообщения в очереди (просмотр блокировки) |
Операция активирует поток, когда сообщение получено в очереди с режимом просмотра блокировки. |
| При получении сообщения в подписке раздела (автозаверщение) |
Эта операция активирует поток при получении сообщения в подписке раздела и автоматически завершает сообщение. |
| При получении сообщения в подписке раздела (просмотр блокировки) |
Операция активирует поток при получении сообщения в подписке раздела с режимом просмотра блокировки. |
| При поступлении одного или нескольких сообщений в очередь (автоматическое завершение) |
Операция получает одно или несколько сообщений из очереди. Если максимальное число сообщений не указано, оно считывает 20 сообщений. |
| При поступлении одного или нескольких сообщений в очередь (просмотр блокировки) |
Операция получает одно или несколько сообщений из очереди с блокировкой просмотра. Если максимальное число сообщений не указано, оно считывает 20 сообщений. |
| При поступлении одного или нескольких сообщений в раздел (автоматическое завершение) |
Операция получает одно или несколько сообщений из раздела. Если максимальное число сообщений не указано, оно считывает 20 сообщений. |
| При поступлении одного или нескольких сообщений в раздел (просмотр блокировки) |
Операция получает одно или несколько сообщений из раздела с блокировкой просмотра. Если максимальное число сообщений не указано, оно считывает 20 сообщений. |
При получении сообщения в очереди (автозаверщение)
Эта операция активирует поток при получении сообщения в очереди и автоматически завершает сообщение.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Название очереди |
|
Тип очереди
|
queueType | string |
Тип очереди — Main или DeadLetter |
Возвращаемое значение
Сообщение служебной шины
- Тело
- ServiceBusMessage
При получении сообщения в очереди (просмотр блокировки)
Операция активирует поток, когда сообщение получено в очереди с режимом просмотра блокировки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Название очереди |
|
Тип очереди
|
queueType | string |
Тип очереди — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
Идентификатор сеанса — нет или следующий доступный или укажите идентификатор сеанса |
Возвращаемое значение
Сообщение служебной шины
- Тело
- ServiceBusMessage
При получении сообщения в подписке раздела (автозаверщение)
Эта операция активирует поток при получении сообщения в подписке раздела и автоматически завершает сообщение.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
Тип подписки
|
subscriptionType | string |
Тип подписки — Main или DeadLetter |
Возвращаемое значение
Сообщение служебной шины
- Тело
- ServiceBusMessage
При получении сообщения в подписке раздела (просмотр блокировки)
Операция активирует поток при получении сообщения в подписке раздела с режимом просмотра блокировки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
Тип подписки
|
subscriptionType | string |
Тип подписки — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
Идентификатор сеанса — нет или следующий доступный или укажите идентификатор сеанса |
Возвращаемое значение
Сообщение служебной шины
- Тело
- ServiceBusMessage
При поступлении одного или нескольких сообщений в очередь (автоматическое завершение)
Операция получает одно или несколько сообщений из очереди. Если максимальное число сообщений не указано, оно считывает 20 сообщений.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Название очереди |
|
Максимальное число сообщений
|
maxMessageCount | integer |
Максимальное количество сообщений, возвращаемых в пакете |
|
|
Тип очереди
|
queueType | string |
Тип очереди — Main или DeadLetter |
Возвращаемое значение
Сообщение служебной шины
- Тело
- ServiceBusMessage
При поступлении одного или нескольких сообщений в очередь (просмотр блокировки)
Операция получает одно или несколько сообщений из очереди с блокировкой просмотра. Если максимальное число сообщений не указано, оно считывает 20 сообщений.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя очереди
|
queueName | True | string |
Название очереди |
|
Максимальное число сообщений
|
maxMessageCount | integer |
Максимальное количество сообщений, возвращаемых в пакете |
|
|
Тип очереди
|
queueType | string |
Тип очереди — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
Идентификатор сеанса — нет или следующий доступный или укажите идентификатор сеанса |
Возвращаемое значение
Сообщение служебной шины
- Тело
- ServiceBusMessage
При поступлении одного или нескольких сообщений в раздел (автоматическое завершение)
Операция получает одно или несколько сообщений из раздела. Если максимальное число сообщений не указано, оно считывает 20 сообщений.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
Максимальное число сообщений
|
maxMessageCount | integer |
Максимальное количество сообщений, возвращаемых в пакете |
|
|
Тип подписки
|
subscriptionType | string |
Тип подписки — Main или DeadLetter |
Возвращаемое значение
Сообщение служебной шины
- Тело
- ServiceBusMessage
При поступлении одного или нескольких сообщений в раздел (просмотр блокировки)
Операция получает одно или несколько сообщений из раздела с блокировкой просмотра. Если максимальное число сообщений не указано, оно считывает 20 сообщений.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя раздела
|
topicName | True | string |
Имя раздела |
|
Имя подписки раздела
|
subscriptionName | True | string |
Имя подписки раздела |
|
Максимальное число сообщений
|
maxMessageCount | integer |
Максимальное количество сообщений, возвращаемых в пакете |
|
|
Тип подписки
|
subscriptionType | string |
Тип подписки — Main или DeadLetter |
|
|
ИД сеанса
|
sessionId | string |
Идентификатор сеанса — нет или следующий доступный или укажите идентификатор сеанса |
Возвращаемое значение
Сообщение служебной шины
- Тело
- ServiceBusMessage
Определения
ServiceBusMessage
Сообщение служебной шины
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Content
|
ContentData | byte |
Содержимое сообщения |
|
Тип контента
|
ContentType | string |
Тип контента сообщения |
|
Свойства
|
Properties | object |
Пары "ключ-значение" для каждого свойства брокера |
|
Идентификатор сообщения
|
MessageId | string |
Это определяемое пользователем значение, которое служебная шина может использовать для идентификации повторяющихся сообщений, если они включены. |
|
Кому
|
To | string |
Отправка по адресу |
|
Ответить на
|
ReplyTo | string |
Адрес очереди для ответа |
|
Ответ на идентификатор сеанса
|
ReplyToSessionId | string |
Идентификатор сеанса для ответа |
|
Этикетка
|
Label | string |
Метка конкретного приложения |
|
ScheduledEnqueueTimeUtc
|
ScheduledEnqueueTimeUtc | date-time |
Дата и время в формате UTC, когда сообщение будет добавлено в очередь |
|
ИД сеанса
|
SessionId | string |
Идентификатор сеанса |
|
Идентификатор корреляции
|
CorrelationId | string |
Идентификатор корреляции |
|
Порядковый номер
|
SequenceNumber | integer |
Идентификатор номера последовательности |
|
Маркер блокировки
|
LockToken | string |
Маркер блокировки сообщения в виде строки. |
|
Время жизни
|
TimeToLive | integer |
Это длительность в галках, допустимая сообщение. Длительность начинается с момента отправки сообщения в служебную шину. |
Subscription
Подписка раздела.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Название подписки
|
SubscriptionName | string |
Имя подписки. |