- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# azure_rm_azurefirewall – Manage Azure Firewall instance

New in version 2.9.

- Synopsis
- Requirements
- Parameters
- Notes
- See Also
- Examples
- Return Values
- Status

## 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
- azure >= 2.0.0

## Parameters

Parameter | Choices/Defaults | 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 2.6 |  | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 2.5 | Default: "latest" | 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.
append_tags boolean | Choices: no yes ← | 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.
application_rule_collections list |  | Collection of application rule collections used by Azure Firewall.
| action - | Choices: allow deny | The action type of a rule collection
| name - |  | 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 |  | Collection of rules used by a application rule collection.
|  | description - |  | Description of the rule.
|  | fqdn_tags list |  | List of FQDN Tags for this rule.
|  | name - |  | Name of the application rule.
|  | protocols list |  | Array of ApplicationRuleProtocols.
|  | source_addresses list |  | List of source IP addresses for this rule.
|  | target_fqdns list |  | List of FQDNs for this rule.
auth_source string added in 2.5 | Choices: auto cli credential_file env msi | Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. 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.
cert_validation_mode string added in 2.5 | Choices: ignore validate | 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.
client_id string |  | Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 2.4 | Default: "AzureCloud" | 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.
ip_configurations list |  | IP configuration of the Azure Firewall resource.
| name - |  | Name of the resource that is unique within a resource group. This name can be used to access the resource.
| public_ip_address - |  | 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 - |  | 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 - |  | Resource location.
name - / required |  | The name of the Azure Firewall.
nat_rule_collections list |  | Collection of NAT rule collections used by Azure Firewall.
| action - | Choices: snat dnat | The action type of a NAT rule collection
| name - |  | 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 |  | Collection of rules used by a NAT rule collection.
|  | description - |  | Description of the rule.
|  | destination_addresses list |  | List of destination IP addresses for this rule.
|  | destination_ports list |  | List of destination ports.
|  | name - |  | Name of the NAT rule.
|  | protocols list |  | Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.
|  | source_addresses list |  | List of source IP addresses for this rule.
|  | translated_address - |  | The translated address for this NAT rule.
|  | translated_port - |  | The translated port for this NAT rule.
network_rule_collections list |  | Collection of network rule collections used by Azure Firewall.
| action - | Choices: allow deny | The action type of a rule collection
| name - |  | 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 |  | Collection of rules used by a network rule collection.
|  | description - |  | Description of the rule.
|  | destination_addresses list |  | List of destination IP addresses.
|  | destination_ports list |  | List of destination ports.
|  | name - |  | Name of the network rule.
|  | protocols list |  | Array of AzureFirewallNetworkRuleProtocols.
|  | source_addresses list |  | 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 - / required |  | The name of the resource group.
secret string |  | Azure client secret. Use when authenticating with a Service Principal.
state - | Choices: absent present ← | Assert the state of the AzureFirewall. Use `present` to create or update an AzureFirewall and `absent` to delete it.
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.
tenant string |  | Azure tenant ID. 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.

## See Also

See also

Sign in with Azure CLI
  How to authenticate using the `az login` command.

## Examples

    - 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

## Return Values

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

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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

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

Hint

If you notice any issues in this documentation, you can edit this document to improve it.