azure.azcollection.azure_rm_webappslot – Manage Azure Web App slot
azure.azcollection.azure_rm_webappslot – Manage Azure Web App slot
Note
This plugin is part of the azure.azcollection collection (version 1.4.0).
To install it use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_webappslot
.
New in version 0.1.2: of azure.azcollection
Synopsis
- Create, update and delete Azure Web App slot.
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 slot application settings. Suboptions are in key value pair format. | |||
app_state string |
|
Start/Stop/Restart the slot. | ||
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 | ||
auto_swap_slot_name string |
Used to configure target slot name to auto swap, or disable auto swap. Set it target slot name to auto swap. Set it to False to disable auto slot swap. | |||
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_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, | ||
configuration_source string |
Source slot to clone configurations from when creating slot. Use webapp's name to refer to the production slot. | |||
container_settings string |
Web app slot container settings. | |||
name string |
Name of container, for example | |||
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. | |||
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 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. This is supported by specific framework | |||
java_container_version string |
Version of Java container. This is supported by specific framework For | |||
version string |
Version of the framework. For Linux web app supported value, see https://aka.ms/linux-stacks for more info.
| |||
location string |
Resource location. If not set, location from the resource group will be used as default. | |||
name string / required |
Unique name of the deployment slot to create or update. | |||
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. | |||
purge_app_settings boolean |
|
Purge any existing application settings. Replace slot application settings with app_settings. | ||
resource_group string / required |
Name of the resource group to which the resource belongs. | |||
secret string |
Azure client secret. Use when authenticating with a Service Principal. | |||
startup_file string |
The slot startup file. This only applies for Linux web app slot. | |||
state string |
|
State of the Web App deployment slot. Use | ||
subscription_id string |
Your Azure subscription Id. | |||
swap string |
Swap deployment slots of a web app. | |||
action string |
|
Swap types.
| ||
preserve_vnet boolean |
|
| ||
target_slot string |
Name of target slot to swap. If set to None, then swap with production slot. | |||
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. | |||
webapp_name string / required |
Web app name which this deployment slot belongs to. |
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 webapp slot
azure_rm_webappslot:
resource_group: myResourceGroup
webapp_name: myJavaWebApp
name: stage
configuration_source: myJavaWebApp
app_settings:
testkey: testvalue
- name: swap the slot with production slot
azure_rm_webappslot:
resource_group: myResourceGroup
webapp_name: myJavaWebApp
name: stage
swap:
action: swap
- name: stop the slot
azure_rm_webappslot:
resource_group: myResourceGroup
webapp_name: myJavaWebApp
name: stage
app_state: stopped
- name: udpate a webapp slot app settings
azure_rm_webappslot:
resource_group: myResourceGroup
webapp_name: myJavaWebApp
name: stage
app_settings:
testkey: testvalue2
- name: udpate a webapp slot frameworks
azure_rm_webappslot:
resource_group: myResourceGroup
webapp_name: myJavaWebApp
name: stage
frameworks:
- name: "node"
version: "10.1"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
id string |
always |
ID of current slot.
Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/testapp/slots/stage1 |
Authors
- Yunge Zhu(@yungezz)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_webappslot_module.html