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 - |
| Утвердите состояние темы. Используйте present для создания или обновления и absent для удаления. |
| 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 | Текущее состояние темы. Пример: /subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/nsb57dc95979/topics/topicb57dc95979 |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_servicebustopic_module.html
