azure_rm_servicebustopicsubscription – Управление подписками на 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 логическое значение	Варианты: no yes ←	Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source строка добавлено в 2.5	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная окружения 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	Варианты: ignore validate	Управляет поведением проверки сертификатов для 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_filter_evaluation_exceptions логическое значение	Варианты: no yes	Значение, указывающее, поддерживает ли подписка хранение сообщений в очереди "мёртвых писем" при ошибках оценки фильтра.
dead_lettering_on_message_expiration логическое значение	Варианты: no yes	Значение, указывающее, поддерживает ли подписка хранение сообщений в очереди "мёртвых писем" при истечении срока действия сообщения.
default_message_time_to_live_seconds целое число		Значение по умолчанию для срока жизни сообщения. Это продолжительность, по истечении которой сообщение истекает, начиная с момента отправки сообщения в Service Bus. Это значение по умолчанию используется, если для сообщения не задан срок жизни.
duplicate_detection_time_in_seconds целое число		Структура TimeSpan, определяющая продолжительность истории обнаружения дубликатов.
enable_batched_operations логическое значение	Варианты: no yes	Значение, указывающее, включены ли серверные пакетные операции.
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 логическое значение	Варианты: no yes	Значение, указывающее, поддерживает ли подписка концепцию сеансов.
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 строка	success	Текущее состояние подписки. Пример: /subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/ namespaces/nsb57dc95979/topics/topicb57dc95979/subscriptions/subsb57dc95979

Статус

Данному модулю не гарантируется обратная совместимость. [preview]
Этот модуль поддерживается сообществом 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.9/modules/azure_rm_servicebustopicsubscription_module.html