azure.azcollection.azure_rm_webapp – Manage Web App instances
azure.azcollection.azure_rm_webapp – Manage Web App instances
Note
This plugin is part of the azure.azcollection collection (version 1.3.1).
To install it use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_webapp
.
New in version 0.1.2: of azure.azcollection
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 string |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |||
adfs_authority_url string added in 0.0.1 of azure.azcollection |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | |||
api_profile string added in 0.0.1 of azure.azcollection |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of | ||
app_settings string |
Configure web app application settings. Suboptions are in key value pair format. | |||
app_state string |
|
Start/Stop/Restart the web app. | ||
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. | ||
auth_source string added in 0.0.1 of azure.azcollection |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The | ||
cert_validation_mode string added in 0.0.1 of azure.azcollection |
|
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 | ||
client_affinity_enabled boolean |
|
Whether or not to send session affinity cookies, which route client requests in the same session to the same instance. | ||
client_id string |
Azure client ID. Use when authenticating with a Service Principal. | |||
cloud_environment string added in 0.0.1 of azure.azcollection |
Default: "AzureCloud" |
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, | ||
container_settings string |
Web app container settings. | |||
name string |
Name of the container, for example To create a multi-container app, the name should be 'COMPOSE|' or 'KUBE|' followed by base64 encoded configuration. | |||
registry_server_password string |
The container registry server password. | |||
registry_server_url string |
Container registry server URL, for example | |||
registry_server_user string |
The container registry server user name. | |||
deployment_source string |
Deployment source for git. | |||
branch string |
The branch name of the repository. | |||
url string |
Repository url of deployment source. | |||
dns_registration boolean |
|
Whether or not the web app hostname is registered with DNS on creation. Set to | ||
frameworks string |
Set of run time framework settings. Each setting is a dictionary. See https://docs.microsoft.com/en-us/azure/app-service/app-service-web-overview for more info. | |||
name string |
|
Name of the framework. Supported framework list for Windows web app and Linux web app is different. Windows web apps support Windows web apps support multiple framework at the same time. Linux web apps support Linux web apps support only one framework. Java framework is mutually exclusive with others. | ||
settings string |
List of settings of the framework. | |||
java_container string |
Name of Java container. Supported only when frameworks=java. Sample values | |||
java_container_version string |
Version of Java container. Supported only when frameworks=java. Sample values for | |||
version string |
Version of the framework. For Linux web app supported value, see https://aka.ms/linux-stacks for more info.
| |||
https_only boolean |
|
Configures web site to accept only https requests. | ||
location string |
Resource location. If not set, location from the resource group will be used as default. | |||
name string / required |
Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. | |||
password string |
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |||
plan string |
App service plan. Required for creation. Can be name of existing app service plan in same resource group as web app. Can be the resource ID of an existing app service plan. For example /subscriptions//resourceGroups//providers/Microsoft.Web/serverFarms/. Can be a dict containing five parameters, defined below.
| |||
profile string |
Security profile found in ~/.azure/credentials file. | |||
purge_app_settings boolean |
|
Purge any existing application settings. Replace web app application settings with app_settings. | ||
resource_group string / required |
Name of the resource group to which the resource belongs. | |||
scm_type string |
Repository type of deployment source, for example List of supported values maintained at https://docs.microsoft.com/en-us/rest/api/appservice/webapps/createorupdate#scmtype. | |||
secret string |
Azure client secret. Use when authenticating with a Service Principal. | |||
skip_custom_domain_verification boolean |
|
Whether or not to skip verification of custom (non *.azurewebsites.net) domains associated with web app. Set to | ||
startup_file string |
The web's startup file. Used only for Linux web apps. | |||
state string |
|
State of the Web App. Use | ||
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. | |||
tenant string |
Azure tenant ID. Use when authenticating with a Service Principal. | |||
ttl_in_seconds string |
Time to live in seconds for web app default domain name. |
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
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: myAppServicePlan_rg
name: myAppServicePlan
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: myAppServicePlan
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 multi-container web app
azure_rm_webapp:
resource_group: myResourceGroup
name: myMultiContainerWebapp
plan: myAppServicePlan
app_settings:
testkey: testvalue
container_settings:
name: "COMPOSE|{{ lookup('file', 'docker-compose.yml') | b64encode }}"
- name: Create a linux web app with Node 6.6 framework
azure_rm_webapp:
resource_group: myResourceGroup
name: myLinuxWebapp
plan:
resource_group: myAppServicePlan_rg
name: myAppServicePlan
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: myAppServicePlan_rg
name: myAppServicePlan
app_settings:
testkey: testvalue
frameworks:
- name: "node"
version: 6.6
- name: "php"
version: "7.0"
- name: Create a stage deployment slot for an existing web app
azure_rm_webapp:
resource_group: myResourceGroup
name: myWebapp/slots/stage
plan:
resource_group: myAppServicePlan_rg
name: myAppServicePlan
app_settings:
testkey:testvalue
- name: Create a linux web app with java framework
azure_rm_webapp:
resource_group: myResourceGroup
name: myLinuxWebapp
plan:
resource_group: myAppServicePlan_rg
name: myAppServicePlan
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 string |
always |
ID of current web app.
Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp |
Authors
- Yunge Zhu (@yungezz)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_webapp_module.html