Пространства имен Microsoft.ServiceBus и очереди 2023-01-01-preview
Определение ресурсов Bicep
Тип ресурса пространства имен или очередей можно развернуть с помощью операций, предназначенных для следующих целей:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ServiceBus/namespaces/queues, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ServiceBus/namespaces/queues@2023-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'
}
}
Значения свойств
пространства имен и очереди
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в Bicep. |
строка (обязательно) Ограничение символов: 1–260 Допустимые символы: Буквенно-цифровые символы, периоды, дефисы, подчеркивания и косая черта. Начало и конец буквенно-цифровым. |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: пространства имен |
| свойства | Свойства очереди | SBQueueProperties |
SBQueueProperties
| Имя | Описание | Ценность |
|---|---|---|
| autoDeleteOnIdle | Интервал простоя области времени ISO 8061, после которого очередь автоматически удаляется. Минимальная длительность составляет 5 минут. | струна |
| deadLetteringOnMessageExpiration | Значение, указывающее, поддерживает ли эта очередь недоставленную букву при истечении срока действия сообщения. | bool |
| defaultMessageTimeToLive | По умолчанию для интервала времени сообщения ISO 8601 в режиме реального времени. Это длительность, после которой истекает срок действия сообщения, начиная с момента отправки сообщения в служебную шину. Это значение по умолчанию, используемое, если TimeToLive не задан в самом сообщении. | струна |
| duplicateDetectionHistoryTimeWindow | Структура интервала времени ISO 8601, определяющая длительность журнала обнаружения дубликата. Значение по умолчанию — 10 минут. | струна |
| enableBatchedOperations | Значение, указывающее, включены ли пакетные операции на стороне сервера. | bool |
| enableExpress | Значение, указывающее, включены ли сущности Express. Экспресс-очередь временно хранит сообщение в памяти перед записью в постоянное хранилище. | bool |
| enablePartitioning | Значение, указывающее, следует ли секционировать очередь по нескольким брокерам сообщений. | bool |
| forwardDeadLetteredMessagesTo | Имя очереди и раздела для пересылки сообщения "Недоставленная буква" | струна |
| forwardTo | Имя очереди и раздела для пересылки сообщений | струна |
| lockDuration | Длительность интервала времени ISO 8601 при просмотре блокировки; т. е. время блокировки сообщения для других получателей. Максимальное значение для LockDuration составляет 5 минут; Значение по умолчанию — 1 минуту. | струна |
| maxDeliveryCount | Максимальное число доставки. После этого количества поставок сообщение автоматически становится недоставленным. Значение по умолчанию — 10. | int |
| maxMessageSizeInKilobytes | Максимальный размер (в КБ) полезных данных сообщения, которые можно принять в очереди. Это свойство используется только в Premium сегодня, а по умолчанию — 1024. | int |
| maxSizeInMegabytes | Максимальный размер очереди в мегабайтах, который является размером памяти, выделенной для очереди. Значение по умолчанию — 1024. | int |
| requiresDuplicateDetection | Значение, указывающее, требуется ли для этой очереди обнаружение повторяющихся данных. | bool |
| требуетсяSession | Значение, указывающее, поддерживает ли очередь концепцию сеансов. | bool |
| статус | Перечисляет возможные значения состояния сущности обмена сообщениями. | "Активный" Создание Удаление "Отключено" "ReceiveDisabled" Переименование Восстановление SendDisabled "Неизвестно" |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
|
создание настраиваемой темы сетки событий Azure и подписки на очередь развертывание  |
Создает настраиваемый раздел Сетки событий Azure и подписку очереди служебной шины. Шаблон первоначально создан Маркусом Мейером. |
|
Создание пространства имен служебной шины и правила авторизации очереди развертывание |
Этот шаблон позволяет развертывать пространство имен служебной шины уровня "Стандартный" и правила авторизации для пространства имен и очереди. |
|
создание пространства имен служебной шины и очереди развертывание |
Этот шаблон позволяет развернуть пространство имен служебной шины уровня "Стандартный" и очередь. |
Определение ресурса шаблона ARM
Тип ресурса пространства имен или очередей можно развернуть с помощью операций, предназначенных для следующих целей:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ServiceBus/namespaces/queues, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ServiceBus/namespaces/queues",
"apiVersion": "2023-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"
}
}
Значения свойств
пространства имен и очереди
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ServiceBus/namespaces/queues" |
| apiVersion | Версия API ресурсов | '2023-01-01-preview' |
| имя | Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON. |
строка (обязательно) Ограничение символов: 1–260 Допустимые символы: Буквенно-цифровые символы, периоды, дефисы, подчеркивания и косая черта. Начало и конец буквенно-цифровым. |
| свойства | Свойства очереди | SBQueueProperties |
SBQueueProperties
| Имя | Описание | Ценность |
|---|---|---|
| autoDeleteOnIdle | Интервал простоя области времени ISO 8061, после которого очередь автоматически удаляется. Минимальная длительность составляет 5 минут. | струна |
| deadLetteringOnMessageExpiration | Значение, указывающее, поддерживает ли эта очередь недоставленную букву при истечении срока действия сообщения. | bool |
| defaultMessageTimeToLive | По умолчанию для интервала времени сообщения ISO 8601 в режиме реального времени. Это длительность, после которой истекает срок действия сообщения, начиная с момента отправки сообщения в служебную шину. Это значение по умолчанию, используемое, если TimeToLive не задан в самом сообщении. | струна |
| duplicateDetectionHistoryTimeWindow | Структура интервала времени ISO 8601, определяющая длительность журнала обнаружения дубликата. Значение по умолчанию — 10 минут. | струна |
| enableBatchedOperations | Значение, указывающее, включены ли пакетные операции на стороне сервера. | bool |
| enableExpress | Значение, указывающее, включены ли сущности Express. Экспресс-очередь временно хранит сообщение в памяти перед записью в постоянное хранилище. | bool |
| enablePartitioning | Значение, указывающее, следует ли секционировать очередь по нескольким брокерам сообщений. | bool |
| forwardDeadLetteredMessagesTo | Имя очереди и раздела для пересылки сообщения "Недоставленная буква" | струна |
| forwardTo | Имя очереди и раздела для пересылки сообщений | струна |
| lockDuration | Длительность интервала времени ISO 8601 при просмотре блокировки; т. е. время блокировки сообщения для других получателей. Максимальное значение для LockDuration составляет 5 минут; Значение по умолчанию — 1 минуту. | струна |
| maxDeliveryCount | Максимальное число доставки. После этого количества поставок сообщение автоматически становится недоставленным. Значение по умолчанию — 10. | int |
| maxMessageSizeInKilobytes | Максимальный размер (в КБ) полезных данных сообщения, которые можно принять в очереди. Это свойство используется только в Premium сегодня, а по умолчанию — 1024. | int |
| maxSizeInMegabytes | Максимальный размер очереди в мегабайтах, который является размером памяти, выделенной для очереди. Значение по умолчанию — 1024. | int |
| requiresDuplicateDetection | Значение, указывающее, требуется ли для этой очереди обнаружение повторяющихся данных. | bool |
| требуетсяSession | Значение, указывающее, поддерживает ли очередь концепцию сеансов. | bool |
| статус | Перечисляет возможные значения состояния сущности обмена сообщениями. | "Активный" Создание Удаление "Отключено" "ReceiveDisabled" Переименование Восстановление SendDisabled "Неизвестно" |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
|
создание настраиваемой темы сетки событий Azure и подписки на очередь развертывание |
Создает настраиваемый раздел Сетки событий Azure и подписку очереди служебной шины. Шаблон первоначально создан Маркусом Мейером. |
|
Создание пространства имен служебной шины и правила авторизации очереди развертывание |
Этот шаблон позволяет развертывать пространство имен служебной шины уровня "Стандартный" и правила авторизации для пространства имен и очереди. |
|
создание пространства имен служебной шины и очереди развертывание |
Этот шаблон позволяет развернуть пространство имен служебной шины уровня "Стандартный" и очередь. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса пространства имен или очередей можно развернуть с помощью операций, предназначенных для следующих целей:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ServiceBus/namespaces/queues, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ServiceBus/namespaces/queues@2023-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"
}
})
}
Значения свойств
пространства имен и очереди
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ServiceBus/namespaces/queues@2023-01-01-preview" |
| имя | Имя ресурса | строка (обязательно) Ограничение символов: 1–260 Допустимые символы: Буквенно-цифровые символы, периоды, дефисы, подчеркивания и косая черта. Начало и конец буквенно-цифровым. |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: пространства имен |
| свойства | Свойства очереди | SBQueueProperties |
SBQueueProperties
| Имя | Описание | Ценность |
|---|---|---|
| autoDeleteOnIdle | Интервал простоя области времени ISO 8061, после которого очередь автоматически удаляется. Минимальная длительность составляет 5 минут. | струна |
| deadLetteringOnMessageExpiration | Значение, указывающее, поддерживает ли эта очередь недоставленную букву при истечении срока действия сообщения. | bool |
| defaultMessageTimeToLive | По умолчанию для интервала времени сообщения ISO 8601 в режиме реального времени. Это длительность, после которой истекает срок действия сообщения, начиная с момента отправки сообщения в служебную шину. Это значение по умолчанию, используемое, если TimeToLive не задан в самом сообщении. | струна |
| duplicateDetectionHistoryTimeWindow | Структура интервала времени ISO 8601, определяющая длительность журнала обнаружения дубликата. Значение по умолчанию — 10 минут. | струна |
| enableBatchedOperations | Значение, указывающее, включены ли пакетные операции на стороне сервера. | bool |
| enableExpress | Значение, указывающее, включены ли сущности Express. Экспресс-очередь временно хранит сообщение в памяти перед записью в постоянное хранилище. | bool |
| enablePartitioning | Значение, указывающее, следует ли секционировать очередь по нескольким брокерам сообщений. | bool |
| forwardDeadLetteredMessagesTo | Имя очереди и раздела для пересылки сообщения "Недоставленная буква" | струна |
| forwardTo | Имя очереди и раздела для пересылки сообщений | струна |
| lockDuration | Длительность интервала времени ISO 8601 при просмотре блокировки; т. е. время блокировки сообщения для других получателей. Максимальное значение для LockDuration составляет 5 минут; Значение по умолчанию — 1 минуту. | струна |
| maxDeliveryCount | Максимальное число доставки. После этого количества поставок сообщение автоматически становится недоставленным. Значение по умолчанию — 10. | int |
| maxMessageSizeInKilobytes | Максимальный размер (в КБ) полезных данных сообщения, которые можно принять в очереди. Это свойство используется только в Premium сегодня, а по умолчанию — 1024. | int |
| maxSizeInMegabytes | Максимальный размер очереди в мегабайтах, который является размером памяти, выделенной для очереди. Значение по умолчанию — 1024. | int |
| requiresDuplicateDetection | Значение, указывающее, требуется ли для этой очереди обнаружение повторяющихся данных. | bool |
| требуетсяSession | Значение, указывающее, поддерживает ли очередь концепцию сеансов. | bool |
| статус | Перечисляет возможные значения состояния сущности обмена сообщениями. | "Активный" Создание "Удаление" "Отключено" "ReceiveDisabled" "Переименование" Восстановление SendDisabled "Неизвестно" |