azure.azcollection.azure_rm_servicebustopic – Управление Azure Service Bus
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: 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-сущности. Тема 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 строка | успех | Текущее состояние темы. Пример: /subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/nsb57dc95979/topics/topicb57dc95979 |
Авторы
- Yuwei Zhou (@yuwzho)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_servicebustopic_module.html
