ansible / ansible.builtin / v2.9.17 / module / azure_rm_azurefirewall Manage Azure Firewall instance. | "added in version" 2.9 of ansible.builtin" Authors: Zim Kalinowski (@zikalino), Jurijs Fadejevs (@needgithubid) preview | supported by communityansible.builtin.azure_rm_azurefirewall (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Create, 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: 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
name: description: - The name of the Azure Firewall. required: true 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. 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. 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. 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. type: str 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 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. suboptions: name: description: - Name of the resource that is unique within a resource group. This name can be used to access the resource. 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 C(name) and optionally C(resource_group). subnet: description: - Existing subnet. - It can be a string containing subnet resource id. - It can be a dictionary containing C(name), C(virtual_network_name) and optionally C(resource_group) . 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. suboptions: action: choices: - snat - dnat description: - The action type of a NAT rule collection name: description: - Gets name of the resource that is unique within a resource group. This name can be used to access the resource. priority: description: - Priority of the NAT rule collection resource. type: int rules: description: - Collection of rules used by a NAT rule collection. suboptions: description: description: - Description of the rule. destination_addresses: description: - List of destination IP addresses for this rule. type: list destination_ports: description: - List of destination ports. type: list name: description: - Name of the NAT rule. protocols: description: - Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. type: list source_addresses: description: - List of source IP addresses for this rule. type: list translated_address: description: - The translated address for this NAT rule. translated_port: description: - The translated port for this NAT rule. type: list type: list network_rule_collections: description: - Collection of network rule collections used by Azure Firewall. suboptions: action: choices: - allow - deny description: - The action type of a rule collection name: description: - Gets name of the resource that is unique within a resource group. This name can be used to access the resource. priority: description: - Priority of the network rule collection resource. type: int rules: description: - Collection of rules used by a network rule collection. suboptions: description: description: - Description of the rule. destination_addresses: description: - List of destination IP addresses. type: list destination_ports: description: - List of destination ports. type: list name: description: - Name of the network rule. protocols: description: - Array of AzureFirewallNetworkRuleProtocols. type: list source_addresses: description: - List of source IP addresses for this rule. type: list type: list type: list application_rule_collections: description: - Collection of application rule collections used by Azure Firewall. suboptions: action: choices: - allow - deny description: - The action type of a rule collection name: description: - Gets name of the resource that is unique within a resource group. This name can be used to access the resource. priority: description: - Priority of the application rule collection resource. type: int rules: description: - Collection of rules used by a application rule collection. suboptions: description: description: - Description of the rule. fqdn_tags: description: - List of FQDN Tags for this rule. type: list name: description: - Name of the application rule. protocols: description: - Array of ApplicationRuleProtocols. type: list source_addresses: description: - List of source IP addresses for this rule. type: list target_fqdns: description: - List of FQDNs for this rule. 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