From 511c385da68f38e47108c003b6ea0dd59afb57a7 Mon Sep 17 00:00:00 2001 From: Fred-sun <37327967+Fred-sun@users.noreply.github.com> Date: Thu, 30 May 2019 10:33:11 -0400 Subject: [PATCH] Update azure_rm_functionapp related document (#56985) * Update azure_rm_functionapp related documentation --- .../cloud/azure/azure_rm_functionapp.py | 29 ++++++++++--------- .../cloud/azure/azure_rm_functionapp_facts.py | 11 +++---- 2 files changed, 22 insertions(+), 18 deletions(-) diff --git a/lib/ansible/modules/cloud/azure/azure_rm_functionapp.py b/lib/ansible/modules/cloud/azure/azure_rm_functionapp.py index fe4fb6a2bac..0c372a88dec 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_functionapp.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_functionapp.py @@ -19,17 +19,17 @@ module: azure_rm_functionapp version_added: "2.4" short_description: Manage Azure Function Apps description: - - Create, update or delete an Azure Function App + - Create, update or delete an Azure Function App. options: resource_group: description: - - Name of resource group + - Name of resource group. required: true aliases: - resource_group_name name: description: - - Name of the Azure Function App + - Name of the Azure Function App. required: true location: description: @@ -38,8 +38,8 @@ options: description: - App service plan. - It can be name of existing app service plan in same resource group as function app. - - "It can be resource id of existing app service plan. eg., - /subscriptions//resourceGroups//providers/Microsoft.Web/serverFarms/" + - It can be resource id of existing app service plan. + - Resource id. For example /subscriptions//resourceGroups//providers/Microsoft.Web/serverFarms/. - It can be a dict which contains C(name), C(resource_group). - C(name). Name of app service plan. - C(resource_group). Resource group name of app service plan. @@ -48,11 +48,14 @@ options: description: Web app container settings. suboptions: name: - description: Name of container. eg. "imagename:tag" + description: + - Name of container. For example "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. @@ -66,11 +69,10 @@ options: - storage_account_name app_settings: description: - - Dictionary containing application settings + - Dictionary containing application settings. state: description: - - Assert the state of the Function App. Use C(present) to create or update a Function App and - C(absent) to delete. + - Assert the state of the Function App. Use C(present) to create or update a Function App and C(absent) to delete. default: present choices: - absent @@ -81,7 +83,7 @@ extends_documentation_fragment: - azure_tags author: - - "Thomas Stringer (@trstringer)" + - Thomas Stringer (@trstringer) ''' EXAMPLES = ''' @@ -121,7 +123,8 @@ EXAMPLES = ''' RETURN = ''' state: - description: Current state of the Azure Function App + description: + - Current state of the Azure Function App. returned: success type: dict example: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_functionapp_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_functionapp_facts.py index 91df7de7a6d..b3fbb1f86e3 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_functionapp_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_functionapp_facts.py @@ -19,14 +19,14 @@ module: azure_rm_functionapp_facts version_added: "2.4" short_description: Get Azure Function App facts description: - - Get facts for one Azure Function App or all Function Apps within a resource group + - Get facts for one Azure Function App or all Function Apps within a resource group. options: name: description: - - Only show results for a specific Function App + - Only show results for a specific Function App. resource_group: description: - - Limit results to a resource group. Required when filtering by name + - Limit results to a resource group. Required when filtering by name. aliases: - resource_group_name tags: @@ -37,7 +37,7 @@ extends_documentation_fragment: - azure author: - - "Thomas Stringer (@trstringer)" + - Thomas Stringer (@trstringer) ''' EXAMPLES = ''' @@ -58,7 +58,8 @@ EXAMPLES = ''' RETURN = ''' azure_functionapps: - description: List of Azure Function Apps dicts + description: + - List of Azure Function Apps dicts. returned: always type: list example: