Note
This plugin is part of the azure.azcollection collection (version 1.10.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
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
The below requirements are needed on the host that executes this module.
| 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 latest is appropriate for public clouds; future values will allow use with Azure Stack. | ||
| 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 ANSIBLE_AZURE_AUTH_SOURCE environment variable.When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.When set to env, the credentials will be read from the environment variablesWhen set to credential_file, it will read the profile from ~/.azure/credentials.When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 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. | ||
| 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 ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable. | ||
| 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, 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. | ||
| 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 imagename:tag. | |||
| registry_server_password string | The container registry server password. | |||
| registry_server_url string | Container registry server URL, for example mydockerregistry.io. | |||
| 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 java, net_framework, php, python, and node from June 2018.Windows web apps support multiple framework at 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 string | List of settings of the framework. | |||
| java_container string | Name of Java container. This is supported by specific framework java onlys, for example Tomcat, Jetty. | |||
| java_container_version string | Version of Java container. This is supported by specific framework java only.For Tomcat, for example 8.0, 8.5, 9.0. For Jetty, for example 9.1, 9.3. | |||
| version string | 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. | |||
| location string | Resource location. If not set, location from the resource group will be used as default. | |||
| log_mode string | Parent argument. | |||
| log_path string | Parent argument. | |||
| 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 present to create or update a slot and absent to delete it. | ||
| subscription_id string | Your Azure subscription Id. | |||
| swap string | Swap deployment slots of a web app. | |||
| action string |
| Swap types. preview is to apply target slot settings on source slot first.swap is to complete swapping.reset is to reset the swap. | ||
| preserve_vnet boolean |
| True to preserve virtual network to the slot during swap. Otherwise False. | ||
| 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. Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag. Azure Front Door doesn't support the use of Azure Automation and Azure CDN only support 15 tags on resources. | |||
| 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. | |||
Note
az login.See also
How to authenticate using the az login command.
- 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"
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 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_webappslot_module.html