diff --git a/lib/ansible/modules/cloud/azure/azure_rm_webappslot.py b/lib/ansible/modules/cloud/azure/azure_rm_webappslot.py index 275d4822638..544075ac9ca 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_webappslot.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_webappslot.py @@ -17,7 +17,7 @@ DOCUMENTATION = ''' --- module: azure_rm_webappslot version_added: "2.8" -short_description: Manage Azure Web App slot. +short_description: Manage Azure Web App slot description: - Create, update and delete Azure Web App slot. @@ -52,9 +52,9 @@ options: action: description: - Swap types. - - preview is to apply target slot settings on source slot first. - - swap is to complete swapping. - - reset is to reset the swap. + - C(preview) is to apply target slot settings on source slot first. + - C(swap) is to complete swapping. + - C(reset) is to reset the swap. choices: - preview - swap @@ -65,7 +65,7 @@ options: - Name of target slot to swap. If set to None, then swap with production slot. preserve_vnet: description: - - True to preserve virtual network to the slot during swap. Otherwise False. + - C(True) to preserve virtual network to the slot during swap. Otherwise C(False). type: bool default: True frameworks: @@ -77,8 +77,10 @@ options: description: - Name of the framework. - Supported framework list for Windows web app and Linux web app is different. - - For Windows web app, supported names(June 2018) java, net_framework, php, python, node. Multiple framework can be set at same time. - - For Linux web app, supported names(June 2018) java, ruby, php, dotnetcore, node. Only one framework can be set. + - Windows web apps support C(java), C(net_framework), C(php), C(python), and C(node) from June 2018. + - Windows web apps support multiple framework at same time. + - Linux web apps support C(java), C(ruby), C(php), C(dotnetcore), and C(node) from June 2018. + - Linux web apps support only one framework. - Java framework is mutually exclusive with others. choices: - java @@ -91,39 +93,44 @@ options: version: description: - Version of the framework. For Linux web app supported value, see U(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, e.g., 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.8, 1.9 for windows web app. 8 for linux web app. + - C(net_framework) supported value sample, C(v4.0) for .NET 4.6 and C(v3.0) for .NET 3.5. + - C(php) supported value sample, C(5.5), C(5.6), C(7.0). + - C(python) supported value sample, C(5.5), C(5.6), C(7.0). + - C(node) supported value sample, C(6.6), C(6.9). + - C(dotnetcore) supported value sample, C(1.0), C(1.1), C(1.2). + - C(ruby) supported value sample, 2.3. + - C(java) supported value sample, C(1.9) for Windows web app. C(1.8) for Linux web app. settings: description: - List of settings of the framework. suboptions: java_container: - description: Name of Java container. This is supported by specific framework C(java) only. e.g. Tomcat, Jetty. + description: + - Name of Java container. This is supported by specific framework C(java) onlys, for example C(Tomcat), C(Jetty). java_container_version: description: - Version of Java container. This is supported by specific framework C(java) only. - - For Tomcat, e.g. 8.0, 8.5, 9.0. For Jetty, e.g. 9.1, 9.3. + - For C(Tomcat), for example C(8.0), C(8.5), C(9.0). For C(Jetty), for example C(9.1), C(9.3). container_settings: - description: Web app slot container settings. + description: + - Web app slot container settings. suboptions: name: - description: Name of container. eg. "imagename:tag" + description: + - Name of container, for example C(imagename:tag). registry_server_url: - description: Container registry server url. eg. mydockerregistry.io + description: + - Container registry server URL, for example C(mydockerregistry.io). registry_server_user: - description: The container registry server user name. + description: + - The container registry server user name. registry_server_password: description: - The container registry server password. startup_file: description: - The slot startup file. - - This only applies for linux web app slot. + - This only applies for Linux web app slot. app_settings: description: - Configure web app slot application settings. Suboptions are in key value pair format. @@ -133,11 +140,11 @@ options: type: bool deployment_source: description: - - Deployment source for git + - Deployment source for git. suboptions: url: description: - - Repository url of deployment source. + - Repository URL of deployment source. branch: description: - The branch name of the repository. @@ -152,19 +159,19 @@ options: default: started state: description: - - Assert the state of the Web App deployment slot. - - Use C(present) to create or update a slot and C(absent) to delete it. + - State of the Web App deployment slot. + - Use C(present) to create or update a slot and C(absent) to delete it. default: present choices: - - absent - - present + - absent + - present extends_documentation_fragment: - azure - azure_tags author: - - "Yunge Zhu(@yungezz)" + - Yunge Zhu(@yungezz) ''' @@ -213,7 +220,8 @@ EXAMPLES = ''' RETURN = ''' id: - description: Id of current slot. + description: + - ID of current slot. returned: always type: str sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/testapp/slots/stage1