Try SpotterManage Azure Firewall instance
| "added in version" 0.1.2 of azure.azcollection"
Authors: Zim Kalinowski (@zikalino), Jurijs Fadejevs (@needgithubid)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Create, update and delete instance of Azure Firewall.
- 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
name:
description:
- The name of the Azure Firewall.
required: true
type: str
tags:
description:
- 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.
type: dict
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the AzureFirewall.
- Use C(present) to create or update an AzureFirewall and C(absent) to delete it.
type: str
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
location:
description:
- Resource location.
type: str
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
append_tags:
default: true
description:
- 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.
type: bool
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
resource_group:
description:
- The name of the resource group.
required: true
type: str
subscription_id:
description:
- Your Azure subscription Id.
type: str
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
ip_configurations:
description:
- IP configuration of the Azure Firewall resource.
elements: dict
suboptions:
name:
description:
- Name of the resource that is unique within a resource group.
- This name can be used to access the resource.
type: str
public_ip_address:
description:
- 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 I(name) and optionally I(resource_group).
type: raw
subnet:
description:
- Existing subnet.
- It can be a string containing subnet resource ID.
- It can be a dictionary containing I(name), I(virtual_network_name) and optionally
I(resource_group) .
type: raw
type: list
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
cert_validation_mode:
choices:
- ignore
- validate
description:
- 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
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
nat_rule_collections:
description:
- Collection of NAT rule collections used by Azure Firewall.
elements: dict
suboptions:
action:
choices:
- snat
- dnat
description:
- The action type of a NAT rule collection
type: str
name:
description:
- Gets name of the resource that is unique within a resource group.
- This name can be used to access the resource.
type: str
priority:
description:
- Priority of the NAT rule collection resource.
type: int
rules:
description:
- Collection of rules used by a NAT rule collection.
elements: dict
suboptions:
description:
description:
- Description of the rule.
type: str
destination_addresses:
description:
- List of destination IP addresses for this rule.
elements: str
type: list
destination_ports:
description:
- List of destination ports.
elements: str
type: list
name:
description:
- Name of the NAT rule.
type: str
protocols:
description:
- Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.
elements: raw
type: list
source_addresses:
description:
- List of source IP addresses for this rule.
elements: str
type: list
translated_address:
description:
- The translated address for this NAT rule.
type: str
translated_port:
description:
- The translated port for this NAT rule.
type: str
type: list
type: list
x509_certificate_path:
description:
- 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.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
network_rule_collections:
description:
- Collection of network rule collections used by Azure Firewall.
elements: dict
suboptions:
action:
choices:
- allow
- deny
description:
- The action type of a rule collection.
type: str
name:
description:
- Gets name of the resource that is unique within a resource group.
- This name can be used to access the resource.
type: str
priority:
description:
- Priority of the network rule collection resource.
type: int
rules:
description:
- Collection of rules used by a network rule collection.
elements: dict
suboptions:
description:
description:
- Description of the rule.
type: str
destination_addresses:
description:
- List of destination IP addresses.
elements: str
type: list
destination_ports:
description:
- List of destination ports.
elements: str
type: list
name:
description:
- Name of the network rule.
type: str
protocols:
description:
- Array of AzureFirewallNetworkRuleProtocols.
elements: raw
type: list
source_addresses:
description:
- List of source IP addresses for this rule.
elements: str
type: list
type: list
type: list
disable_instance_discovery:
default: false
description:
- Determines whether or not instance discovery is performed when attempting to authenticate.
Setting this to true will completely disable both instance discovery and authority
validation. This functionality is intended for use in scenarios where the metadata
endpoint cannot be reached such as in private clouds or Azure Stack. The process
of instance discovery entails retrieving authority metadata from https://login.microsoft.com/
to validate the authority. By setting this to **True**, the validation of the authority
is disabled. As a result, it is crucial to ensure that the configured authority
host is valid and trustworthy.
- Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
variable.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
application_rule_collections:
description:
- Collection of application rule collections used by Azure Firewall.
elements: dict
suboptions:
action:
choices:
- allow
- deny
description:
- The action type of a rule collection.
type: str
name:
description:
- Gets name of the resource that is unique within a resource group.
- This name can be used to access the resource.
type: str
priority:
description:
- Priority of the application rule collection resource.
type: int
rules:
description:
- Collection of rules used by a application rule collection.
elements: raw
suboptions:
description:
description:
- Description of the rule.
type: str
fqdn_tags:
description:
- List of FQDN Tags for this rule.
elements: raw
type: list
name:
description:
- Name of the application rule.
type: str
protocols:
description:
- Array of ApplicationRuleProtocols.
elements: dict
suboptions:
port:
description:
- The ports of the protocols.
type: str
type:
description:
- The type of the protocols.
type: str
type: list
source_addresses:
description:
- List of source IP addresses for this rule.
elements: str
type: list
target_fqdns:
description:
- List of FQDNs for this rule.
elements: raw
type: list
type: list
type: list
id: description: - Resource ID. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/azureFirewalls/myAzureFirewall type: str