Documentation

azure_rm_webapp - Manage Web App instance.

New in version 2.7.

Synopsis

  • Create, update and delete instance of Web App.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults Comments
ad_user
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url
(added in 2.6)
Default:
None
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
(added in 2.5)
Default:
latest
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.
app_settings
Configure web app application settings. Suboptions are in key value pair format.
app_state
str
    Choices:
  • started ←
  • stopped
  • restarted
Start/Stop/Restart the web app.
append_tags
bool
    Choices:
  • no
  • yes ←
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.
auth_source
(added in 2.5)
    Choices:
  • auto
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.
auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.
When set to cli, the credentials will be sources from the default Azure CLI profile.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
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.
cert_validation_mode
(added in 2.5)
    Choices:
  • validate
  • ignore
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.
client_affinity_enabled
bool
    Choices:
  • no
  • yes ←
True to enable client affinity; False to stop sending session affinity cookies, which route client requests in the same session to the same instance.
client_id
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
(added in 2.4)
Default:
AzureCloud
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.
container_settings
Web app container settings.
registry_server_user
The container registry server user name.
registry_server_url
Container registry server url. eg. mydockerregistry.io
name
Name of container. eg. "imagename:tag"
registry_server_password
The container registry server password.
deployment_source
Deployment source for git
url
Repository url of deployment source.
branch
The branch name of the repository.
dns_registration
bool
    Choices:
  • no
  • yes
If true web app hostname is not registered with DNS on creation.
frameworks
Set of run time framework settings. Each setting is a dictionary.
version
Version of the framework. For Linux web app supported value, see https://aka.ms/linux-stacks for more info.
net_framework supported value sample, 'v4.0' for .NET 4.6 and 'v3.0' for .NET 3.5.
php supported value sample, 5.5, 5.6, 7.0.
python supported value sample, e.g., 5.5, 5.6, 7.0.
node supported value sample, 6.6, 6.9.
dotnetcore supported value sample, 1.0, 1,1, 1.2.
ruby supported value sample, 2.3.
java supported value sample, 1.8, 1.9 for windows web app. 8 for linux web app.
name
    Choices:
  • java
  • net_framework
  • php
  • python
  • ruby
  • dotnetcore
  • node
Name of the framework.
Supported framework list for Windows web app and Linux web app is different.
For Windows web app, supported names(June 2018) java, net_framework, php, python, node. Multiple framework can be set at same time.
For Linux web app, supported names(June 2018) java, ruby, php, dotnetcore, node. Only one framework can be set.
Java framework is mutually exclusive with others.
settings
List of settings of the framework.
java_container_version
Version of Java container. This is supported by specific framework java only.
For Tomcat, e.g. 8.0, 8.5, 9.0. For Jetty, e.g. 9.1, 9.3.
java_container
Name of Java container. This is supported by specific framework java only. e.g. Tomcat, Jetty.
https_only
bool
    Choices:
  • no
  • yes
Configures web site to accept only https requests.
location
Resource location. If not set, location from the resource group will be used as default.
name
required
Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.
password
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
plan
App service plan. Required for creation.
It can be name of existing app service plan in same resource group as web app.
It can be resource id of existing app service plan. eg., /subscriptions/<subs_id>/resourceGroups/<resource_group>/providers/Microsoft.Web/serverFarms/<plan_name>
It can be a dict which contains name, resource_group, sku, is_linux and number_of_workers.
name. Name of app service plan.
resource_group. Resource group name of app service plan.
sku. SKU of app service plan. For allowed sku, please refer to https://azure.microsoft.com/en-us/pricing/details/app-service/linux/.
is_linux. Indicates Linux app service plan. type bool. default False.
number_of_workers. Number of workers.
profile
Security profile found in ~/.azure/credentials file.
purge_app_settings
bool
    Choices:
  • no
  • yes
Purge any existing application settings. Replace web app application settings with app_settings.
resource_group
required
Name of the resource group to which the resource belongs.
scm_type
Repository type of deployment source. Eg. LocalGit, GitHub.
secret
Azure client secret. Use when authenticating with a Service Principal.
skip_custom_domain_verification
bool
    Choices:
  • no
  • yes
If true, custom (non *.azurewebsites.net) domains associated with web app are not verified.
startup_file
The web's startup file.
This only applies for linux web app.
state
    Choices:
  • absent
  • present ←
Assert the state of the Web App.
Use 'present' to create or update a Web App and 'absent' to delete it.
subscription_id
Your Azure subscription Id.
tags
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.
tenant
Azure tenant ID. Use when authenticating with a Service Principal.
ttl_in_seconds
Time to live in seconds for web app default domain name.

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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: Create a windows web app with non-exist app service plan
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mywinwebapp
    plan:
      resource_group: myappserviceplan_rg
      name: myappserviceplan
      is_linux: false
      sku: S1

- name: Create a docker web app with some app settings, with docker image
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mydockerwebapp
    plan:
      resource_group: appserviceplan_test
      name: myappplan
      is_linux: true
      sku: S1
      number_of_workers: 2
    app_settings:
      testkey: testvalue
      testkey2: testvalue2
    container_settings:
      name: ansible/ansible:ubuntu1404

- name: Create a docker web app with private acr registry
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mydockerwebapp
    plan: myappplan
    app_settings:
      testkey: testvalue
    container_settings:
      name: ansible/ubuntu1404
      registry_server_url: myregistry.io
      registry_server_user: user
      registry_server_password: pass

- name: Create a linux web app with Node 6.6 framework
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mylinuxwebapp
    plan:
      resource_group: appserviceplan_test
      name: myappplan
    app_settings:
      testkey: testvalue
    frameworks:
      - name: "node"
        version: "6.6"

- name: Create a windows web app with node, php
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mywinwebapp
    plan:
      resource_group: appserviceplan_test
      name: myappplan
    app_settings:
      testkey: testvalue
    frameworks:
      - name: "node"
        version: 6.6
      - name: "php"
        version: "7.0"

- name: Create a linux web app with java framework
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mylinuxwebapp
    plan:
      resource_group: appserviceplan_test
      name: myappplan
    app_settings:
      testkey: testvalue
    frameworks:
      - name: "java"
        version: "8"
        settings:
          java_container: "Tomcat"
          java_container_version: "8.5"

Return Values

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

Key Returned Description
azure_webapp
dict
always
Id of current web app.

Sample:
{'id': '/subscriptions/<subscription_id>/resourceGroups/ansiblewebapp1/providers/Microsoft.Web/sites/ansiblewindowsaaa'}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Yunge Zhu(@yungezz)

Hint

If you notice any issues in this documentation you can edit this document to improve it.