Пространства имен и очереди Microsoft.ServiceBus
Определение ресурса Bicep
Тип ресурса пространства имен или очередей можно развернуть в следующих объектах:
- Группы ресурсов — см. команды развертывания групп ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.ServiceBus/namespaces/queues, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ServiceBus/namespaces/queues@2022-01-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
autoDeleteOnIdle: 'string'
deadLetteringOnMessageExpiration: bool
defaultMessageTimeToLive: 'string'
duplicateDetectionHistoryTimeWindow: 'string'
enableBatchedOperations: bool
enableExpress: bool
enablePartitioning: bool
forwardDeadLetteredMessagesTo: 'string'
forwardTo: 'string'
lockDuration: 'string'
maxDeliveryCount: int
maxMessageSizeInKilobytes: int
maxSizeInMegabytes: int
requiresDuplicateDetection: bool
requiresSession: bool
status: 'string'
}
}
Значения свойств
namespaces/queues
| Имя | Описание | Значение |
|---|---|---|
| name | имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep. |
string (обязательно) Ограничение символов: 1–260 Допустимые символы: Буквенно-цифровые символы, точки, дефисы, символы подчеркивания и косые черты. Начинается и закачивается буквенно-цифровым символом. |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: пространства имен |
| properties | Свойства очереди | SBQueueProperties |
SBQueueProperties
| Имя | Описание | Значение |
|---|---|---|
| autoDeleteOnIdle | Интервал времени простоя по стандарту ISO 8061, по истечении которого очередь автоматически удаляется. Минимальная длительность составляет 5 минут. | строка |
| deadLetteringOnMessageExpiration | Значение типа , указывающее, поддерживает ли эта очередь недоставленные письма по истечении срока действия сообщения. | bool |
| defaultMessageTimeToLive | Время действия сообщения по умолчанию по стандарту ISO 8601 — динамическое значение. Это время, по истечении которого истекает срок действия сообщения, начиная с момента отправки сообщения в служебную шину. Это значение по умолчанию используется, если TimeToLive не задано для самого сообщения. | строка |
| duplicateDetectionHistoryTimeWindow | Iso 8601 timeSpan структура, которая определяет длительность журнала обнаружения дубликатов. Значение по умолчанию — 10 минут. | строка |
| enableBatchedOperations | Значение, указывающее, включены ли пакетные операции на стороне сервера. | bool |
| enableExpress | Значение типа , указывающее, включены ли экспресс-сущности. Экспресс-очередь временно хранит сообщение в памяти, прежде чем записывать его в постоянное хранилище. | bool |
| enablePartitioning | Значение типа , указывающее, следует ли секционировать очередь по нескольким брокерам сообщений. | bool |
| forwardDeadLetteredMessagesTo | Имя очереди или раздела для пересылки сообщения недоставленных сообщений | строка |
| forwardTo | Имя очереди или раздела для пересылки сообщений | строка |
| lockDuration | По стандарту ISO 8601— длительность блокировки при просмотре; то есть время, в течение которого сообщение блокируется для других получателей. Максимальное значение параметра LockDuration — 5 минут; Значение по умолчанию — 1 минута. | строка |
| maxDeliveryCount | Максимальное число доставок. Сообщение автоматически считается недоставленным после этого числа доставок. Значение по умолчанию — 10. | INT |
| maxMessageSizeInKilobytes | Максимальный размер (в КБ) полезных данных сообщения, которые могут быть приняты очередью. Сейчас это свойство используется только в premium и по умолчанию — 1024. | INT |
| maxSizeInMegabytes | Максимальный размер очереди в мегабайтах, то есть объем памяти, выделенной для очереди. Значение по умолчанию — 1024. | INT |
| requiresDuplicateDetection | Значение, указывающее, требуется ли для этой очереди обнаружение дубликатов. | bool |
| requiresSession | Значение типа , указывающее, поддерживает ли очередь концепцию сеансов. | bool |
| status | Перечисляет возможные значения для состояния сущности обмена сообщениями. | "Активный" "Создание" Удаление "Отключено" ReceiveDisabled "Переименование" Восстановление SendDisabled "Неизвестно" |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
Создание Сетка событий Azure настраиваемой подписки на раздел и очередь |
Создает Сетка событий Azure настраиваемый раздел и подписку очереди служебной шины. Шаблон, автор : Маркус Мейер. |
| Создание пространства имен и правила авторизации очереди служебной шины |
Этот шаблон позволяет развернуть пространство имен служебной шины уровня "Стандартный" и правила авторизации как для пространства имен, так и для очереди. |
| Создание пространства имен и очереди служебной шины |
Этот шаблон позволяет развернуть пространство имен служебной шины уровня "Стандартный" и очередь. |
Определение ресурса шаблона ARM
Тип ресурса namespaces/queues можно развернуть в:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.ServiceBus/namespaces/queues, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ServiceBus/namespaces/queues",
"apiVersion": "2022-01-01-preview",
"name": "string",
"properties": {
"autoDeleteOnIdle": "string",
"deadLetteringOnMessageExpiration": "bool",
"defaultMessageTimeToLive": "string",
"duplicateDetectionHistoryTimeWindow": "string",
"enableBatchedOperations": "bool",
"enableExpress": "bool",
"enablePartitioning": "bool",
"forwardDeadLetteredMessagesTo": "string",
"forwardTo": "string",
"lockDuration": "string",
"maxDeliveryCount": "int",
"maxMessageSizeInKilobytes": "int",
"maxSizeInMegabytes": "int",
"requiresDuplicateDetection": "bool",
"requiresSession": "bool",
"status": "string"
}
}
Значения свойств
namespaces/queues
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | Microsoft.ServiceBus/namespaces/queues |
| версия_API | Версия API ресурсов | '01.01.2022-preview' |
| name | имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM. |
строка (обязательно) Ограничение символов: 1–260 Допустимые символы: Буквенно-цифровые символы, точки, дефисы, символы подчеркивания и косые черты. Начинается и закачивается буквенно-цифровым символом. |
| properties | Свойства очереди | SBQueueProperties |
SBQueueProperties
| Имя | Описание | Значение |
|---|---|---|
| autoDeleteOnIdle | Iso 8061 timeSpan простой интервал, по истечении которого очередь автоматически удаляется. Минимальная длительность составляет 5 минут. | строка |
| deadLetteringOnMessageExpiration | Значение типа , указывающее, поддерживается ли в этой очереди поддержка недоставленных сообщений по истечении срока действия сообщения. | bool |
| defaultMessageTimeToLive | По умолчанию используется временной диапазон сообщений iso 8601 для динамического значения. Это время, по истечении которого истекает срок действия сообщения, начиная с момента отправки сообщения в служебную шину. Это значение по умолчанию используется, если timeToLive не задано для самого сообщения. | строка |
| duplicateDetectionHistoryTimeWindow | Iso 8601 timeSpan структура, которая определяет продолжительность журнала обнаружения дубликатов. Значение по умолчанию — 10 минут. | строка |
| enableBatchedOperations | Значение, указывающее, включены ли пакетные операции на стороне сервера. | bool |
| enableExpress | Значение типа , указывающее, включены ли экспресс-сущности. Экспресс-очередь временно хранит сообщение в памяти перед его записью в постоянное хранилище. | bool |
| enablePartitioning | Значение типа , указывающее, следует ли секционировать очередь между несколькими брокерами сообщений. | bool |
| forwardDeadLetteredMessagesTo | Имя очереди или раздела для пересылки сообщения недоставленных сообщений | строка |
| forwardTo | Имя очереди или раздела для пересылки сообщений | строка |
| lockDuration | Продолжительность интервала времени iso 8601 для просмотра и блокировки; то есть количество времени, в течение времени, когда сообщение блокируется для других получател Максимальное значение параметра LockDuration — 5 минут; Значение по умолчанию — 1 минута. | строка |
| maxDeliveryCount | Максимальное число доставок. Сообщение автоматически считается недоставленным после этого числа доставок. Значение по умолчанию — 10. | INT |
| maxMessageSizeInKilobytes | Максимальный размер (в КБ) полезных данных сообщения, которые могут быть приняты очередью. Сейчас это свойство используется только в premium и по умолчанию — 1024. | INT |
| maxSizeInMegabytes | Максимальный размер очереди в мегабайтах, то есть размер памяти, выделенной для очереди. Значение по умолчанию — 1024. | INT |
| requiresDuplicateDetection | Значение, указывающее, требуется ли для этой очереди обнаружение повторяющихся данных. | bool |
| requiresSession | Значение типа , указывающее, поддерживает ли очередь концепцию сеансов. | bool |
| status | Перечисляет возможные значения для состояния сущности обмена сообщениями. | "Активный" "Создание" Удаление "Отключено" ReceiveDisabled "Переименование" Восстановление SendDisabled "Неизвестно" |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
| Создание Сетка событий Azure настраиваемой подписки на раздел и очередь |
Создает Сетка событий Azure настраиваемый раздел и подписку очереди служебной шины. Шаблон, автор : Маркус Мейер. |
| Создание пространства имен и правила авторизации очереди служебной шины |
Этот шаблон позволяет развернуть пространство имен служебной шины уровня "Стандартный" и правила авторизации как для пространства имен, так и для очереди. |
| Создание пространства имен и очереди служебной шины |
Этот шаблон позволяет развернуть пространство имен служебной шины уровня "Стандартный" и очередь. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса namespaces/queues можно развернуть в:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.ServiceBus/namespaces/queues, добавьте в шаблон следующую terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ServiceBus/namespaces/queues@2022-01-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
autoDeleteOnIdle = "string"
deadLetteringOnMessageExpiration = bool
defaultMessageTimeToLive = "string"
duplicateDetectionHistoryTimeWindow = "string"
enableBatchedOperations = bool
enableExpress = bool
enablePartitioning = bool
forwardDeadLetteredMessagesTo = "string"
forwardTo = "string"
lockDuration = "string"
maxDeliveryCount = int
maxMessageSizeInKilobytes = int
maxSizeInMegabytes = int
requiresDuplicateDetection = bool
requiresSession = bool
status = "string"
}
})
}
Значения свойств
namespaces/queues
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ServiceBus/namespaces/queues@2022-01-01-preview" |
| name | имя ресурса. | строка (обязательно) Ограничение символов: 1–260 Допустимые символы: Буквенно-цифровые символы, точки, дефисы, символы подчеркивания и косые черты. Начинается и закачивается буквенно-цифровым символом. |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: пространства имен |
| properties | Свойства очереди | SBQueueProperties |
SBQueueProperties
| Имя | Описание | Значение |
|---|---|---|
| autoDeleteOnIdle | Iso 8061 timeSpan простой интервал, по истечении которого очередь автоматически удаляется. Минимальная длительность составляет 5 минут. | строка |
| deadLetteringOnMessageExpiration | Значение типа , указывающее, поддерживается ли в этой очереди поддержка недоставленных сообщений по истечении срока действия сообщения. | bool |
| defaultMessageTimeToLive | По умолчанию используется временной диапазон сообщений iso 8601 для динамического значения. Это время, по истечении которого истекает срок действия сообщения, начиная с момента отправки сообщения в служебную шину. Это значение по умолчанию используется, если timeToLive не задано для самого сообщения. | строка |
| duplicateDetectionHistoryTimeWindow | Iso 8601 timeSpan структура, которая определяет продолжительность журнала обнаружения дубликатов. Значение по умолчанию — 10 минут. | строка |
| enableBatchedOperations | Значение, указывающее, включены ли пакетные операции на стороне сервера. | bool |
| enableExpress | Значение типа , указывающее, включены ли экспресс-сущности. Экспресс-очередь временно хранит сообщение в памяти перед его записью в постоянное хранилище. | bool |
| enablePartitioning | Значение типа , указывающее, следует ли секционировать очередь между несколькими брокерами сообщений. | bool |
| forwardDeadLetteredMessagesTo | Имя очереди или раздела для пересылки сообщения недоставленных сообщений | строка |
| forwardTo | Имя очереди или раздела для пересылки сообщений | строка |
| lockDuration | Продолжительность интервала времени iso 8601 для просмотра и блокировки; то есть количество времени, в течение времени, когда сообщение блокируется для других получател Максимальное значение параметра LockDuration — 5 минут; Значение по умолчанию — 1 минута. | строка |
| maxDeliveryCount | Максимальное число доставок. Сообщение автоматически считается недоставленным после этого числа доставок. Значение по умолчанию — 10. | INT |
| maxMessageSizeInKilobytes | Максимальный размер (в КБ) полезных данных сообщения, которые могут быть приняты очередью. Сейчас это свойство используется только в premium и по умолчанию — 1024. | INT |
| maxSizeInMegabytes | Максимальный размер очереди в мегабайтах, то есть объем памяти, выделенной для очереди. Значение по умолчанию — 1024. | INT |
| requiresDuplicateDetection | Значение, указывающее, требуется ли для этой очереди обнаружение дубликатов. | bool |
| requiresSession | Значение типа , указывающее, поддерживает ли очередь концепцию сеансов. | bool |
| status | Перечисляет возможные значения для состояния сущности обмена сообщениями. | "Активный" "Создание" "Удаление" "Отключено" "ReceiveDisabled" "Переименование" "Восстановление" SendDisabled "Неизвестно" |