cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update azure_rm_webappslot document (#59494)

Browse source 
* Update azure_rm_webappslot document
This commit is contained in:
Fred-sun 2019-07-30 04:15:06 +08:00 committed by Sandra McCann
parent 978fe81a6d
commit 2bc0eecdb3
1 changed files with 37 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
lib/ansible/modules/cloud/azure/azure_rm_webappslot.py
View file

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