Модуль azure.azcollection.azure_rm_servicebustopic — Управление Azure Service Bus
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. раздел Требования.
Для использования в playbook укажите: azure.azcollection.azure_rm_servicebustopic.
Новая версия в azure.azcollection 0.1.2
Обзор
- Создание, обновление или удаление тем Azure Service Bus.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и имеет собственный узел ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Варианты:
|
auto_delete_on_idle_in_seconds integer | Интервал простоя, после которого тема автоматически удаляется. Минимальная продолжительность составляет 5 минут. |
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси HTTPS или для Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
default_message_time_to_live_seconds integer | Значение времени жизни сообщения по умолчанию. Это продолжительность, после которой сообщение истекает, начиная с момента отправки сообщения в Service Bus. Это значение по умолчанию, используемое, когда TimeToLive не установлен в самом сообщении. |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате крайне важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
duplicate_detection_time_in_seconds integer | Структура TimeSpan, которая определяет продолжительность истории обнаружения дубликатов. |
enable_batched_operations boolean | Значение, указывающее, включены ли серверные пакетные операции. Варианты:
|
enable_express boolean | Значение, указывающее, включены ли экспресс-сущности. Экспресс-тема временно хранит сообщение в памяти, прежде чем записать его в постоянное хранилище. Варианты:
|
enable_partitioning boolean | Значение, указывающее, будет ли тема разделена на несколько брокеров сообщений. Варианты:
|
log_mode string | Аргумент родительского элемента. |
log_path string | Аргумент родительского элемента. |
max_message_size_in_kb integer | Максимальный размер (в КБ) полезной нагрузки сообщения, который может принять очередь. Это свойство используется только в Premium в настоящее время, и по умолчанию равно 1024. |
max_size_in_mb integer | Максимальный размер темы в мегабайтах, который соответствует размеру выделенной памяти для темы. |
name string / обязательно | Имя темы. |
namespace string / обязательно | Имя пространства имен servicebus. Пространство имен — это контейнер для всех компонентов обмена сообщениями. В одном пространстве имен могут находиться несколько тем. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
requires_duplicate_detection boolean | Указывает, требует ли эта тема обнаружения дубликатов. Варианты:
|
resource_group string / обязательно | Имя группы ресурсов. |
secret string | Секрет Azure-клиента. Используется при аутентификации с помощью принципала службы. |
state string | Утверждение состояния темы. Используйте Варианты:
|
status string | Статус сущности. Варианты:
|
subscription_id string | Ваш идентификатор подписки Azure. |
support_ordering boolean | Значение, указывающее, поддерживает ли тема порядок. Варианты:
|
tenant string | Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы. |
thumbprint string добавлен в azure.azcollection 1.14.0 | Отпечаток цифрового сертификата, указанный в x509_certificate_path. Используется при аутентификации с помощью принципала службы. Требуется, если определен параметр x509_certificate_path. |
x509_certificate_path path добавлен в azure.azcollection 1.14.0 | Путь к сертификату X509, используемому для создания принципала службы в формате PEM. Сертификат должен быть прикреплен к закрытому ключу. Используется при аутентификации с помощью принципала службы. |
Примечания
Примечание
- Для аутентификации с 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 строка | Текущее состояние темы. Возвращено: успех Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_servicebustopic_module.html