Модуль azure.azcollection.azure_rm_servicebus – Управление Azure Service Bus
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: azure.azcollection.azure_rm_servicebus.
Добавлена в 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 строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. |
adfs_authority_url строка добавлено в azure.azcollection 0.0.1 | URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. |
api_profile строка добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию По умолчанию: |
append_tags логическое значение | Управляет тем, является ли поле тегов каноническим или просто добавляет к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. Варианты:
|
auth_source строка добавлено в azure.azcollection 0.0.1 | Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды При значении При значении При значении При значении При значении Параметр Варианты:
|
cert_validation_mode строка добавлено в azure.azcollection 0.0.1 | Управляет поведением проверки сертификатов для Azure-точек конечного взаимодействия. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала или управляемой идентичности (msi). Также может быть задан через переменную среды |
cloud_environment строка добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от публичного облака США, имя среды (как определено в Azure Python SDK, например, По умолчанию: |
disable_instance_discovery логическое значение добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляра, так и проверку авторизации. Эта функция предназначена для использования в сценариях, где недоступна точка конечного взаимодействия метаданных, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает в себя получение метаданных авторизации с https://login.microsoft.com/ для проверки авторизации. Установив это значение в **True**, проверка авторизации отключается. В результате крайне важно убедиться, что указанный хост авторизации действителен и надёжен. Задаётся через профиль файла учетных данных или переменную среды Варианты:
|
identity словарь добавлено в azure.azcollection 2.7.0 | Идентичность для этого ресурса. |
|
type строка |
Тип управляемой идентичности Варианты:
|
|
user_assigned_identities словарь |
Назначенные пользователями управляемые идентификаторы и их параметры По умолчанию: |
|
append логическое значение |
Если список идентификаторов должен быть добавлен к текущим идентификаторам (true) или заменить текущие идентификаторы (false) Варианты:
|
|
id список / элементы=строка |
Список идентификаторов назначенных пользователями идентификаторов, связанных с WebApp По умолчанию: |
location string | Расположение servicebus. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательно | Имя пространства имен servicebus. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string / обязательно | Имя группы ресурсов. |
secret string | Секретный ключ Azure. Используется при аутентификации с главным принципом службы. |
sku string | SKU пространства имен. Варианты:
|
state string | Утверждение состояния servicebus. Используйте Варианты:
|
subscription_id string | Ваш идентификатор подписки Azure. |
tags словарь | Словарь пар строка:строка, назначаемых в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. В настоящее время Azure DNS-зоны и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов. |
tenant string | Идентификатор Azure-аренды. Используется при аутентификации с главным принципом службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток цифровой подписи приватного ключа, указанного в x509_certificate_path. Используется при аутентификации с главным принципом службы. Требуется, если определен x509_certificate_path. |
x509_certificate_path путь добавлено в azure.azcollection 1.14.0 | Путь к X509-сертификату, используемому для создания главного принципа службы в формате PEM. Сертификат должен быть присоединен к приватной части ключа. Используется при аутентификации с главным принципом службы. |
Примечания
Примечание
- Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, хранящийся в файле ~/.azure/credentials, или войти в систему перед выполнением задач или playbook с помощью
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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход в Azure CLI
-
Как войти в систему с помощью команды
az login.
Примеры
- name: Create a namespace
azure_rm_servicebus:
name: deadbeef
location: eastus
tags:
key1: value1
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
id string | Текущее состояние очереди сообщений. Возвращаемое значение: success Пример: |
Справочные ссылки коллекции
© 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_servicebus_module.html