Модуль azure.azcollection.azure_rm_firewallpolicy — создание, удаление или обновление указанной политики брандмауэра.
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для работы с этим модулем требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_firewallpolicy.
Добавлено в azure.azcollection 1.13.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. Значение по умолчанию По умолчанию: |
append_tags boolean | Управляет тем, является ли поле tags каноническим или только дополняет существующие теги. Если поле является каноническим, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Варианты:
|
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных, используемых для аутентификации. Можно также задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
base_policy string | Имя родительской политики брандмауэра, от которой наследуются правила. |
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**, проверка центра сертификации будет отключена. Поэтому крайне важно убедиться, что настроенный хост центра сертификации действителен и заслуживает доверия. Задается через профиль в файле учетных данных или переменную среды Варианты:
|
location string | Расположение политики брандмауэра. Если не указано, используется расположение группы ресурсов. |
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. Используйте при аутентификации с помощью субъекта-службы. |
state string | Задает требуемое состояние политики брандмауэра. Используйте Варианты:
|
subscription_id string | Идентификатор вашей подписки Azure. |
tags dictionary | Словарь пар «строка:строка», назначаемых объекту в качестве метаданных. Теги метаданных объекта будут обновлены с учетом всех предоставленных значений. Чтобы удалить теги, задайте для параметра append_tags значение false. В настоящее время в тегах зон Azure DNS и служб Traffic Manager также нельзя использовать пробелы. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов. |
tenant string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
threat_intel_mode string | Режим работы Threat Intel. Варианты:
|
threat_intel_whitelist dictionary | Список разрешений ThreatIntel для политики брандмауэра. |
|
append_fqdns boolean |
Флаг, определяющий, нужно ли добавлять FQDN. Варианты:
|
|
append_ip_addresses boolean |
Флаг, определяющий, нужно ли добавлять IP-адреса. Варианты:
|
|
fqdns list / элементы=string |
Список FQDN для списка разрешений ThreatIntel |
|
ip_addresses list / элементы=string |
Список IP-адресов для списка разрешений ThreatIntel. |
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: Create a Firewall Policy
azure_rm_firewallpolicy:
resource_group: myAzureResourceGroup
name: myfirewallpolicy
base_policy: firewallparentpolicy
threat_intel_mode: alert
threat_intel_whitelist:
ip_addresses:
- 10.0.0.1
- 10.0.0.2
fqdns:
- "*.microsoft.com"
- "*.azure.com"
state: present
- name: Update Firewall Policy
azure_rm_firewallpolicy:
resource_group: myAzureResourceGroup
name: myfirewallpolicy
base_policy: firewallparentpolicy
threat_intel_mode: deny
threat_intel_whitelist:
ip_addresses:
- 10.0.0.1
fqdns:
- "*.microsoft.com"
state: present
tags:
key1: "value1"
- name: Delete Firewall Policy
azure_rm_firewallpolicy:
resource_group: myAzureResourceGroup
name: myfirewallpolicy
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
state complex | Текущее состояние политики брандмауэра. Возвращается: всегда |
|
base_policy dictionary |
Родительская политика брандмауэра, от которой наследуются правила. Возвращается: всегда Пример: |
|
child_policies list / elements=dictionary |
Список ссылок на дочерние политики брандмауэра. Возвращается: всегда Пример: |
|
etag string |
ETag политики брандмауэра. Возвращается: всегда Пример: |
|
firewalls list / elements=dictionary |
Список ссылок на брандмауэры Azure, связанные с этой политикой брандмауэра. Возвращается: всегда Пример: |
|
id string |
Идентификатор политики брандмауэра. Возвращается: всегда Пример: |
|
location string |
Регион Azure, в котором находится ресурс. Возвращается: всегда Пример: |
|
name string |
Имя политики брандмауэра. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние подготовки ресурса. Возвращается: всегда Пример: |
|
rule_collection_groups list / elements=dictionary |
Список ссылок на группы коллекций правил FirewallPolicy. Возвращается: всегда Пример: |
|
tags list / elements=string |
Теги ресурса. Возвращается: всегда Пример: |
|
threat_intel_mode string |
Режим работы службы аналитики угроз. Возвращается: всегда Пример: |
|
threat_intel_whitelist dictionary |
Список разрешений ThreatIntel для политики брандмауэра. Возвращается: всегда Пример: |
|
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_firewallpolicy_module.html