azure.azcollection.azure_rm_servicebustopic – Управление Azure Service Bus
Примечание
Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в playbook, укажите: azure.azcollection.azure_rm_servicebustopic.
Новый в версии 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 |
| Управляет источником учетных данных для аутентификации. Также может быть задано через переменную среды 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 |
| Управляет поведением проверки сертификатов для 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. |
| default_message_time_to_live_seconds целое число | Значение по умолчанию для тайм-спана ожидания сообщения. Это период времени, по истечении которого сообщение истекает, начиная с момента отправки сообщения в Service Bus. Это значение по умолчанию используется, когда TimeToLive не задано для самого сообщения. | |
| duplicate_detection_time_in_seconds целое число | Структура TimeSpan, определяющая продолжительность истории обнаружения дубликатов. | |
| enable_batched_operations булево |
| Значение, указывающее, включены ли пакетные операции на сервере. |
| enable_express булево |
| Значение, указывающее, включены ли Express Entities. Тема express временно хранит сообщение в памяти, прежде чем записать его в постоянное хранилище. |
| enable_partitioning булево |
| Значение, указывающее, будет ли тема распределена по нескольким брокерам сообщений. |
| max_size_in_mb целое число | Максимальный размер темы в мегабайтах, который соответствует объему выделенной памяти для темы. | |
| name строка / обязательно | Имя темы. | |
| namespace строка / обязательно | Имя пространства имен Servicebus. Пространство имен — контейнер, определяющий область действия всех компонентов обмена сообщениями. Несколько тем могут находиться в одном пространстве имен. | |
| 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 строка | успех | Текущее состояние темы. Пример: /subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/nsb57dc95979/topics/topicb57dc95979 |
Авторы
- 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_servicebustopic_module.html
