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

Примечание

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

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

Чтобы использовать его в плейбуке, укажите: 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, или выполнить вход перед запуском задач или книги задач с помощью 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 строка	успешно	Текущее состояние очереди. Пример: /subscriptions/xxx...xxx/resourceGroups/v-xisuRG/providers/Microsoft.ServiceBus/namespaces/nsb57dc9561/queues/queueb57dc9561

Авторы

Yuwei Zhou (@yuwzho)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_servicebusqueue_module.html