azure.azcollection.azure_rm_servicebustopicsubscription – Управление подпиской Azure Service Bus

Примечание

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

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

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

Новое в версии 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 булево	Варианты: нет да ←	Управляет тем, будет ли поле тегов каноническим или просто добавляться к существующим тегам. При каноническом значении любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 из azure.azcollection	Варианты: авто ← 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_filter_evaluation_exceptions булево	Варианты: нет да	Значение, указывающее, поддерживает ли подписка механизм мертвых писем при исключениях фильтрации.
dead_lettering_on_message_expiration булево	Варианты: нет да	Значение, указывающее, поддерживает ли подписка механизм мертвых писем при истечении срока действия сообщения.
default_message_time_to_live_seconds целое число		Значение по умолчанию для срока жизни сообщения. Это период, по истечении которого сообщение истекает, начиная с момента отправки сообщения в Service Bus. Это значение по умолчанию используется, когда TimeToLive не задан для самого сообщения.
duplicate_detection_time_in_seconds целое число		Структура TimeSpan, определяющая длительность истории обнаружения дубликатов.
enable_batched_operations булево	Варианты: нет да	Значение, указывающее, включены ли пакетные операции на стороне сервера.
forward_dead_lettered_messages_to строка		Имя очереди или темы для перенаправления сообщений мертвых писем для подписки.
forward_to строка		Имя очереди или темы для перенаправления сообщений для подписки.
lock_duration_in_seconds целое число		Продолжительность временного интервала блокировки (peek-lock). Время, в течение которого сообщение заблокировано для других получателей. Максимальное значение LockDuration — 5 минут.
max_delivery_count целое число		Максимальное количество доставок. После этого количества доставок сообщение автоматически направляется в мертвые письма.
name строка / обязательно		Имя подписки servicebus.
namespace строка / обязательно		Имя пространства имен servicebus. Пространство имен — это контейнер для всех компонентов обмена сообщениями. В одном пространстве имен могут располагаться несколько подписок и тем, и пространства имен часто служат контейнерами приложений.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory вместо служебного принципала.
profile строка		Профиль безопасности, находящийся в файле ~/.azure/credentials.
requires_session булево	Варианты: нет да	Значение, указывающее, поддерживает ли подписка концепцию сеансов.
resource_group строка / обязательно		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используйте при аутентификации с помощью служебного принципала.
state строка	Варианты: absent present ←	Утвердите состояние подписки servicebus. Используйте `present` для создания или обновления и `absent` для удаления.
status строка	Варианты: active disabled send_disabled receive_disabled	Статус сущности.
subscription_id строка		Ваш идентификатор подписки Azure.
tags словарь		Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите опцию append_tags в false.
tenant строка		Идентификатор клиента Azure. Используйте при аутентификации с помощью служебного принципала.
topic строка / обязательно		Имя темы, к которой подписка подписана.

Примечания

Примечание

Для аутентификации в 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 subscription
  azure_rm_servicebustopicsubscription:
      name: sbsub
      resource_group: myResourceGroup
      namespace: bar
      topic: subtopic

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
id string	success	Текущее состояние подписки. Пример: /subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/ namespaces/nsb57dc95979/topics/topicb57dc95979/subscriptions/subsb57dc95979

Авторы

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_servicebustopicsubscription_module.html