azure_rm_servicebustopic – Управление темами 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 логическое значение |
| Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source строка добавлен в 2.5 |
| Управляет источником используемых учетных данных для аутентификации. Если не указано, будет использована переменная среды 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 |
| Управляет поведением проверки сертификата для 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. |
| default_message_time_to_live_seconds целое число | Значение временного интервала по умолчанию для срока жизни сообщения. Это продолжительность, после которой сообщение истекает, начиная с момента отправки сообщения в Service Bus. Это значение по умолчанию используется, если TimeToLive не задан для самого сообщения. | |
| duplicate_detection_time_in_seconds целое число | Структура TimeSpan, определяющая продолжительность истории обнаружения дубликатов. | |
| enable_batched_operations логическое значение |
| Значение, указывающее, включены ли пакетные операции на стороне сервера. |
| enable_express логическое значение |
| Значение, указывающее, включены ли Express-сущности. Тема Express временно хранит сообщение в памяти перед записью в постоянное хранилище. |
| enable_partitioning логическое значение |
| Значение, указывающее, разделена ли тема на несколько брокеров сообщений. |
| max_size_in_mb целое число | Максимальный размер темы в мегабайтах, который соответствует размеру выделенной памяти для темы. | |
| name - / обязательно | Название темы. | |
| namespace - / обязательно | Имя пространства имен Service Bus. Пространство имен — это контейнер для всех компонентов обмена сообщениями. В одном пространстве имен могут располагаться несколько тем. | |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным сервисом. | |
| profile строка | Профиль безопасности в файле ~/.azure/credentials. | |
| requires_duplicate_detection логическое значение |
| Значение, указывающее, требуется ли для данной темы обнаружение дубликатов. |
| resource_group - / обязательно | Имя группы ресурсов. | |
| secret строка | Секретный ключ клиента Azure. Используется при аутентификации с помощью главного сервиса. | |
| state - |
| Утверждение состояния темы. Используйте 'существует' для создания или обновления, и 'отсутствует' для удаления. |
| status - |
| Статус сущности. |
| subscription_id строка | Идентификатор вашей Azure-подписки. | |
| support_ordering логическое значение |
| Значение, указывающее, поддерживает ли тема порядок. |
| 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 topic
azure_rm_servicebustopic:
name: subtopic
resource_group: myResourceGroup
namespace: bar
duplicate_detection_time_in_seconds: 600
Значения возврата
Общие значения возврата описаны здесь, ниже представлены поля, уникальные для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| id строка | success | Текущее состояние темы. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/azure_rm_servicebustopic_module.html
