Модуль azure.azcollection.azure_rm_webapp_info – Получение сведений об Azure веб-приложениях
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_webapp_info.
Новая функция в azure.azcollection 0.1.2
Описание
- Получение сведений о конкретном веб-приложении или всех веб-приложениях в группе ресурсов, или всех веб-приложениях в текущей подписке.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 | Управляет источником учетных данных, используемых для аутентификации. Может быть также установлен через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Варианты:
|
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: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает извлечение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате важно убедиться, что настроенный узел узла действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Показывать результаты только для конкретного веб-приложения. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string | Ограничить результаты по группе ресурсов. |
return_publish_profile boolean | Указывает, следует ли возвращать профиль публикации веб-приложения. Варианты:
|
secret string | Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности. |
subscription_id string | Ваш идентификатор подписки Azure. |
tags list / elements=string | Ограничить результаты, указав список тегов. Формат тегов — ‘ключ’ или ‘ключ:значение’. |
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, или выполнить вход перед запуском задач или 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. Также возможно добавление дополнительных профилей. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход с помощью Azure CLI
-
Как выполнить аутентификацию с использованием команды
az login.
Примеры
- name: Get facts for web app by name
azure_rm_webapp_info:
resource_group: myResourceGroup
name: winwebapp1
- name: Get facts for web apps in resource group
azure_rm_webapp_info:
resource_group: myResourceGroup
- name: Get facts for web apps with tags
azure_rm_webapp_info:
tags:
- testtag
- foo:bar
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
webapps complex | Список веб-приложений. Возвращается: всегда |
|
always_on boolean |
Если приложение остается загруженным даже при отсутствии трафика. Возвращается: всегда Пример: |
|
app_settings dictionary |
Параметры приложения. Возвращается только тогда, когда у веб-приложения есть параметры приложения. Возвращается: всегда Пример: |
|
availability_state string |
Доступность этого веб-приложения. Возвращается: всегда Пример: |
|
default_host_name string |
Имя хоста веб-приложения. Возвращается: всегда Пример: |
|
enabled boolean |
Указывает, включено веб-приложение или нет. Возвращается: всегда Пример: |
|
enabled_host_names list / elements=string |
Включенные имена хостов веб-приложения. Возвращается: всегда Пример: |
|
frameworks list / elements=string |
Фреймворки приложения. Возвращается только тогда, когда у веб-приложения есть фреймворки. Возвращается: всегда Пример: |
|
ftp_publish_url string |
URL публикации веб-приложения, когда тип развертывания — FTP. Возвращается: всегда Пример: |
|
ftps_state string |
Состояние службы FTP/FTPS. Возвращается: всегда Пример: |
|
host_name_ssl_states list / elements=string |
Состояние SSL для каждого имени хоста веб-приложения. Возвращается: всегда Пример: |
|
host_names list / elements=string |
Имена хостов веб-приложения. Возвращается: всегда Пример: |
|
http20_enabled boolean |
Настраивает веб-сайт для разрешения клиентам подключаться по HTTP 2.0. Возвращается: всегда Пример: |
|
id string |
ID веб-приложения. Возвращается: всегда Пример: |
|
location string |
Расположение веб-приложения. Возвращается: всегда Пример: |
|
min_tls_version string |
Минимальная версия шифрования TLS, необходимая для приложения. Возвращается: всегда Пример: |
|
name string |
Имя веб-приложения. Возвращается: всегда Пример: |
|
outbound_ip_addresses string |
Внешний IP-адрес веб-приложения. Возвращается: всегда Пример: |
|
plan string |
Идентификатор плана службы приложений, используемого веб-приложением. Возвращается: всегда Пример: |
|
publishing_password string |
Пароль профиля публикации. Возвращается: только при return_publish_profile=True. Пример: |
|
publishing_username string |
Имя пользователя профиля публикации. Возвращается: только при return_publish_profile=True. Пример: |
|
resource_group string |
Группа ресурсов веб-приложения. Возвращается: всегда Пример: |
|
site_auth_settings dictionary |
Настройки аутентификации/авторизации, связанные с веб-приложением. Возвращается: всегда Пример: |
|
state string |
Состояние веб-приложения. Возвращается: всегда Пример: |
|
tags dictionary |
Теги, назначенные ресурсу. Словарь пар строка:строка. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_webapp_info_module.html