azure.azcollection.azure_rm_azurefirewall – Управление экземпляром Azure Firewall
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).
Для его установки используйте: 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 могут быть использованы для определения идентификатора подписки, если их несколько, иначе используется подписка по умолчанию az 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-адрес. Может быть строкой, содержащей идентификатор ресурса. Может быть строкой, содержащей имя в текущей группе ресурсов. Может быть словарем, содержащим имя и необязательно группу_ресурсов. | |||
| subnet сырые данные | Существующая подсеть. Может быть строкой, содержащей идентификатор ресурса подсети. Может быть словарем, содержащим имя, имя_виртуальной_сети и необязательно группу_ресурсов. | |||
| 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_user и пароль. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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 |
Авторы
- Zim Kalinowski (@zikalino)
- Jurijs Fadejevs (@needgithubid)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_azurefirewall_module.html
