Update azure_rm_virtualnetworkpeering related document (#59025)

* Update azure_rm_virtualnetworkpeering related documentation

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

@@ -15,7 +15,7 @@ DOCUMENTATION = '''
 ---
 module: azure_rm_virtualnetworkpeering
 version_added: "2.8"
-short_description: Manage Azure Virtual Network Peering.
+short_description: Manage Azure Virtual Network Peering
 description:
     - Create, update and delete Azure Virtual Network Peering.
 
@@ -30,17 +30,15 @@ options:
         required: true
     virtual_network:
         description:
-            - Virtual network to be peered.
-            - It can be name of virtual network.
-            - It can be virtual network resource id.
+            - Name or resource ID of the virtual network to be peered.
         required: true
     remote_virtual_network:
         description:
             - Remote virtual network to be peered.
             - It can be name of remote virtual network in same resource group.
-            - It can be remote virtual network resource id.
-            - It can be a dict which contains C(name) and C(resource_group) of remote virtual network.
-            - Required when creating
+            - It can be remote virtual network resource ID.
+            - It can be a dict which contains I(name) and I(resource_group) of remote virtual network.
+            - Required when creating.
     allow_virtual_network_access:
         description:
             - Allows VMs in the remote VNet to access all VMs in the local VNet.
@@ -64,7 +62,7 @@ options:
         default: false
     state:
         description:
-            - Assert the state of the virtual network peering. Use C(present) to create or update a peering and C(absent) to delete it.
+            - State of the virtual network peering. Use C(present) to create or update a peering and C(absent) to delete it.
         default: present
         choices:
             - absent
@@ -98,11 +96,11 @@ EXAMPLES = '''
 '''
 RETURN = '''
 id:
-    description: Id of the Azure virtual network peering
+    description:
+        - ID of the Azure virtual network peering.
     returned: always
-    type: dict
-    example:
-        id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualN
+    type: str
+    sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualN
              etwork/virtualNetworkPeerings/myPeering"
 '''
 

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

@@ -15,7 +15,7 @@ DOCUMENTATION = '''
 ---
 module: azure_rm_virtualnetworkpeering_facts
 version_added: "2.8"
-short_description: Get facts of Azure Virtual Network Peering.
+short_description: Get facts of Azure Virtual Network Peering
 description:
     - Get facts of Azure Virtual Network Peering.
 
@@ -26,9 +26,7 @@ options:
         required: True
     virtual_network:
         description:
-            - The name of Virtual network.
-            - It can be name of virtual network.
-            - It can be virtual network resource id.
+            - Name or resource ID of a virtual network.
         required: True
     name:
         description:
@@ -56,61 +54,74 @@ EXAMPLES = '''
 
 RETURN = '''
 vnetpeerings:
-    description: A list of Virtual Network Peering facts.
+    description:
+        - A list of Virtual Network Peering facts.
     returned: always
     type: complex
     contains:
         id:
-            description: Id of current Virtual Network peering.
+            description: ID of current Virtual Network peering.
             returned: always
             type: str
             sample:
                 "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/virtualNetworkPeerings/peer1"
         name:
-            description: Name of Virtual Network peering.
+            description:
+                - Name of Virtual Network peering.
             returned: always
             type: str
             sample: myPeering
         remote_virtual_network:
-            description: Id of remote Virtual Network to be peered to.
+            description:
+                - ID of remote Virtual Network to be peered to.
             returned: always
             type: str
             sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet2
         remote_address_space:
-            description: The reference of the remote Virtual Network address space.
+            description:
+                - The reference of the remote Virtual Network address space.
             type: complex
+            returned: always
             contains:
                 address_prefixes:
-                    description: A list of address blocks reserved for this Virtual Network in CIDR notation.
+                    description:
+                        - A list of address blocks reserved for this Virtual Network in CIDR notation.
+                    returned: always
                     type: list
                     sample: 10.1.0.0/16
         peering_state:
-            description: The status of the virtual network peering.
+            description:
+                - The state of the virtual network peering.
             returned: always
             type: str
             sample: Connected
         provisioning_state:
-            description: The provisioning state of the resource.
+            description:
+                - The provisioning state of the resource.
             returned: always
             type: str
             sample: Succeeded
         allow_forwarded_traffic:
-            description: Whether the forwarded traffic from the VMs in the remote Virtual Network will be allowed/disallowed.
+            description:
+                - Whether forwarded traffic from the VMs in the remote Virtual Network will be allowed/disallowed.
             returned: always
             type: bool
             sample: False
         allow_gateway_transit:
-            description: If gateway links can be used in remote Virtual Networking to link to this Virtual Network.
+            description:
+                - Whether gateway links can be used in remote Virtual Networking to link to this Virtual Network.
             returned: always
             type: bool
             sample: False
         allow_virtual_network_access:
-            description: Whether the VMs in the linked Virtual Network space would be able to access all the VMs in local Virtual Network space.
+            description:
+                - Whether the VMs in the linked Virtual Network space can access all the VMs in local Virtual Network space.
             returned: always
             type: bool
             sample: False
         use_remote_gateways:
-            description: If remote gateways can be used on this Virtual Network.
+            description:
+                - Whether remote gateways can be used on this Virtual Network.
             returned: always
             type: bool
             sample: False