azure.azcollection.azure_rm_azurefirewall – Управление экземпляром Azure Firewall
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_azurefirewall.
Новое в версии 0.1.2: из azure.azcollection
Описание
- Создание, обновление и удаление экземпляра Azure Firewall.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным принципом службы. | |||
| adfs_authority_url строка добавлен в 0.0.1 azure.azcollection | URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. | |||
| api_profile строка добавлен в 0.0.1 azure.azcollection | По умолчанию: "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 строка добавлен в 0.0.1 azure.azcollection |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке в auto (значение по умолчанию) приоритет имеет:параметры модуля -> env -> credential_file -> cli.При установке в env, учетные данные будут считываться из переменных среды.При установке в credential_file, профиль будет считан из ~/.azure/credentials.При установке в cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если их несколько, иначе используется стандартная подписка Azure CLI.При установке в msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка.msi был добавлен в Ansible 2.6. | ||
| cert_validation_mode строка добавлен в 0.0.1 azure.azcollection |
| Управляет поведением валидации сертификатов для Azure-узлов. По умолчанию все модули валидируют сертификат сервера, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить это поведение, передавая ignore. Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | ||
| client_id строка | Идентификатор клиента Azure. Используйте при аутентификации с главным принципом службы. | |||
| cloud_environment строка добавлен в 0.0.1 azure.azcollection | По умолчанию: "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. | |||
| protocols список / элементы=строка | Массив AzureFirewallNetworkRuleProtocols, применимые к этому правилу NAT. | |||
| source_addresses список / элементы=строка | Список IP-адресов источника для этого правила. | |||
| translated_address строка | Переведённый адрес для этого правила NAT. | |||
| translated_port строка | Переведённый порт для этого правила NAT. | |||
| network_rule_collections список / элементы=строка | Коллекция наборов правил сети, используемых Azure Firewall. | |||
| действие строка |
| Тип действия набора правил. | ||
| имя строка | Получает имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. | |||
| приоритет целое число | Приоритет сетевого набора правил. | |||
| правила список / элементы=строка | Коллекция правил, используемых набором сетевых правил. | |||
| описание строка | Описание правила. | |||
| адреса_назначения список / элементы=строка | Список адресов назначения IP. | |||
| порты_назначения список / элементы=строка | Список портов назначения. | |||
| имя строка | Имя сетевого правила. | |||
| протоколы список / элементы=строка | Массив AzureFirewallNetworkRuleProtocols. | |||
| адреса_источника список / элементы=строка | Список адресов источника IP для этого правила. | |||
| пароль строка | Пароль пользователя Active Directory. Используется при аутентификации пользователем Active Directory вместо служебного принципала. | |||
| профиль строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |||
| группа_ресурсов строка / обязательно | Имя группы ресурсов. | |||
| секрет строка | Служебный секрет Azure. Используется при аутентификации служебным принципалом. | |||
| состояние строка |
| Утверждение состояния AzureFirewall. Используйте present для создания или обновления AzureFirewall и absent для его удаления. | ||
| идентификатор_подписки строка | Ваш идентификатор подписки Azure. | |||
| метки словарь | Словарь пар строка:строка для назначения метаданных объекту. Метаданные метки объекта будут обновлены любыми предоставленными значениями. Для удаления меток установите параметр append_tags в значение false. | |||
| аренда строка | Идентификатор аренды Azure. Используется при аутентификации служебным принципалом. | |||
Примечания
Примечание
- Для аутентификации в Azure вы можете передавать параметры, устанавливать переменные окружения, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти в систему перед запуском задач или плана с помощью
az login. - Аутентификация также возможна с использованием служебного принципала или пользователя Active Directory.
- Для аутентификации через служебного принципала передайте идентификатор подписки, идентификатор клиента, секрет и арендатор или установите переменные окружения AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
- Для аутентификации через пользователя Active Directory передайте пользователя ad_user и пароль или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
- В качестве альтернативы учетные данные можно сохранить в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: идентификатор подписки, идентификатор клиента, секрет и арендатор или идентификатор подписки, пользователь ad и пароль. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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 |
Авторы
- Зим Калиновский (@zikalino)
- Юрийс Фадеевс (@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.10/collections/azure/azcollection/azure_rm_azurefirewall_module.html
