модуль azure.azcollection.azure_rm_applicationfirewallpolicy_info — получение сведений об экземпляре политики брандмауэра приложений
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости; подробности см. в разделе Требования.
Чтобы использовать модуль в сценарии, укажите: azure.azcollection.azure_rm_applicationfirewallpolicy_info.
Добавлено в azure.azcollection 3.1.0
Краткое описание
- Получение или просмотр сведений о брандмауэре приложений.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- 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 | Имя группы ресурсов. |
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 или выполнить вход перед запуском задач или сценария с помощью
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 the application firewall policy by name
azure_rm_applicationfirewallpolicy_info:
name: Myfirewallpolicy01
resource_group: MyResourceGroup
- name: List the application firewall policy by resource group
azure_rm_applicationfirewallpolicy_info:
resource_group: MyResourceGroup
- name: List all application firewall policy
azure_rm_applicationfirewallpolicy_info:
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
firewall_policy complex | Список сведений о политике межсетевого экрана для веб-приложений Возвращается: всегда |
|
custom_rules complex |
Пользовательские правила в политике. Возвращается: при использовании |
|
action string |
Имя ресурса, уникальное в пределах политики. Это имя можно использовать для доступа к ресурсу. Возвращается: всегда Пример: |
|
match_conditions list / elements=string |
Список условий сопоставления. Возвращается: всегда Пример: |
|
name string |
Имя ресурса, уникальное в пределах политики. Это имя можно использовать для доступа к ресурсу. Возвращается: всегда Пример: |
|
priority integer |
Приоритет правила. Правила с меньшим значением обрабатываются раньше правил с большим значением. Возвращается: всегда Пример: |
|
rule_type string |
Тип правила. Возвращается: всегда Пример: |
|
state string |
Указывает, включено или отключено пользовательское правило. Возвращается: всегда Пример: |
|
id string |
Идентификатор политики межсетевого экрана для веб-приложений. Возвращается: всегда Пример: |
|
location string |
Расположение политики межсетевого экрана для веб-приложений. Возвращается: всегда Пример: |
|
managed_rules complex |
Описывает структуру managedRules. Возвращается: при использовании |
|
exclusions list / elements=string |
Исключения, применяемые к политике. Возвращается: всегда Пример: |
|
managed_rule_sets list / elements=string |
Наборы управляемых правил, связанные с политикой. Возвращается: всегда Пример: |
|
name string |
Имя политики межсетевого экрана для веб-приложений. Возвращается: всегда Пример: |
|
policy_settings complex |
Параметры политики. Возвращается: при использовании |
|
file_upload_enforcement boolean |
Указывает, разрешено ли WAF ограничивать размер загружаемых файлов. Возвращается: всегда Пример: |
|
file_upload_limit_in_mb integer |
Максимальный размер загружаемого файла для WAF в МБ. Возвращается: всегда Пример: |
|
js_challenge_cookie_expiration_in_mins integer |
Срок действия файла cookie проверки JavaScript для межсетевого экрана веб-приложений в минутах. Возвращается: всегда Пример: |
|
max_request_body_size_in_kb integer |
Максимальный размер тела запроса для WAF в КБ. Возвращается: всегда Пример: |
|
mode string |
Режим политики. Возвращается: всегда Пример: |
|
request_body_check boolean |
Указывает, разрешено ли WAF проверять тело запроса. Возвращается: всегда Пример: |
|
request_body_enforcement boolean |
Указывает, разрешено ли WAF ограничивать размер тела запроса. Возвращается: всегда Пример: |
|
state string |
Состояние политики. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние развертывания политики межсетевого экрана для веб-приложений. Возвращается: всегда Пример: |
|
resource_group string |
Имя группы ресурсов. Возвращается: всегда Пример: |
|
tags dictionary |
Теги политики межсетевого экрана для веб-приложений. Возвращается: всегда Пример: |
|
type string |
Тип политики межсетевого экрана для веб-приложений. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_applicationfirewallpolicy_info_module.html