Модуль azure.azcollection.azure_rm_azurefirewall — управление экземпляром Azure Firewall
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_azurefirewall.
Добавлено в azure.azcollection 0.1.2
Краткое описание
- Создание, обновление и удаление экземпляра Azure Firewall.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- 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, будут удалены из метаданных объекта. Варианты:
|
application_rule_collections list / elements=dictionary | Коллекция наборов правил приложения, используемых Azure Firewall. |
|
action string |
Тип действия набора правил. Варианты:
|
|
name string |
Получает имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу. |
|
priority integer |
Приоритет ресурса набора правил приложения. |
|
rules list / elements=any |
Коллекция правил, используемых набором правил приложения. |
|
description string |
Описание правила. |
|
fqdn_tags list / elements=any |
Список тегов FQDN для этого правила. |
|
name string |
Имя правила приложения. |
|
protocols list / elements=dictionary |
Массив ApplicationRuleProtocols. |
|
port string |
Порты протоколов. |
|
type string |
Тип протоколов. |
|
source_addresses list / elements=string |
Список IP-адресов источника для этого правила. |
|
target_fqdns list / elements=any |
Список FQDN для этого правила. |
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**, проверка центра будет отключена. Поэтому крайне важно убедиться в корректности и надежности настроенного узла центра. Задается в профиле файла учетных данных или с помощью переменной окружения Варианты:
|
ip_configurations list / elements=dictionary | Конфигурация IP-адреса ресурса Azure Firewall. |
|
name string |
Имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу. |
|
public_ip_address any |
Существующий общедоступный IP-адрес. Это может быть строка с идентификатором ресурса. Это может быть строка с именем в текущей группе ресурсов. Это может быть словарь, содержащий name и, необязательно, resource_group. |
|
subnet any |
Существующая подсеть. Это может быть строка с идентификатором ресурса подсети. Это может быть словарь, содержащий name, virtual_network_name и, необязательно, resource_group. |
location string | Расположение ресурса. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательный | Имя Azure Firewall. |
nat_rule_collections list / elements=dictionary | Коллекция наборов правил NAT, используемых Azure Firewall. |
|
action string |
Тип действия набора правил NAT Варианты:
|
|
name string |
Получает имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу. |
|
priority integer |
Приоритет ресурса набора правил NAT. |
|
rules list / elements=dictionary |
Коллекция правил, используемых набором правил NAT. |
|
description string |
Описание правила. |
|
destination_addresses list / elements=string |
Список IP-адресов назначения для этого правила. |
|
destination_ports list / elements=string |
Список портов назначения. |
|
name string |
Имя правила NAT. |
|
protocols list / elements=any |
Массив AzureFirewallNetworkRuleProtocols, применимых к этому правилу NAT. |
|
source_addresses list / elements=string |
Список IP-адресов источника для этого правила. |
|
translated_address string |
Преобразованный адрес для этого правила NAT. |
|
translated_port string |
Преобразованный порт для этого правила NAT. |
network_rule_collections list / elements=dictionary | Коллекция наборов сетевых правил, используемых Azure Firewall. |
|
action string |
Тип действия набора правил. Варианты:
|
|
name string |
Получает имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу. |
|
priority integer |
Приоритет ресурса набора сетевых правил. |
|
rules list / elements=dictionary |
Коллекция правил, используемых набором сетевых правил. |
|
description string |
Описание правила. |
|
destination_addresses list / elements=string |
Список IP-адресов назначения. |
|
destination_fqdns list / elements=string |
Список FQDN назначения. |
|
destination_ports list / elements=string |
Список портов назначения. |
|
name string |
Имя сетевого правила. |
|
protocols list / elements=any |
Массив AzureFirewallNetworkRuleProtocols. |
|
source_addresses list / elements=string |
Список IP-адресов источника для этого правила. |
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 | Задать требуемое состояние AzureFirewall. Используйте Варианты:
|
subscription_id string | Идентификатор вашей подписки Azure. |
tags dictionary | Словарь пар «строка:строка», назначаемых объекту в качестве метаданных. Теги метаданных объекта будут обновлены с учетом всех предоставленных значений. Чтобы удалить теги, задайте для параметра 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 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 Azure Firewall
azure_rm_azurefirewall:
resource_group: myResourceGroup
name: myAzureFirewall
tags:
key1: value1
application_rule_collections:
- priority: 110
action: deny
rules:
- name: rule1
description: Deny inbound rule
source_addresses:
- 216.58.216.164
- 10.0.0.0/24
protocols:
- type: https
port: '443'
target_fqdns:
- www.test.com
name: apprulecoll
nat_rule_collections:
- priority: 112
action: dnat
rules:
- name: DNAT-HTTPS-traffic
description: D-NAT all outbound web traffic for inspection
source_addresses:
- '*'
destination_addresses:
- 1.2.3.4
destination_ports:
- '443'
protocols:
- tcp
translated_address: 1.2.3.5
translated_port: '8443'
name: natrulecoll
network_rule_collections:
- priority: 112
action: deny
name: netrulecoll
rules:
- name: L4-traffic
description: Block traffic based on source IPs and ports
protocols:
- tcp
source_addresses:
- 192.168.1.1-192.168.1.12
- 10.1.4.12-10.1.4.255
destination_addresses:
- '*'
destination_ports:
- 443-444
- '8443'
- name: L4-traffic-destination_fqdns
description: Block traffic based on source IPs and ports to amazon
protocols:
- tcp
source_addresses:
- 10.2.4.12-10.2.4.255
destination_fqdns:
- 'www.test.com'
destination_ports:
- 443-444
- '8443'
ip_configurations:
- subnet: >-
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup
/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork
/subnets/AzureFirewallSubnet
public_ip_address: >-
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup
/providers/Microsoft.Network/publicIPAddresses/
myPublicIpAddress
name: azureFirewallIpConfiguration
- name: Delete Azure Firewall
azure_rm_azurefirewall:
resource_group: myResourceGroup
name: myAzureFirewall
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
id 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_azurefirewall_module.html