ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Update azure_rm_functionapp related document (#56985)

Browse source 
* Update azure_rm_functionapp related documentation
This commit is contained in:
Fred-sun 2019-05-30 10:33:11 -04:00 committed by Alicia Cozine
parent df442751f7
commit 511c385da6
2 changed files with 22 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
lib/ansible/modules/cloud/azure/azure_rm_functionapp.py
View file

@ -19,17 +19,17 @@ module: azure_rm_functionapp
version_added: "2.4" version_added: "2.4"
short_description: Manage Azure Function Apps short_description: Manage Azure Function Apps
description: description:
- Create, update or delete an Azure Function App - Create, update or delete an Azure Function App.
options: options:
resource_group: resource_group:
description: description:
- Name of resource group - Name of resource group.
required: true required: true
aliases: aliases:
- resource_group_name - resource_group_name
name: name:
description: description:
- Name of the Azure Function App - Name of the Azure Function App.
required: true required: true
location: location:
description: description:
@ -38,8 +38,8 @@ options:
description: description:
- App service plan. - App service plan.
- It can be name of existing app service plan in same resource group as function app. - 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., - It can be resource id of existing app service plan.
/subscriptions/<subs_id>/resourceGroups/<resource_group>/providers/Microsoft.Web/serverFarms/<plan_name>" - Resource id. For example /subscriptions/<subs_id>/resourceGroups/<resource_group>/providers/Microsoft.Web/serverFarms/<plan_name>.
- It can be a dict which contains C(name), C(resource_group). - It can be a dict which contains C(name), C(resource_group).
- C(name). Name of app service plan. - C(name). Name of app service plan.
- C(resource_group). Resource group 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. description: Web app container settings.
suboptions: suboptions:
name: name:
description: Name of container. eg. "imagename:tag" description:
- Name of container. For example "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.
@ -66,11 +69,10 @@ options:
- storage_account_name - storage_account_name
app_settings: app_settings:
description: description:
- Dictionary containing application settings - Dictionary containing application settings.
state: state:
description: description:
- Assert the state of the Function App. Use C(present) to create or update a Function App and - Assert the state of the Function App. Use C(present) to create or update a Function App and C(absent) to delete.
C(absent) to delete.
default: present default: present
choices: choices:
- absent - absent
@ -81,7 +83,7 @@ extends_documentation_fragment:
- azure_tags - azure_tags
author: author:
- "Thomas Stringer (@trstringer)" - Thomas Stringer (@trstringer)
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -121,7 +123,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
state: state:
description: Current state of the Azure Function App description:
- Current state of the Azure Function App.
returned: success returned: success
type: dict type: dict
example: example:

11
lib/ansible/modules/cloud/azure/azure_rm_functionapp_facts.py
View file

@ -19,14 +19,14 @@ module: azure_rm_functionapp_facts
version_added: "2.4" version_added: "2.4"
short_description: Get Azure Function App facts short_description: Get Azure Function App facts
description: 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: options:
name: name:
description: description:
- Only show results for a specific Function App - Only show results for a specific Function App.
resource_group: resource_group:
description: description:
- Limit results to a resource group. Required when filtering by name - Limit results to a resource group. Required when filtering by name.
aliases: aliases:
- resource_group_name - resource_group_name
tags: tags:
@ -37,7 +37,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Thomas Stringer (@trstringer)" - Thomas Stringer (@trstringer)
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -58,7 +58,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
azure_functionapps: azure_functionapps:
description: List of Azure Function Apps dicts description:
- List of Azure Function Apps dicts.
returned: always returned: always
type: list type: list
example: example: