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

Примечание

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

Для его установки используйте: 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	Варианты: 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` может быть использована для определения идентификатора подписки, если их несколько; в противном случае используется подписка по умолчанию Azure 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 целое число		Продолжительность TimeSpan блокировки peek. Время блокировки сообщения для других получателей. Максимальное значение для 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	успешно	Текущее состояние подписки. Пример: /subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/ namespaces/nsb57dc95979/topics/topicb57dc95979/subscriptions/subsb57dc95979

Авторы

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