Модуль azure.azcollection.azure_rm_webapp_info — получение сведений о веб-приложениях Azure
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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 добавлено в azure.azcollection 0.0.1 | URL центра сертификации Azure AD. Используйте этот параметр при аутентификации с именем пользователя и паролем, если у вас есть собственный центр сертификации ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды При значении При значении При значении При значении При значении Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте этот параметр для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, — имя среды (согласно Azure Python SDK, например, По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка значения true полностью отключает обнаружение экземпляра и проверку центра сертификации. Эта функция предназначена для сценариев, в которых конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных центра сертификации с https://login.microsoft.com/ для проверки центра сертификации. Установка значения **True** отключает проверку центра сертификации. Поэтому необходимо убедиться, что настроенный узел центра сертификации является действительным и заслуживающим доверия. Задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Показывать результаты только для указанного веб-приложения. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации удостоверения рабочей нагрузки. Файл должен содержать только исходный токен. Этот способ часто используется на платформах, которые сохраняют токены OIDC в файлах. Также можно задать с помощью переменной среды |
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 / элементы=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, или выполнить вход перед запуском задач или плейбука с помощью
az login. - Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации через субъект-службу передайте 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 |
Идентификатор веб-приложения. Возвращается: всегда Пример: |
|
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_webapp_info_module.html