azure / azure.azcollection / 2.3.0 / module / azure_rm_webappaccessrestriction Manage web app network access restrictions | "added in version" 1.8.0 of azure.azcollection" Authors: Ross Bender (@l3ender)azure.azcollection.azure_rm_webappaccessrestriction (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Add, remove, or update network access restrictions for a web app.
- 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"
name: description: - Name of the web app. required: true type: str state: choices: - absent - present default: present description: - State of the access restrictions. Use C(present) to create or update and C(absent) to delete. 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 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 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: - Resource group of the web app. 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 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 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 ip_security_restrictions: default: [] description: - The web app's HTTP access restrictions. elements: dict suboptions: action: choices: - Allow - Deny default: Allow description: - Traffic action for the access restriction. type: str description: description: - Description of the access restriction. type: str ip_address: description: - IPv4 address (with subnet mask) of the access restriction. required: true type: str name: description: - Name of the access restriction. type: str priority: description: - Numerical priority of the access restriction. required: true type: int 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 scm_ip_security_restrictions: default: [] description: - The web app's SCM access restrictions. If I(scm_ip_security_restrictions_use_main) is set to C(true), the SCM restrictions will be configured but not used. elements: dict suboptions: action: choices: - Allow - Deny default: Allow description: - Traffic action for the access restriction. type: str description: description: - Description of the access restriction. type: str ip_address: description: - IPv4 address (with subnet mask) of the access restriction. required: true type: str name: description: - Name of the access restriction. type: str priority: description: - Numerical priority of the access restriction. required: true type: int type: list scm_ip_security_restrictions_use_main: default: false description: - Set to C(true) to have the HTTP access restrictions also apply to the SCM site. If I(scm_ip_security_restrictions) are also applied, they will configured but not used. type: bool
ip_security_restrictions: contains: action: description: - Traffic action of the access restriction. returned: always sample: Allow type: str description: description: - Description of the access restriction. returned: always sample: my-access-restriction-description type: str ip_address: description: - IP address of the access restriction. returned: always sample: 1.1.1.1/32 type: str name: description: - Name of the access restriction. returned: always sample: my-access-restriction type: str priority: description: - Numerical priority of the access restriction. returned: always sample: 1 type: int description: - The web app's HTTP access restrictions. elements: dict returned: always type: list scm_ip_security_restrictions: contains: action: description: - Traffic action of the access restriction. returned: always sample: Allow type: str description: description: - Description of the access restriction. returned: always sample: my-access-restriction-description type: str ip_address: description: - IP address of the access restriction. returned: always sample: 1.1.1.1/32 type: str name: description: - Name of the access restriction. returned: always sample: my-access-restriction type: str priority: description: - Numerical priority of the access restriction. returned: always sample: 1 type: int description: - The web app's SCM access restrictions. elements: dict returned: always type: list scm_ip_security_restrictions_use_main: description: - Whether the HTTP access restrictions are used for SCM access. returned: always sample: false type: bool