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

Update azure_rm_trafficmanagerendpoint related document (#58447)

Browse source
This commit is contained in:
Fred-sun 2019-07-02 00:31:54 +08:00 committed by Alicia Cozine
parent c86c079837
commit 6557322e79
2 changed files with 31 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerendpoint.py
View file

@ -15,7 +15,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_trafficmanagerendpoint module: azure_rm_trafficmanagerendpoint
version_added: "2.7" version_added: "2.7"
short_description: Manage Azure Traffic Manager endpoint. short_description: Manage Azure Traffic Manager endpoint
description: description:
- Create, update and delete Azure Traffic Manager endpoint. - Create, update and delete Azure Traffic Manager endpoint.
@ -31,7 +31,8 @@ options:
type: str type: str
required: true required: true
profile_name: profile_name:
description: Name of Traffic Manager profile where this endpoints attaches to. description:
- Name of Traffic Manager profile where this endpoints attaches to.
type: str type: str
required: true required: true
type: type:
@ -45,7 +46,7 @@ options:
target_resource_id: target_resource_id:
description: description:
- The Azure Resource URI of the of the endpoint. - The Azure Resource URI of the of the endpoint.
- Not applicable to endpoints of I(type) C(external_endpoints). - Not applicable to endpoints of I(type=external_endpoints).
type: str type: str
target: target:
description: description:
@ -63,7 +64,7 @@ options:
type: int type: int
priority: priority:
description: description:
- The priority of this endpoint when traffic manager profile has routing_method of C(priority). - The priority of this endpoint when traffic manager profile has routing_method of I(priority).
- Possible values are from 1 to 1000, lower values represent higher priority. - Possible values are from 1 to 1000, lower values represent higher priority.
- This is an optional parameter. If specified, it must be specified on all endpoints. - This is an optional parameter. If specified, it must be specified on all endpoints.
- No two endpoints can share the same priority value. - No two endpoints can share the same priority value.
@ -75,7 +76,7 @@ options:
min_child_endpoints: min_child_endpoints:
description: description:
- The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. - The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available.
- Only applicable to endpoint of I(type) (nested_endpoints). - Only applicable to endpoint of I(type=nested_endpoints).
type: int type: int
geo_mapping: geo_mapping:
description: description:
@ -93,8 +94,8 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Hai Cao (@caohai) <t-haicao@microsoft.com>" - Hai Cao (@caohai)
- "Yunge Zhu (@yungezz) <yungez@microsoft.com>" - Yunge Zhu (@yungezz)
''' '''
@ -113,7 +114,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
id: id:
description: The ID of the traffic manager endpoint description:
- The ID of the traffic manager endpoint.
returned: when traffic manager endpoint exists returned: when traffic manager endpoint exists
type: str type: str
example: example:

22
lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerendpoint_facts.py
View file

@ -21,7 +21,7 @@ version_added: "2.7"
short_description: Get Azure Traffic Manager endpoint facts short_description: Get Azure Traffic Manager endpoint facts
description: description:
- Get facts for a specific Traffic Manager endpoints or all endpoints in a Traffic Manager profile - Get facts for a specific Traffic Manager endpoints or all endpoints in a Traffic Manager profile.
options: options:
name: name:
@ -29,11 +29,11 @@ options:
- Limit results to a specific Traffic Manager endpoint. - Limit results to a specific Traffic Manager endpoint.
resource_group: resource_group:
description: description:
- The resource group to search for the desired Traffic Manager profile - The resource group to search for the desired Traffic Manager profile.
required: True required: True
profile_name: profile_name:
description: description:
- Name of Traffic Manager Profile - Name of Traffic Manager Profile.
required: True required: True
type: type:
description: description:
@ -47,8 +47,8 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Hai Cao (@caohai) <t-haicao@microsoft.com>" - Hai Cao (@caohai)
- "Yunge Zhu (@yungezz) <yungez@microsoft.com>" - Yunge Zhu (@yungezz)
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -67,7 +67,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
endpoints: endpoints:
description: List of Traffic Manager endpoints. description:
- List of Traffic Manager endpoints.
returned: always returned: always
type: complex type: complex
contains: contains:
@ -86,46 +87,55 @@ endpoints:
type: type:
description: description:
- The type of the endpoint. - The type of the endpoint.
returned: always
type: str type: str
sample: external_endpoints sample: external_endpoints
target_resource_id: target_resource_id:
description: description:
- The Azure Resource URI of the of the endpoint. - The Azure Resource URI of the of the endpoint.
returned: always
type: str type: str
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/vscjavaci sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/vscjavaci
target: target:
description: description:
- The fully-qualified DNS name of the endpoint. - The fully-qualified DNS name of the endpoint.
returned: always
type: str type: str
sample: 8.8.8.8 sample: 8.8.8.8
enabled: enabled:
description: description:
- The status of the endpoint. - The status of the endpoint.
returned: always
type: str type: str
sample: Enabled sample: Enabled
weight: weight:
description: description:
- The weight of this endpoint when using the 'Weighted' traffic routing method. - The weight of this endpoint when using the 'Weighted' traffic routing method.
returned: always
type: int type: int
sample: 10 sample: 10
priority: priority:
description: description:
- The priority of this endpoint when using the 'Priority' traffic routing method. - The priority of this endpoint when using the 'Priority' traffic routing method.
returned: always
type: str type: str
sample: 3 sample: 3
location: location:
description: description:
- The location of the external or nested endpoints when using the 'Performance' traffic routing method. - The location of the external or nested endpoints when using the 'Performance' traffic routing method.
returned: always
type: str type: str
sample: East US sample: East US
min_child_endpoints: min_child_endpoints:
description: description:
- The minimum number of endpoints that must be available in the child profile to make the parent profile available. - The minimum number of endpoints that must be available in the child profile to make the parent profile available.
returned: always
type: int type: int
sample: 3 sample: 3
geo_mapping: geo_mapping:
description: description:
- The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. - The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method.
returned: always
type: list type: list
sample: [ sample: [
"GEO-NA", "GEO-NA",