azure.azcollection.azure_rm_azurefirewall – Manage Azure Firewall instance
Note
This plugin is part of the azure.azcollection collection (version 1.10.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
.
To use it in a playbook, specify: azure.azcollection.azure_rm_azurefirewall
.
New in version 0.1.2: of azure.azcollection
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 |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: “latest” |
|
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:
|
|
Collection of application rule collections used by Azure Firewall. |
|
The action type of a rule collection. Choices:
|
|
Gets name of the resource that is unique within a resource group. This name can be used to access the resource. |
|
Priority of the application rule collection resource. |
|
Collection of rules used by a application rule collection. |
|
Description of the rule. |
|
List of FQDN Tags for this rule. |
|
Name of the application rule. |
|
Array of ApplicationRuleProtocols. |
|
List of source IP addresses for this rule. |
|
List of FQDNs for this rule. |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: “AzureCloud” |
|
IP configuration of the Azure Firewall resource. |
|
Name of the resource that is unique within a resource group. This name can be used to access the resource. |
|
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. |
|
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 . |
|
Resource location. |
|
Parent argument. |
|
Parent argument. |
|
The name of the Azure Firewall. |
|
Collection of NAT rule collections used by Azure Firewall. |
|
The action type of a NAT rule collection Choices:
|
|
Gets name of the resource that is unique within a resource group. This name can be used to access the resource. |
|
Priority of the NAT rule collection resource. |
|
Collection of rules used by a NAT rule collection. |
|
Description of the rule. |
|
List of destination IP addresses for this rule. |
|
List of destination ports. |
|
Name of the NAT rule. |
|
Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. |
|
List of source IP addresses for this rule. |
|
The translated address for this NAT rule. |
|
The translated port for this NAT rule. |
|
Collection of network rule collections used by Azure Firewall. |
|
The action type of a rule collection. Choices:
|
|
Gets name of the resource that is unique within a resource group. This name can be used to access the resource. |
|
Priority of the network rule collection resource. |
|
Collection of rules used by a network rule collection. |
|
Description of the rule. |
|
List of destination IP addresses. |
|
List of destination ports. |
|
Name of the network rule. |
|
Array of AzureFirewallNetworkRuleProtocols. |
|
List of source IP addresses for this rule. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The name of the resource group. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Assert the state of the AzureFirewall. Use Choices:
|
|
Your Azure subscription Id. |
|
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. |
|
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 |
Description |
---|---|
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)