azure_rm_azurefirewall – Управление экземпляром Azure Firewall
Новая версия 2.9.
Обзор
- Создание, обновление и удаление экземпляра Azure Firewall.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |||
| adfs_authority_url строка добавлено в 2.6 | URL авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизации ADFS. | |||
| api_profile строка добавлено в 2.5 | По умолчанию: "latest" | Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | ||
| append_tags логическое значение |
| Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | ||
| application_rule_collections список | Коллекция коллекций правил приложений, используемых Azure Firewall. | |||
| action - |
| Тип действия коллекции правил. | ||
| name - | Получает имя ресурса, уникальное в группе ресурсов. Это имя может быть использовано для доступа к ресурсу. | |||
| priority целое число | Приоритет ресурса коллекции правил приложений. | |||
| rules список | Коллекция правил, используемых коллекцией правил приложений. | |||
| description - | Описание правила. | |||
| fqdn_tags список | Список тегов FQDN для этого правила. | |||
| name - | Имя правила приложения. | |||
| protocols список | Массив ApplicationRuleProtocols. | |||
| source_addresses список | Список IP-адресов источника для данного правила. | |||
| target_fqdns список | Список FQDN для данного правила. | |||
| auth_source строка добавлено в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды ANSIBLE_AZURE_AUTH_SOURCE, по умолчанию auto , если переменная не определена.auto будет следовать умолчанию приоритетов параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке в msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi было добавлено в Ansible 2.6. | ||
| cert_validation_mode строка добавлено в 2.5 |
| Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или при взаимодействии с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | ||
| client_id строка | Azure client ID. Используется при аутентификации с принципалом службы. | |||
| cloud_environment строка добавлено в 2.4 | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL конечной точки обнаружения метаданных (необходимо для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | ||
| ip_configurations список | IP-конфигурация ресурса Azure Firewall. | |||
| name - | Имя ресурса, уникальное в группе ресурсов. Это имя может быть использовано для доступа к ресурсу. | |||
| public_ip_address - | Существующий общедоступный IP-адрес Может быть строкой, содержащей идентификатор ресурса. Может быть строкой, содержащей имя в текущей группе ресурсов. Может быть словарем, содержащим name и необязательно resource_group. | |||
| subnet - | Существующая подсеть. Может быть строкой, содержащей идентификатор ресурса подсети. Может быть словарем, содержащим name, virtual_network_name и необязательно resource_group . | |||
| location - | Расположение ресурса. | |||
| name - / обязательно | Имя Azure Firewall. | |||
| nat_rule_collections список | Коллекция коллекций правил NAT, используемых Azure Firewall. | |||
| action - |
| Тип действия коллекции правил NAT | ||
| name - | Получает имя ресурса, уникальное в группе ресурсов. Это имя может быть использовано для доступа к ресурсу. | |||
| priority целое число | Приоритет ресурса коллекции правил NAT. | |||
| rules список | Коллекция правил, используемых коллекцией правил NAT. | |||
| description - | Описание правила. | |||
| destination_addresses список | Список адресов назначения IP для этого правила. | |||
| destination_ports список | Список портов назначения. | |||
| name - | Имя правила NAT. | |||
| протоколы список | Массив AzureFirewallNetworkRuleProtocols, применимый к этому правилу NAT. | |||
| source_addresses список | Список IP-адресов источника для этого правила. | |||
| translated_address - | Переведённый адрес для этого правила NAT. | |||
| translated_port - | Переведённый порт для этого правила NAT. | |||
| network_rule_collections список | Коллекция правил набора правил сети, используемых Azure Firewall. | |||
| действие - |
| Тип действия набора правил. | ||
| имя - | Получает имя ресурса, уникальное в пределах группы ресурсов. Это имя может использоваться для доступа к ресурсу. | |||
| priority целое число | Приоритет ресурса набора правил сети. | |||
| правила список | Коллекция правил, используемых набором правил сети. | |||
| описание - | Описание правила. | |||
| destination_addresses список | Список адресов назначения IP. | |||
| destination_ports список | Список портов назначения. | |||
| имя - | Имя правила сети. | |||
| протоколы список | Массив AzureFirewallNetworkRuleProtocols. | |||
| source_addresses список | Список IP-адресов источника для этого правила. | |||
| пароль строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала. | |||
| профиль строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |||
| resource_group - / обязательно | Имя группы ресурсов. | |||
| секрет строка | Секрет Azure-клиента. Используется при аутентификации со службой-принципалом. | |||
| состояние - |
| Утверждение состояния AzureFirewall. Используйте present для создания или обновления AzureFirewall и absent для его удаления. | ||
| subscription_id строка | Ваш идентификатор подписки Azure. | |||
| метки словарь | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные-метки объекта будут обновлены любыми предоставленными значениями. Для удаления меток установите параметр append_tags в значение false. | |||
| арендатор строка | Идентификатор арендатора Azure. Используется при аутентификации со службой-принципалом. | |||
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или плейбука с помощью
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: Create Azure Firewall
azure_rm_azurefirewall:
resource_group: myResourceGroup
name: myAzureFirewall
tags:
key1: value1
application_rule_collections:
- priority: 110
action:
type: 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:
type: 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:
type: deny
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: netrulecoll
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 строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/azureFirewalls/myAzureFirewall |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [бета-версия]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Zim Kalinowski (@zikalino)
- Jurijs Fadejevs (@needgithubid)
Подсказка
Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_azurefirewall_module.html