Модуль azure.azcollection.azure_rm_servicebusqueue – Управление очередью Azure Service Bus
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_servicebusqueue.
Новая в azure.azcollection 0.1.2
Описание
- Создание, обновление или удаление очереди Azure Service Bus.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты python, перечисленные в requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в
Варианты:
|
auto_delete_on_idle_in_seconds integer | Интервал простоя, после которого очередь автоматически удаляется. Минимальная продолжительность составляет 5 минут. |
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в отношении Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Также может быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
dead_lettering_on_message_expiration boolean | Значение, указывающее, поддерживает ли очередь поддержку писем о недоставке при истечении срока действия сообщения. Варианты:
|
default_message_time_to-live_seconds integer | Значение времени существования сообщения по умолчанию. Это продолжительность, после которой сообщение истекает, начиная с момента отправки сообщения в Service Bus. Это значение по умолчанию используется, когда TimeToLive не установлен в самом сообщении. |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате крайне важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
duplicate_detection_time_in_seconds integer | Структура TimeSpan, которая определяет продолжительность истории обнаружения дубликатов. |
enable_batched_operations boolean | Значение, указывающее, включены ли серверные пакетные операции. Варианты:
|
enable_express boolean | Значение, указывающее, включены ли сущности Express. Тема или очередь Express временно хранит сообщение в памяти перед записью в постоянное хранилище. Варианты:
|
enable_partitioning boolean | Значение, указывающее, будет ли тема или очередь распределена по нескольким брокерам сообщений. Варианты:
|
forward_dead_lettered_messages_to string | Имя очереди или темы для переадресации сообщения Dead Letter для очереди. |
forward_to string | Имя очереди или темы для переадресации сообщений для очереди. |
lock_duration_in_seconds integer | Продолжительность временного интервала блокировки peek-lock. Время, в течение которого сообщение заблокировано для других получателей. Максимальное значение для LockDuration составляет 5 минут. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
max_delivery_count integer | Максимальное количество поставок. Сообщение автоматически переводится в состояние deadletter после этого количества поставок. |
max_message_size_in_kb integer | Максимальный размер (в КБ) полезной нагрузки сообщения, который может принять очередь. Это свойство используется только в Премиум-версии в настоящее время, а значение по умолчанию равно 1024. |
max_size_in_mb integer | Максимальный размер очереди в мегабайтах, который представляет собой размер выделенной памяти для очереди. |
name string / обязательно | Имя очереди. |
namespace string / обязательно | Имя пространства имен Servicebus. Пространство имен — это контейнер для всех компонентов обмена сообщениями. В одном пространстве имен могут находиться несколько очередей и тем, и пространства имен часто используются как контейнеры приложений. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory вместо управляющего принципа. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
requires_duplicate_detection boolean | Значение, указывающее, требуется ли для этой очереди или темы обнаружение дубликатов. Варианты:
|
requires_session boolean | Значение, указывающее, поддерживает ли очередь концепцию сессий. Варианты:
|
resource_group string / обязательно | Имя группы ресурсов. |
secret string | Секрет Azure-клиента. Используется при аутентификации с помощью управляющего принципа. |
state string | Утверждение состояния очереди. Используйте Варианты:
|
status string | Статус сущности. Варианты:
|
subscription_id string | Ваш идентификатор подписки Azure. |
tenant string | Идентификатор Azure-аренды. Используется при аутентификации с помощью управляющего принципа. |
thumbprint string added in azure.azcollection 1.14.0 | Отпечаток пальца закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью принципала службы. Требуется, если определён параметр x509_certificate_path. |
x509_certificate_path path added in azure.azcollection 1.14.0 | Путь к X509-сертификату, используемому для создания принципала службы в формате PEM. Сертификат должен быть присоединён к закрытому ключу. Используется при аутентификации с помощью принципала службы. |
Примечания
Примечание
- Для аутентификации с 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 string | Текущее состояние очереди. Возвращается: success Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_servicebusqueue_module.html