Update azure_rm_rediscache related document (#57721)

* Update azure_rm_rediscache related document

* Update according by comment

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

@@ -17,7 +17,7 @@ DOCUMENTATION = '''
 ---
 module: azure_rm_rediscache
 version_added: "2.8"
-short_description: Manage Azure Cache for Redis instance.
+short_description: Manage Azure Cache for Redis instance
 description:
     - Create, update and delete instance of Azure Cache for Redis.
 
@@ -34,10 +34,12 @@ options:
         description:
             - Resource location. If not set, location from the resource group will be used as default.
     sku:
-        description: Sku info of Azure Cache for Redis.
+        description:
+            - SKU info of Azure Cache for Redis.
         suboptions:
             name:
-                description: Type of Azure Cache for Redis to deploy
+                description:
+                    - Type of Azure Cache for Redis to deploy.
                 choices:
                     - basic
                     - standard
@@ -46,8 +48,8 @@ options:
             size:
                 description:
                     - Size of Azure Cache for Redis to deploy.
-                    - When I(sku) is C(basic) or C(standard), allowed values are C0, C1, C2, C3, C4, C5, C6.
+                    - When I(sku=basic) or I(sku=standard), allowed values are C(C0), C(C1), C(C2), C(C3), C(C4), C(C5), C(C6).
-                    - When I(sku) is C(premium), allowed values are P1, P2, P3, P4.
+                    - When I(sku=premium), allowed values are C(P1), C(P2), C(P3), C(P4).
                     - Please see U(https://docs.microsoft.com/en-us/rest/api/redis/redis/create#sku) for allowed values.
                 choices:
                     - C0
@@ -64,7 +66,7 @@ options:
                 required: True
     enable_non_ssl_port:
         description:
-            - When true, the non-ssl redis server port 6379 will be enabled.
+            - When set I(enable_non_ssl_port=true), the non-ssl Redis server port 6379 will be enabled.
         type: bool
         default: false
     maxfragmentationmemory_reserved:
@@ -92,7 +94,7 @@ options:
             - Please see U(https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings) for more detail.
     shard_count:
         description:
-            - The number of shards to be created when I(sku) is C(premium).
+            - The number of shards to be created when I(sku=premium).
         type: int
     static_ip:
         description:
@@ -100,23 +102,27 @@ options:
     subnet:
         description:
             - Subnet in a virtual network to deploy the Azure Cache for Redis in.
-            - "It can be resource id of subnet, eg.
+            - It can be resource id of subnet, for example
-              /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1"
+              /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1.
-            - It can be a dictionary where contains C(name), C(virtual_network_name) and C(resource_group).
+            - It can be a dictionary where contains I(name), I(virtual_network_name) and I(resource_group).
-            - C(name). Name of the subnet.
+            - I(name). Name of the subnet.
-            - C(resource_group). Resource group name of the subnet.
+            - I(resource_group). Resource group name of the subnet.
-            - C(virtual_network_name). Name of virtual network to which this subnet belongs.
+            - I(virtual_network_name). Name of virtual network to which this subnet belongs.
     tenant_settings:
         description:
             - Dict of tenant settings.
+        type: dict
     reboot:
-        description: Reboot specified Redis node(s). There can be potential data loss.
+        description:
+            - Reboot specified Redis node(s). There can be potential data loss.
         suboptions:
             shard_id:
-                description: If clustering is enabled, the id of the shard to be rebooted.
+                description:
+                    - If clustering is enabled, the id of the shard to be rebooted.
                 type: int
             reboot_type:
-                description: Which Redis node(s) to reboot.
+                description:
+                    - Which Redis node(s) to reboot.
                 choices:
                     - primary
                     - secondary
@@ -127,7 +133,8 @@ options:
             - Regenerate Redis cache's access keys.
         suboptions:
             key_type:
-                description: The Redis key to regenerate.
+                description:
+                    - The Redis key to regenerate.
                 choices:
                     - primary
                     - secondary
@@ -135,7 +142,7 @@ options:
         description:
             - Wait till the Azure Cache for Redis instance provisioning_state is Succeeded.
             - It takes several minutes for Azure Cache for Redis to be provisioned ready for use after creating/updating/rebooting.
-            - Set this option to true to wait for provisioning_state. Set to false if you don't care about provisioning_state.
+            - Set this option to C(true) to wait for provisioning_state. Set to C(false) if you don't care about provisioning_state.
             - Poll wait timeout is 60 minutes.
         type: bool
         default: True
@@ -153,7 +160,7 @@ extends_documentation_fragment:
     - azure_tags
 
 author:
-    - "Yunge Zhu(@yungezz)"
+    - Yunge Zhu(@yungezz)
 
 '''
 
@@ -197,19 +204,17 @@ EXAMPLES = '''
 
 RETURN = '''
 id:
-    description: Id of the Azure Cache for Redis.
+    description:
+        - Id of the Azure Cache for Redis.
     returned: always
     type: str
-    sample: {
+    sample: "/subscriptions/xxxxxxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis"
-        "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis"
-    }
 host_name:
-    description: Host name of the Azure Cache for Redis.
+    description:
-    returned: state is present
+        - Host name of the Azure Cache for Redis.
+    returned: when I(state=present)
     type: str
-    sample: {
+    sample: "myredis.redis.cache.windows.net"
-        "host_name": "myredis.redis.cache.windows.net"
-    }
 '''
 
 import time

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

@@ -26,7 +26,7 @@ description:
 options:
     resource_group:
         description:
-            - The resource group to search for the desired Azure Cache for Redis
+            - The resource group to search for the desired Azure Cache for Redis.
         required: True
     name:
         description:
@@ -44,7 +44,7 @@ extends_documentation_fragment:
     - azure
 
 author:
-    - "Yunge Zhu (@yungezz)"
+    - Yunge Zhu (@yungezz)
 '''
 
 EXAMPLES = '''
@@ -66,7 +66,8 @@ EXAMPLES = '''
 
 RETURN = '''
 rediscaches:
-    description: List of Azure Cache for Redis instances.
+    description:
+        - List of Azure Cache for Redis instances.
     returned: always
     type: complex
     contains:
@@ -90,84 +91,100 @@ rediscaches:
             sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis
         provisioning_state:
             description:
-                - Provisioning state of the redis cahe
+                - Provisioning state of the Redis cache.
             returned: always
             type: str
             sample: Creating
         location:
             description:
                 - Location of the Azure Cache for Redis.
+            returned: always
             type: str
             sample: WestUS
         enable_non_ssl_port:
             description:
                 - Specifies whether the non-ssl Redis server port (6379) is enabled.
+            returned: always
             type: bool
             sample: false
         sku:
             description:
-                - Dict of sku information.
+                - Dict of SKU information.
+            returned: always
             type: dict
             contains:
                 name:
-                    description: Name of the sku.
+                    description:
+                        - Name of the SKU.
                     returned: always
                     type: str
                     sample: standard
                 size:
-                    description: Size of the Azure Cache for Redis.
+                    description:
+                        - Size of the Azure Cache for Redis.
                     returned: always
                     type: str
                     sample: C1
         static_ip:
             description:
                 - Static IP address.
+            returned: always
             type: str
             sample: 10.75.0.11
         subnet:
             description:
                 - The full resource ID of a subnet in a virtual network to deploy the Azure Cache for Redis in.
+            returned: always
             type: str
             sample:
                 - "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/Microsoft.Network/VirtualNetworks/myVirtualNetwo
                    rk/subnets/mySubnet"
         configuration:
             description:
-                - Dict of redis configuration.
+                - Dict of Redis configuration.
+            returned: always
             type: dict
             sample: maxmeory_reserved
         host_name:
             description:
                 - Redis host name.
+            returned: always
             type: str
             sample: testRedis.redis.cache.windows.net
         shard_count:
             description:
                 - The number of shards on a Premium Cluster Cache.
+            returned: always
             type: int
             sample: 1
         tenant_settings:
             description:
                 - Dict of tenant settings.
+            returned: always
             type: dict
+            sample: { "key1": "value1" }
         tags:
             description:
-                - List of tags.
+                - Resource tags.
-            type: list
+            returned: always
-            sample:
+            type: dict
-                - foo
+            sample: { "key1": "value1" }
         access_keys:
             description:
                 - Azure Cache for Redis access keys.
             type: dict
-            returned: when C(return_access_keys) is true.
+            returned: when I(return_access_keys=true)
             contains:
                 primary:
-                    description: The current primary key that clients can use to authenticate the redis cahce.
+                    description:
+                        - The current primary key that clients can use to authenticate the Redis cahce.
+                    returned: always
                     type: str
                     sample: X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx=
                 secondary:
-                    description: The current secondary key that clients can use to authenticate the redis cahce.
+                    description:
+                        - The current secondary key that clients can use to authenticate the Redis cahce.
+                    returned: always
                     type: str
                     sample: X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx=
 '''

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

@@ -17,7 +17,7 @@ DOCUMENTATION = '''
 ---
 module: azure_rm_rediscachefirewallrule
 version_added: "2.8"
-short_description: Manage Azure Cache for Redis Firewall rules.
+short_description: Manage Azure Cache for Redis Firewall rules
 description:
     - Create, update and delete Azure Cache for Redis Firewall rules.
 
@@ -55,7 +55,7 @@ extends_documentation_fragment:
     - azure
 
 author:
-    - "Yunge Zhu(@yungezz)"
+    - Yunge Zhu(@yungezz)
 
 '''
 
@@ -78,11 +78,11 @@ EXAMPLES = '''
 
 RETURN = '''
 id:
-    description: Id of the Azure Cache for Redis.
+    description:
+        - Id of the Azure Cache for Redis.
     returned: always
     type: str
-    sample:
+    sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/redis/myRedis/firewallRules/myRule"
-        "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/redis/myRedis/firewallRules/myRule"
 '''
 
 import time