Spec-Zone.ru › Ansible 2.10

azure.azcollection.azure_rm_servicebusqueue – Управление очередью Azure Service Bus

Примечание

Этот плагин входит в состав коллекции azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в playbook укажите: azure.azcollection.azure_rm_servicebusqueue.

Новое в версии 0.1.2: из azure.azcollection

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Обзор

  • Создание, обновление или удаление очереди Azure Service Bus.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url
строка
добавлено в 0.0.1 azure.azcollection
URL авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизации ADFS.
api_profile
строка
добавлено в 0.0.1 azure.azcollection
По умолчанию:
"latest"
Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags
логическое
    Варианты:
  • no
  • да ←
Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам.
При каноническом поле теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Управление источником учетных данных для аутентификации.
Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При значении auto (по умолчанию) приоритет модуль параметров -> env -> credential_file -> cli.
При значении env, учетные данные будут считываться из переменных среды
При значении credential_file, профиль будет считан из ~/.azure/credentials.
При значении cli, учетные данные будут взяты из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если их несколько, в противном случае используется стандартная подписка az cli.
При значении msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка.
msi было добавлено в Ansible 2.6.
auto_delete_on_idle_in_seconds
целое число
Интервал простоя, после которого очередь автоматически удаляется.
Минимальная продолжительность — 5 минут.
cert_validation_mode
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • ignore
  • validate
Управление поведением проверки сертификатов для Azure-точке. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или в случае Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано в профиле файла учетных данных или переменной среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment
строка
добавлено в 0.0.1 azure.azcollection
По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment ) или URL конечной точки обнаружения метаданных (необходимо для Azure Stack). Также может быть задано в профиле файла учетных данных или переменной среды AZURE_CLOUD_ENVIRONMENT.
dead_lettering_on_message_expiration
логическое
    Варианты:
  • no
  • yes
Указывает, поддерживает ли очередь функции обработки сообщений с истекшим сроком действия.
default_message_time_to_live_seconds
целое число
Значение по умолчанию для срока действия сообщения.
Это период, после которого сообщение истекает, начиная с момента отправки сообщения в Service Bus.
Это значение по умолчанию используется, когда TimeToLive не задано для сообщения.
duplicate_detection_time_in_seconds
целое число
Структура TimeSpan, определяющая продолжительность истории обнаружения дубликатов.
enable_batched_operations
логическое
    Варианты:
  • no
  • yes
Указывает, включены ли операции с пакетной обработкой на стороне сервера.
enable_express
логическое
    Варианты:
  • no
  • yes
Указывает, включены ли экспресс-сущности.
Экспресс-тема или очередь временно хранят сообщение в памяти, прежде чем записать его в постоянное хранилище.
enable_partitioning
логическое
    Варианты:
  • no
  • yes
Указывает, должна ли тема или очередь быть разделена по нескольким брокерам сообщений.
forward_dead_lettered_messages_to
строка
Имя очереди или темы, куда перенаправлять сообщения с истекшим сроком действия для очереди.
forward_to
строка
Имя очереди или темы, куда перенаправлять сообщения для очереди.
lock_duration_in_seconds
целое число
Продолжительность блокировки при использовании peek-lock.
Время, в течение которого сообщение заблокировано для других получателей.
Максимальное значение для LockDuration — 5 минут.
max_delivery_count
целое число
Максимальное количество доставок.
Сообщение автоматически перенаправляется в очередь сообщений с истекшим сроком действия после этого количества доставок.
max_size_in_mb
целое число
Максимальный размер очереди в мегабайтах, представляющий объем выделенной памяти для очереди.
name
строка / обязательно
Имя очереди.
namespace
строка / обязательно
Имя пространства имен Servicebus.
Пространство имен — контейнер для всех компонентов обмена сообщениями.
В одном пространстве имен могут находиться несколько очередей и тем, и пространства имен часто служат контейнерами для приложений.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile
строка
Профиль безопасности, находящийся в файле ~/.azure/credentials.
requires_duplicate_detection
логическое
    Варианты:
  • no
  • yes
Указывает, требуется ли для этой очереди или темы обнаружение дубликатов.
requires_session
логическое
    Варианты:
  • no
  • yes
Указывает, поддерживает ли очередь концепцию сеансов.
resource_group
строка / обязательно
Имя группы ресурсов.
secret
строка
Секрет клиента Azure. Используется при аутентификации с принципалом службы.
state
строка
    Варианты:
  • absent
  • present ←
Утверждение состояния очереди. Используйте present, чтобы создать или обновить, и absent, чтобы удалить.
status
строка
    Варианты:
  • active
  • disabled
  • send_disabled
  • receive_disabled
Статус сущности.
subscription_id
строка
Идентификатор вашей подписки Azure.
tags
словарь
Словарь пар строка:строка для назначения метаданных объекту.
Метаданные теги объекта будут обновлены предоставленными значениями.
Для удаления тегов установите параметр append_tags в false.
tenant
строка
Идентификатор Azure-тенанта. Используется при аутентификации с принципалом службы.

Примечания

Примечание

  • Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или playbook с помощью 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
успех
Текущее состояние очереди.

Пример:
/subscriptions/xxx...xxx/resourceGroups/v-xisuRG/providers/Microsoft.ServiceBus/namespaces/nsb57dc9561/queues/queueb57dc9561


Авторы

  • 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.10/collections/azure/azcollection/azure_rm_servicebusqueue_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API