azure_rm_webappslot – Manage Azure Web App slot — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# azure_rm_webappslot – Manage Azure Web App slot

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- See Also
- Examples
- Return Values
- Status

## 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 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 slot application settings. Suboptions are in key value pair format.
app_state string | Choices: started ← stopped restarted | Start/Stop/Restart the slot.
append_tags boolean | 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 string 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.
auto_swap_slot_name - |  | 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 2.5 | Choices: ignore validate | 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 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.
configuration_source - |  | Source slot to clone configurations from when creating slot. Use webapp's name to refer to the production slot.
container_settings - |  | Web app slot 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.
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 - | 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. 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 - |  | List of settings of the framework.
|  | java_container - |  | Name of Java container. This is supported by specific framework `java` onlys, for example `Tomcat`, `Jetty`.
|  | java_container_version - |  | 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 - |  | 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 - |  | Resource location. If not set, location from the resource group will be used as default.
name - / 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 | Choices: no yes | Purge any existing application settings. Replace slot application settings with app_settings.
resource_group - / 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 - |  | The slot startup file. This only applies for Linux web app slot.
state - | Choices: absent present ← | 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 - |  | Swap deployment slots of a web app.
| action - | Choices: preview ← swap reset | 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 | Choices: no yes ← | `True` to preserve virtual network to the slot during swap. Otherwise `False`.
| target_slot - |  | 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 - / 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

See also

Sign in with Azure CLI
  How to authenticate using the `az login` command.

## 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

## 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.