azure.azcollection.azure_rm_applicationfirewallpolicy module – Manage the Application firewall policy instance

Note

This module is part of the azure.azcollection collection (version 3.9.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_applicationfirewallpolicy.

New in azure.azcollection 3.1.0

Synopsis

  • Creating, Updating or Deleting the application firewall policy instance.

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

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 or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

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"

custom_rules

list / elements=dictionary

The custom rules inside the policy.

action

string

Type of Actions.

Choices:

  • "Allow"

  • "Block"

  • "Log"

  • "JSChallenge"

group_by_user_session

list / elements=dictionary

List of user session identifier group by clauses.

group_by_variables

list / elements=dictionary

List of group by clause variables.

variable_name

string

User Session clause variable.

Choices:

  • "ClientAddr"

  • "GeoLocation"

  • "None"

match_conditions

list / elements=dictionary / required

List of match conditions.

match_values

list / elements=string / required

Match value.

match_variables

list / elements=dictionary / required

List of match variables.

selector

string

The selector of match variable.

variable_name

string / required

Match Variable.

Choices:

  • "RemoteAddr"

  • "RequestMethod"

  • "QueryString"

  • "PostArgs"

  • "RequestUri"

  • "RequestHeaders"

  • "RequestBody"

  • "RequestCookies"

negation_conditon

boolean

Whether this is negate condition or not.

Choices:

  • false

  • true

operator

string / required

The operator to be matched.

Choices:

  • "IPMatch"

  • "Equal"

  • "Contains"

  • "LessThan"

  • "GreaterThan"

  • "LessThanOrEqual"

  • "GreaterThanOrEqual"

  • "BeginsWith"

  • "EndsWith"

  • "Regex"

  • "GeoMatch"

  • "Any"

transforms

list / elements=string

List of transforms.

Choices:

  • "Uppercase"

  • "Lowercase"

  • "Trim"

  • "UrlDecode"

  • "UrlEncode"

  • "RemoveNulls"

  • "HtmlEntityDecode"

name

string

The name of the resource that is unique within a policy.

This name can be used to access the resource.

priority

integer / required

Priority of the rule.

Rules with a lower value will be evaluated before rules with a higher value.

rate_limit_duration

string

Duration over which Rate Limit policy will be applied.

Applies only when ruleType is RateLimitRule.

Choices:

  • "OneMin"

  • "FiveMins"

rate_limit_threshold

integer

Rate Limit threshold to apply in case ruleType is RateLimitRule.

Must be greater than or equal to 1.

rule_type

string / required

The rule type.

Choices:

  • "MatchRule"

  • "RateLimitRule"

  • "Invalid"

state

string

Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.

Choices:

  • "Disabled"

  • "Enabled"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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 AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

  • false ← (default)

  • true

location

string

Valid Azure location. Defaults to the location of the resource group.

log_mode

string

Parent argument.

log_path

string

Parent argument.

managed_rules

dictionary

Describes the managedRules structure.

exclusions

list / elements=dictionary

The Exclusions that are applied on the policy.

exclusion_managed_rule_sets

list / elements=dictionary

The managed rule sets that are associated with the exclusion.

rule_groups

list / elements=dictionary

Defines the rule groups to apply to the rule set.

rule_group_name

string / required

The managed rule group for exclusion.

rules

list / elements=dictionary

List of rules that will be excluded. If none specified, all rules in the group will be excluded.

rule_id

string

Identifier for the managed rule.

rule_set_type

string / required

Defines the rule set type to use.

rule_set_version

string / required

Defines the version of the rule set to use.

match_variable

string / required

The variable to be excluded.

Choices:

  • "RequestHeaderNames"

  • "RequestCookieNames"

  • "RequestArgNames"

  • "RequestHeaderKeys"

  • "RequestHeaderValues"

  • "RequestCookieKeys"

  • "RequestCookieValues"

  • "RequestArgKeys"

  • "RequestArgValues"

selector

string / required

When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.

selector_match_operator

string / required

When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.

Choices:

  • "Equals"

  • "Contains"

  • "StartsWith"

  • "EndsWith"

  • "EqualsAny"

managed_rule_sets

list / elements=dictionary / required

The managed rule sets that are associated with the policy.

rule_group_overrides

list / elements=dictionary

Defines the rule group overrides to apply to the rule set.

rule_group_name

string / required

The managed rule group to override.

rules

list / elements=dictionary

List of rules that will be disabled.

If none specified, all rules in the group will be disabled.

action

string

Describes the override action to be applied when rule matches.

Choices:

  • "AnomalyScoring"

  • "Allow"

  • "Block"

  • "Log"

  • "JSChallenge"

rule_id

string / required

Identifier for the managed rule.

sensitivity

string

Describes the override sensitivity to be applied when rule matches.

Choices:

  • "None"

  • "Low"

  • "Medium"

  • "High"

state

string

The state of the managed rule. Defaults to Disabled if not specified.

Choices:

  • "Enabled"

  • "Disabled"

rule_set_type

string / required

Defines the rule set type to use.

rule_set_version

string / required

Defines the version of the rule set to use.

name

string / required

The name of the application firewall policy’s name.

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

policy_settings

dictionary

The PolicySettings for policy.

custom_block_response_body

string

If the action type is block, customer can override the response body.

The body must be specified in base64 encoding.

custom_block_response_status_code

integer

If the action type is block, customer can override the response status code.

file_upload_enforcement

boolean

Whether allow WAF to enforce file upload limits.

Choices:

  • false

  • true

file_upload_limit_in_mb

integer

Maximum file upload size in Mb for WAF.

integer

Web Application Firewall JavaScript Challenge Cookie Expiration time in minutes.

log_scrubbing

dictionary

To scrub sensitive log fields.

scrubbing_rules

list / elements=dictionary

The rules that are applied to the logs for scrubbing.

match_variable

string / required

The variable to be scrubbed from the logs.

Choices:

  • "RequestHeaderNames"

  • "RequestCookieNames"

  • "RequestArgNames"

  • "RequestPostArgNames"

  • "RequestJSONArgNames"

  • "RequestIPAddress"

selector

string

When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to.

selector_match_operator

string / required

When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.

Choices:

  • "Equals"

  • "EqualsAny"

state

string

Defines the state of log scrubbing rule.

Choices:

  • "Enabled"

  • "Disabled"

state

string

State of the log scrubbing config.

Choices:

  • "Enabled"

  • "Disabled"

max_request_body_size_in_kb

integer

Maximum request body size in Kb for WAF.

mode

string

The mode of the policy.

Choices:

  • "Prevention"

  • "Detection"

request_body_check

boolean

Whether to allow WAF to check request Body.

Choices:

  • false

  • true

request_body_enforcement

boolean

Whether allow WAF to enforce request body limits.

Choices:

  • false

  • true

request_body_inspect_limit_in_kb

integer

Max inspection limit in KB for request body inspection for WAF.

state

string

The state of the policy.

Choices:

  • "Disabled"

  • "Enabled"

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 firewall policy.

Use present to create or update a and absent to delete.

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.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create a new application firewall policy
  azure_rm_applicationfirewallpolicy:
    resource_group: "{{ resource_group }}"
    name: "new{{ rpfx }}02"
    location: australiasoutheast
    policy_settings:
      file_upload_enforcement: true
      file_upload_limit_in_mb: 88
      js_challenge_cookie_expiration_in_mins: 30
      max_request_body_size_in_kb: 128
      mode: Detection
      request_body_check: true
      request_body_enforcement: true
      request_body_inspect_limit_in_kb: 128
      state: Enabled
      custom_block_response_status_code: 200
      custom_block_response_body: Fredtest
      log_scrubbing:
        state: Enabled
        scrubbing_rules:
          - match_variable: RequestHeaderNames
            selector_match_operator: Equals
            selector: '*'
            state: Enabled
    custom_rules:
      - action: Block
        match_conditions:
          - match_values:
              - 10.1.0.0/24
              - 10.2.0.0/24
            match_variables:
              - variable_name: RemoteAddr
            negation_conditon: true
            operator: IPMatch
            transforms:
              - Uppercase
              - Lowercase
        name: ruledefine01
        priority: 21
        rule_type: MatchRule
        state: Enabled
      - action: Block
        group_by_user_session:
          - group_by_variables:
              - variable_name: ClientAddr
        match_conditions:
          - match_values:
              - 10.1.0.0/24
              - 10.2.0.0/24
            match_variables:
              - variable_name: RemoteAddr
            negation_conditon: false
            operator: IPMatch
        name: ruledefine02
        priority: 22
        rule_type: RateLimitRule
        rate_limit_threshold: 100
        rate_limit_duration: OneMin
        state: Enabled
    managed_rules:
      exclusions:
        - match_variable: RequestHeaderNames
          selector_match_operator: Equals
          selector: IPMatch
          exclusion_managed_rule_sets:
            - rule_set_type: Microsoft_DefaultRuleSet
              rule_set_version: 2.1
      managed_rule_sets:
        - rule_set_type: Microsoft_BotManagerRuleSet
          rule_set_version: 1.0
        - rule_set_type: Microsoft_DefaultRuleSet
          rule_set_version: 2.1

- name: Delete the application firewall policy
  azure_rm_applicationfirewallpolicy:
    resource_group: "{{ resource_group }}"
    name: firewallpolicy
    state: absent

Return Values

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

Key

Description

firewall_policy

complex

A list of the application firewall policy facts

Returned: always

custom_rules

complex

The custom rules inside the policy.

Returned: when used

action

string

The name of the resource that is unique within a policy.

This name can be used to access the resource.

Returned: always

Sample: "Block"

match_conditions

list / elements=string

List of match conditions.

Returned: always

Sample: [{"match_values": ["10.1.0.4"], "match_variables": [{"variable_name": "RemoteAddr"}], "negation_condition": false, "operator": "IPMatch", "transforms": []}]

name

string

The name of the resource that is unique within a policy.

This name can be used to access the resource.

Returned: always

Sample: "testrule01"

priority

integer

Priority of the rule.

Rules with a lower value will be evaluated before rules with a higher value.

Returned: always

Sample: 33

rule_type

string

The rule type.

Returned: always

Sample: "MatchRule"

state

string

Describes if the custom rule is in enabled or disabled state.

Returned: always

Sample: "Enabled"

id

string

The application firewall policy’s ID.

Returned: always

Sample: "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/firewallpolicy"

location

string

Location of application firewall policy.

Returned: always

Sample: "eastus"

managed_rules

complex

Describes the managedRules structure.

Returned: when used

exclusions

list / elements=string

The exceptions that are applied on the policy.

Returned: always

Sample: []

managed_rule_sets

list / elements=string

The managed rule sets that are associated with the policy.

Returned: always

Sample: [{"rule_group_overrides": [], "rule_set_type": "Microsoft_DefaultRuleSet", "rule_set_version": "2.1"}]

name

string

Name of application firewall policy.

Returned: always

Sample: "firewallpolicy"

policy_settings

complex

The PolicySettings for policy.

Returned: when used

file_upload_enforcement

boolean

Whether allow WAF to enforce file upload limits.

Returned: always

Sample: true

file_upload_limit_in_mb

integer

Maximum file upload size in Mb for WAF.

Returned: always

Sample: 100

integer

Web Application Firewall JavaScript Challenge Cookie Expiration time in minutes.

Returned: always

Sample: 30

max_request_body_size_in_kb

integer

Maximum request body size in Kb for WAF.

Returned: always

Sample: 128

mode

string

The mode of the policy.

Returned: always

Sample: "Detection"

request_body_check

boolean

Whether to allow WAF to check request Body.

Returned: always

Sample: false

request_body_enforcement

boolean

Whether allow WAF to enforce request body limits.

Returned: always

Sample: false

state

string

The state of the policy.

Returned: always

Sample: "Enabled"

provisioning_state

string

Provisioning state of application firewall policy.

Returned: always

Sample: "Succeeded"

resource_group

string

Name of resource group.

Returned: always

Sample: "myResourceGroup"

tags

dictionary

The application firewall policy tags.

Returned: always

Sample: {"key1": "value1"}

type

string

The type of the application firewall policy.

Returned: always

Sample: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"

Authors

  • xuzhang3 (@xuzhang3)

  • Fred-sun (@Fred-sun)