azure_rm_servicebusqueue – Управление очередью Azure Service Bus
Новая версия с 2.8.
Обзор
- Создание, обновление или удаление очереди Azure Service Bus.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |
| adfs_authority_url строка добавлено в 2.6 | URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственном авторитете ADFS. | |
| api_profile строка добавлено в 2.5 | По умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags булево |
| Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source строка добавлено в 2.5 |
| Управление источником учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE, по умолчанию auto если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также можно установить через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке в msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID можно использовать для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi было добавлено в Ansible 2.6. |
| auto_delete_on_idle_in_seconds целое число | Интервал простоя, после которого очередь автоматически удаляется. Минимальная продолжительность - 5 минут. | |
| cert_validation_mode строка добавлено в 2.5 |
| Управление поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или Azure Stack может потребоваться отключить это поведение, передав ignore. Также можно установить через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используйте при аутентификации с сервисным принципалом. | |
| cloud_environment строка добавлено в 2.4 | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки доступа к метаданным (требуется для Azure Stack). Также можно установить через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| dead_lettering_on_message_expiration булево |
| Указывает, поддерживает ли очередь сортировку сообщений в случае истечения срока действия. |
| default_message_time_to_live_seconds целое число | Значение по умолчанию для временного интервала жизни сообщения. Это интервал, по истечении которого сообщение устаревает, начиная с момента отправки сообщения в Service Bus. Это значение по умолчанию используется, если TimeToLive не установлен для сообщения. | |
| duplicate_detection_time_in_seconds целое число | Структура TimeSpan, определяющая продолжительность истории обнаружения дубликатов. | |
| enable_batched_operations булево |
| Указывает, включены ли операции по пакетной обработке на стороне сервера. |
| enable_express булево |
| Указывает, включены ли Express Entities. Express-тема или очередь временно хранит сообщение в памяти, прежде чем записать его в постоянное хранилище. |
| enable_partitioning булево |
| Указывает, должна ли тема или очередь быть разделенной между несколькими брокерами сообщений. |
| forward_dead_lettered_messages_to - | Имя очереди или темы для перенаправления сообщения Dead Letter для очереди. | |
| forward_to - | Имя очереди или темы для перенаправления сообщений для очереди. | |
| lock_duration_in_seconds целое число | Длительность блокировки peek-lock. Время, в течение которого сообщение заблокировано для других получателей. Максимальное значение для LockDuration - 5 минут. | |
| max_delivery_count целое число | Максимальное количество поставок. Сообщение автоматически отправляется в Dead Letter после этого количества поставок. | |
| max_size_in_mb целое число | Максимальный размер очереди в мегабайтах, который соответствует объему выделенной памяти для очереди. | |
| name - / обязательно | Имя очереди. | |
| namespace - / обязательно | Имя пространства имен Service Bus. Пространство имен - это область видимости для всех компонентов обмена сообщениями. Несколько очередей и тем могут находиться в одном пространстве имен, и пространства имен часто служат контейнерами приложений. | |
| password - | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| requires_duplicate_detection булево |
| Указывает, требуется ли для этой очереди или темы обнаружение дубликатов. |
| requires_session булево |
| Указывает, поддерживает ли очередь концепцию сеансов. |
| resource_group - / обязательно | Имя группы ресурсов. | |
| secret строка | Секрет клиента Azure. Используйте при аутентификации с сервисным принципалом. | |
| state - |
| Утверждение состояния очереди. Используйте 'наличие' для создания или обновления и 'отсутствует' для удаления. |
| status - |
| Статус сущности. |
| subscription_id строка | Ваш идентификатор подписки Azure. |
| Теги словарь | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите опцию append_tags в значение false. | |
| арендатор строка | Идентификатор Azure-арендатора. Используется при аутентификации с помощью службы-принципала. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед выполнением задач или игры с
az login. - Аутентификация также возможна с помощью службы-принципала или пользователя Active Directory.
- Для аутентификации через службу-принципал передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
- Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
- В качестве альтернативы данные учетных данных могут храниться в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также возможно добавление дополнительных профилей. Укажите профиль, передав параметр profile или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход в систему с помощью Azure CLI
- Как выполнить аутентификацию с использованием команды
az login.
Примеры
- name: Create a queue
azure_rm_servicebusqueue:
name: subqueue
resource_group: myResourceGroup
namespace: bar
duplicate_detection_time_in_seconds: 600
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| id строка | успех | Текущее состояние очереди. |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Yuwei Zhou (@yuwzho)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_servicebusqueue_module.html
