azure_rm_webapp – Manage Web App instances¶
New in version 2.7.
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 2.6 |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
|
|||
api_profile
string
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
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 2.5 |
|
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
string
added in 2.5 |
|
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
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 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.
|
|||
name
-
|
Name of container, for example
imagename:tag . |
|||
registry_server_password
-
|
The container registry server password.
|
|||
registry_server_url
-
|
Container registry server URL, for example
mydockerregistry.io . |
|||
registry_server_user
-
|
The container registry server user name.
|
|||
deployment_source
-
|
Deployment source for git.
|
|||
branch
-
|
The branch name of the repository.
|
|||
url
-
|
Repository url of deployment source.
|
|||
dns_registration
boolean
|
|
Whether or not the web app hostname is registered with DNS on creation. Set to
false to register. |
||
frameworks
-
|
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
-
|
|
Name of the framework.
Supported framework list for Windows web app and Linux web app is different.
Windows web apps support
java , net_framework , php , python , and node from June 2018.Windows web apps support multiple framework at the same time.
Linux web apps support
java , ruby , php , dotnetcore , and node from June 2018.Linux web apps support only one framework.
Java framework is mutually exclusive with others.
|
||
settings
-
|
List of settings of the framework.
|
|||
java_container
-
|
Name of Java container.
Supported only when frameworks=java. Sample values
Tomcat , Jetty . |
|||
java_container_version
-
|
Version of Java container.
Supported only when frameworks=java.
Sample values for
Tomcat , 8.0 , 8.5 , 9.0 . For Jetty, , 9.1 , 9.3 . |
|||
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, 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.9 for Windows web app. 1.8 for Linux web app. |
|||
https_only
boolean
|
|
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
string
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
|
|||
plan
-
|
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/<subs_id>/resourceGroups/<resource_group>/providers/Microsoft.Web/serverFarms/<plan_name>.
Can be a dict containing five parameters, defined below.
name , name of app service plan.resource_group , resource group of the app service plan.sku , SKU of app service plan, allowed values listed on https://azure.microsoft.com/en-us/pricing/details/app-service/linux/.is_linux , whether or not the app service plan is Linux. defaults to False .number_of_workers , number of workers for app service plan. |
|||
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
-
/ required
|
Name of the resource group to which the resource belongs.
|
|||
scm_type
-
|
Repository type of deployment source, for example
LocalGit , GitHub .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
true to skip. |
||
startup_file
-
|
The web's startup file.
Used only for Linux web apps.
|
|||
state
-
|
|
State of the Web App.
Use
present to create or update a Web App and absent to delete it. |
||
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
-
|
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¶
See also
- Sign in with Azure CLI
- How to authenticate using the
az login
command.
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 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:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Yunge Zhu (@yungezz)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.