Update azure_rm_trafficmanagerendpoint related document (#58447)

lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerendpoint.py

@@ -15,7 +15,7 @@ DOCUMENTATION = '''
 ---
 module: azure_rm_trafficmanagerendpoint
 version_added: "2.7"
-short_description: Manage Azure Traffic Manager endpoint.
+short_description: Manage Azure Traffic Manager endpoint
 description:
     - Create, update and delete Azure Traffic Manager endpoint.
 
@@ -31,7 +31,8 @@ options:
         type: str
         required: true
     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
         required: true
     type:
@@ -45,7 +46,7 @@ options:
     target_resource_id:
         description:
             - 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
     target:
         description:
@@ -63,7 +64,7 @@ options:
         type: int
     priority:
         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.
             - This is an optional parameter. If specified, it must be specified on all endpoints.
             - No two endpoints can share the same priority value.
@@ -75,7 +76,7 @@ options:
     min_child_endpoints:
         description:
             - 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
     geo_mapping:
         description:
@@ -93,8 +94,8 @@ extends_documentation_fragment:
     - azure
 
 author:
-    - "Hai Cao (@caohai) <t-haicao@microsoft.com>"
+    - Hai Cao (@caohai)
-    - "Yunge Zhu (@yungezz) <yungez@microsoft.com>"
+    - Yunge Zhu (@yungezz)
 
 '''
 
@@ -113,12 +114,13 @@ EXAMPLES = '''
 
 RETURN = '''
 id:
-  description: The ID of the traffic manager endpoint
+    description:
-  returned: when traffic manager endpoint exists
+        - The ID of the traffic manager endpoint.
-  type: str
+    returned: when traffic manager endpoint exists
-  example:
+    type: str
-    "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficManagerProfiles/testProfil
+    example:
-     e/externalEndpoints/testendpoint"
+        "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficManagerProfiles/testProfil
+        e/externalEndpoints/testendpoint"
 '''
 from ansible.module_utils.azure_rm_common import AzureRMModuleBase, normalize_location_name
 from ansible.module_utils.common.dict_transformations import _snake_to_camel

lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerendpoint_facts.py

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