You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

azure.azcollection.azure_rm_webappaccessrestriction module – Manage web app network access restrictions

Note

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

New in azure.azcollection 1.8.0

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

Synopsis 

Add, remove, or update network access restrictions for a web app.

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
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"`
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.
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"`
ip_security_restrictions list / elements=dictionary	The web app’s HTTP access restrictions.
action string	Traffic action for the access restriction. Choices: `"Allow"` ← (default) `"Deny"`
description string	Description of the access restriction.
ip_address string / required	IPv4 address (with subnet mask) of the access restriction.
name string	Name of the access restriction.
priority integer / required	Numerical priority of the access restriction.
log_mode string	Parent argument.
log_path string	Parent argument.
name string / required	Name of the web app.
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 string / required	Resource group of the web app.
scm_ip_security_restrictions list / elements=dictionary	The web app’s SCM access restrictions. If scm_ip_security_restrictions_use_main is set to `true`, the SCM restrictions will be configured but not used.
action string	Traffic action for the access restriction. Choices: `"Allow"` ← (default) `"Deny"`
description string	Description of the access restriction.
ip_address string / required	IPv4 address (with subnet mask) of the access restriction.
name string	Name of the access restriction.
priority integer / required	Numerical priority of the access restriction.
scm_ip_security_restrictions_use_main boolean	Set to `true` to have the HTTP access restrictions also apply to the SCM site. If scm_ip_security_restrictions are also applied, they will configured but not used. Choices: `false` ← (default) `true`
secret string	Azure client secret. Use when authenticating with a Service Principal.
state string	State of the access restrictions. Use `present` to create or update and `absent` to delete. Choices: `"absent"` `"present"` ← (default)
subscription_id string	Your Azure subscription Id.
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.

Examples 

- name: Configure web app access restrictions.
  azure.azcollection.azure_rm_webappaccessrestriction:
    name: "MyWebapp"
    resource_group: "MyResourceGroup"
    ip_security_restrictions:
      - name: "Datacenter 1"
        action: "Allow"
        ip_address: "1.1.1.1/24"
        priority: 1
      - name: "Datacenter 2"
        action: "Allow"
        ip_address: "2.2.2.2/24"
        priority: 2
    scm_ip_security_restrictions_use_main: true

- name: Delete web app network access restrictions.
  azure.azcollection.azure_rm_webappaccessrestriction:
    name: "MyWebapp"
    resource_group: "MyResourceGroup"
    state: "absent"

Return Values 

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

Key	Description
ip_security_restrictions list / elements=dictionary	The web app’s HTTP access restrictions. Returned: always
action string	Traffic action of the access restriction. Returned: always Sample: `"Allow"`
description string	Description of the access restriction. Returned: always Sample: `"my-access-restriction-description"`
ip_address string	IP address of the access restriction. Returned: always Sample: `"1.1.1.1/32"`
name string	Name of the access restriction. Returned: always Sample: `"my-access-restriction"`
priority integer	Numerical priority of the access restriction. Returned: always Sample: `1`
scm_ip_security_restrictions list / elements=dictionary	The web app’s SCM access restrictions. Returned: always
action string	Traffic action of the access restriction. Returned: always Sample: `"Allow"`
description string	Description of the access restriction. Returned: always Sample: `"my-access-restriction-description"`
ip_address string	IP address of the access restriction. Returned: always Sample: `"1.1.1.1/32"`
name string	Name of the access restriction. Returned: always Sample: `"my-access-restriction"`
priority integer	Numerical priority of the access restriction. Returned: always Sample: `1`
scm_ip_security_restrictions_use_main boolean	Whether the HTTP access restrictions are used for SCM access. Returned: always Sample: `false`

Authors

Ross Bender (@l3ender)

Collection links

Issue Tracker Homepage Repository (Sources)

azure.azcollection.azure_rm_webappaccessrestriction module – Manage web app network access restrictions

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values