You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

azure.azcollection.azure_rm_azurefirewall module – Manage Azure Firewall instance

Note

This module is part of the azure.azcollection collection (version 1.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_azurefirewall.

New in azure.azcollection 0.1.2

Synopsis 

Create, update and delete instance of Azure Firewall.

Requirements 

The below requirements are needed on the host that executes this module.

python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters 

Parameter	Comments
ad_user string	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in azure.azcollection 0.0.1	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in azure.azcollection 0.0.1	Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack. Default: `"latest"`
append_tags boolean	Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object’s metadata. Choices: `false` `true` ← (default)
application_rule_collections list / elements=string	Collection of application rule collections used by Azure Firewall.
action string	The action type of a rule collection. Choices: `"allow"` `"deny"`
name string	Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
priority integer	Priority of the application rule collection resource.
rules list / elements=string	Collection of rules used by a application rule collection.
description string	Description of the rule.
fqdn_tags list / elements=string	List of FQDN Tags for this rule.
name string	Name of the application rule.
protocols list / elements=string	Array of ApplicationRuleProtocols.
source_addresses list / elements=string	List of source IP addresses for this rule.
target_fqdns list / elements=string	List of FQDNs for this rule.
auth_source string added in azure.azcollection 0.0.1	Controls the source of the credentials to use for authentication. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `auto` (the default) the precedence is module parameters -> `env` -> `credential_file` -> `cli`. When set to `env`, the credentials will be read from the environment variables When set to `credential_file`, it will read the profile from `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the Azure CLI profile. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The `msi` was added in Ansible 2.6. Choices: `"auto"` ← (default) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable. Choices: `"ignore"` `"validate"`
client_id string	Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in azure.azcollection 0.0.1	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable. Default: `"AzureCloud"`
ip_configurations list / elements=string	IP configuration of the Azure Firewall resource.
name string	Name of the resource that is unique within a resource group. This name can be used to access the resource.
public_ip_address any	Existing public IP address. It can be a string containing resource ID. It can be a string containing a name in current resource group. It can be a dictionary containing name and optionally resource_group.
subnet any	Existing subnet. It can be a string containing subnet resource ID. It can be a dictionary containing name, virtual_network_name and optionally resource_group .
location string	Resource location.
log_mode string	Parent argument.
log_path string	Parent argument.
name string / required	The name of the Azure Firewall.
nat_rule_collections list / elements=string	Collection of NAT rule collections used by Azure Firewall.
action string	The action type of a NAT rule collection Choices: `"snat"` `"dnat"`
name string	Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
priority integer	Priority of the NAT rule collection resource.
rules list / elements=string	Collection of rules used by a NAT rule collection.
description string	Description of the rule.
destination_addresses list / elements=string	List of destination IP addresses for this rule.
destination_ports list / elements=string	List of destination ports.
name string	Name of the NAT rule.
protocols list / elements=string	Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.
source_addresses list / elements=string	List of source IP addresses for this rule.
translated_address string	The translated address for this NAT rule.
translated_port string	The translated port for this NAT rule.
network_rule_collections list / elements=string	Collection of network rule collections used by Azure Firewall.
action string	The action type of a rule collection. Choices: `"allow"` `"deny"`
name string	Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
priority integer	Priority of the network rule collection resource.
rules list / elements=string	Collection of rules used by a network rule collection.
description string	Description of the rule.
destination_addresses list / elements=string	List of destination IP addresses.
destination_ports list / elements=string	List of destination ports.
name string	Name of the network rule.
protocols list / elements=string	Array of AzureFirewallNetworkRuleProtocols.
source_addresses list / elements=string	List of source IP addresses for this rule.
password string	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string	Security profile found in ~/.azure/credentials file.
resource_group string / required	The name of the resource group.
secret string	Azure client secret. Use when authenticating with a Service Principal.
state string	Assert the state of the AzureFirewall. Use `present` to create or update an AzureFirewall and `absent` to delete it. Choices: `"absent"` `"present"` ← (default)
subscription_id string	Your Azure subscription Id.
tags dictionary	Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false. Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag. Azure Front Door doesn’t support the use of Azure Automation and Azure CDN only support 15 tags on resources.
tenant string	Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint string added in azure.azcollection 1.14.0	The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined.
x509_certificate_path path added in azure.azcollection 1.14.0	Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal.

Notes 

Note

For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.
Authentication is also possible using a service principal or Active Directory user.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

Examples 

- 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
        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

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
id string	Resource ID. Returned: always Sample: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/azureFirewalls/myAzureFirewall"`

Authors

Zim Kalinowski (@zikalino)
Jurijs Fadejevs (@needgithubid)

Collection links

Issue Tracker Homepage Repository (Sources)

azure.azcollection.azure_rm_azurefirewall module – Manage Azure Firewall instance

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values