Update azure_rm_servicebusqueue related document (#58160)

* Update azure_rm_servicebus related document
5 years ago · 7e70184f10
parent af000444d2
commit 7e70184f10
4 changed files with 65 additions and 41 deletions
--- a/lib/ansible/modules/cloud/azure/azure_rm_servicebusqueue.py
+++ b/lib/ansible/modules/cloud/azure/azure_rm_servicebusqueue.py
@ -17,17 +17,17 @@ DOCUMENTATION = '''
 ---
 module: azure_rm_servicebusqueue
 version_added: "2.8"
-short_description: Manage Azure Service Bus queue.
+short_description: Manage Azure Service Bus queue
 description:
    - Create, update or delete an Azure Service Bus queue.
 options:
    resource_group:
        description:
-            - name of resource group.
+            - Name of resource group.
        required: true
    name:
        description:
-            - name of the queue.
+            - Name of the queue.
        required: true
    namespace:
        description:
@ -37,8 +37,7 @@ options:
        required: true
    state:
        description:
-            - Assert the state of the queue. Use 'present' to create or update and
-              'absent' to delete.
+            - Assert the state of the queue. Use C(present) to create or update and use C(absent) to delete.
        default: present
        choices:
            - absent
@ -85,7 +84,7 @@ options:
        type: int
    max_delivery_count:
        description:
-            - he maximum delivery count.
+            - The maximum delivery count.
            - A message is automatically deadlettered after this number of deliveries.
        type: int
    max_size_in_mb:
@ -94,7 +93,7 @@ options:
        type: int
    requires_duplicate_detection:
        description:
-            -  A value indicating if this queue or topic  requires duplicate detection.
+            - A value indicating if this queue or topic requires duplicate detection.
        type: bool
    duplicate_detection_time_in_seconds:
        description:
@ -112,13 +111,12 @@ options:
            - disabled
            - send_disabled
            - receive_disabled
-
 extends_documentation_fragment:
    - azure
    - azure_tags

 author:
-    - "Yuwei Zhou (@yuwzho)"
+    - Yuwei Zhou (@yuwzho)

 '''

@ -132,9 +130,11 @@ EXAMPLES = '''
 '''
 RETURN = '''
 id:
-    description: Current state of the queue.
+    description:
+        - Current state of the queue.
    returned: success
    type: str
+    sample: "/subscriptions/xxx...xxx/resourceGroups/v-xisuRG/providers/Microsoft.ServiceBus/namespaces/nsb57dc9561/queues/queueb57dc9561"
 '''

 try:
--- a/lib/ansible/modules/cloud/azure/azure_rm_servicebussaspolicy.py
+++ b/lib/ansible/modules/cloud/azure/azure_rm_servicebussaspolicy.py
@ -17,22 +17,21 @@ DOCUMENTATION = '''
 ---
 module: azure_rm_servicebussaspolicy
 version_added: "2.8"
-short_description: Manage Azure Service Bus SAS policy.
+short_description: Manage Azure Service Bus SAS policy
 description:
    - Create, update or delete an Azure Service Bus SAS policy.
 options:
    resource_group:
        description:
-            - name of resource group.
+            - Name of resource group.
        required: true
    name:
        description:
-            - name of the sas policy.
+            - Name of the SAS policy.
        required: true
    state:
        description:
-            - Assert the state of the route. Use 'present' to create or update and
-              'absent' to delete.
+            - Assert the state of the route. Use C(present) to create or update and C(absent) to delete.
        default: present
        choices:
            - absent
@ -75,7 +74,7 @@ extends_documentation_fragment:
    - azure_tags

 author:
-    - "Yuwei Zhou (@yuwzho)"
+    - Yuwei Zhou (@yuwzho)

 '''

@ -90,46 +89,68 @@ EXAMPLES = '''
 '''
 RETURN = '''
 id:
-    description: Current state of the SAS policy.
+    description:
+        - Current state of the SAS policy.
    returned: Successed
    type: str
+    sample: "/subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/
+            namespaces/nsb57dc95979/topics/topicb57dc95979/authorizationRules/testpolicy"
 keys:
-    description: Key dict of the SAS policy.
+    description:
+        - Key dict of the SAS policy.
    returned: Successed
-    type: dict
+    type: complex
    contains:
        key_name:
-            description: Name of the SAS policy.
+            description:
+                - Name of the SAS policy.
            returned: Successed
            type: str
+            sample: testpolicy
        primary_connection_string:
-            description: Primary connection string.
+            description:
+                - Primary connection string.
            returned: Successed
            type: str
+            sample: "Endpoint=sb://nsb57dc95979.servicebus.windows.net/;SharedAccessKeyName=testpolicy;
+                    SharedAccessKey=r+HD3es/9aOOq0XjQtkx5KXROH1MIHDs0WxCgR23gMc=;EntityPath=topicb57dc95979"
        primary_key:
-            description: Primary key.
+            description:
+                - Primary key.
            returned: Successed
            type: str
+            sample: "r+HD3es/9aOOq0XjQtkx5KXROH1MIHDs0WxCgR23gMc="
        secondary_key:
-            description: Secondary key.
+            description:
+                - Secondary key.
            returned: Successed
            type: str
+            sample: "/EcGztJBv72VD0Dy14bdsxi30rl+pSZMtKcs4KV3JWU="
        secondary_connection_string:
-            description: Secondary connection string.
+            description:
+                - Secondary connection string.
            returned: Successed
            type: str
+            sample: "Endpoint=sb://nsb57dc95979.servicebus.windows.net/;SharedAccessKeyName=testpolicy;
+                    SharedAccessKey=/EcGztJBv72VD0Dy14bdsxi30rl+pSZMtKcs4KV3JWU=;EntityPath=topicb57dc95979"
 name:
-    description: Name of the SAS policy.
+    description:
+        - Name of the SAS policy.
    returned: Successed
    type: str
+    sample: testpolicy
 rights:
-    description: Priviledge of the SAS policy.
+    description:
+        - Priviledge of the SAS policy.
    returned: Successed
    type: str
+    sample: manage
 type:
-    description: Type of the SAS policy.
+    description:
+        - Type of the SAS policy.
    returned: Successed
    type: str
+    sample: "Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules"
 '''

 try:
--- a/lib/ansible/modules/cloud/azure/azure_rm_servicebustopic.py
+++ b/lib/ansible/modules/cloud/azure/azure_rm_servicebustopic.py
@ -17,17 +17,17 @@ DOCUMENTATION = '''
 ---
 module: azure_rm_servicebustopic
 version_added: "2.8"
-short_description: Manage Azure Service Bus.
+short_description: Manage Azure Service Bus
 description:
    - Create, update or delete an Azure Service Bus topics.
 options:
    resource_group:
        description:
-            - name of resource group.
+            - Name of resource group.
        required: true
    name:
        description:
-            - name of the topic.
+            - Name of the topic.
        required: true
    namespace:
        description:
@ -37,8 +37,7 @@ options:
        required: true
    state:
        description:
-            - Assert the state of the topic. Use 'present' to create or update and
-              'absent' to delete.
+            - Assert the state of the topic. Use C(present) to create or update and use C(absent) to delete.
        default: present
        choices:
            - absent
@ -97,7 +96,7 @@ extends_documentation_fragment:
    - azure_tags

 author:
-    - "Yuwei Zhou (@yuwzho)"
+    - Yuwei Zhou (@yuwzho)

 '''

@ -111,9 +110,11 @@ EXAMPLES = '''
 '''
 RETURN = '''
 id:
-    description: Current state of the topic.
+    description:
+        - Current state of the topic.
    returned: success
    type: str
+    sample: "/subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/nsb57dc95979/topics/topicb57dc95979"
 '''

 try:
--- a/lib/ansible/modules/cloud/azure/azure_rm_servicebustopicsubscription.py
+++ b/lib/ansible/modules/cloud/azure/azure_rm_servicebustopicsubscription.py
@ -17,22 +17,21 @@ DOCUMENTATION = '''
 ---
 module: azure_rm_servicebustopicsubscription
 version_added: "2.8"
-short_description: Manage Azure Service Bus subscription.
+short_description: Manage Azure Service Bus subscription
 description:
    - Create, update or delete an Azure Service Bus subscriptions.
 options:
    resource_group:
        description:
-            - name of resource group.
+            - Name of resource group.
        required: true
    name:
        description:
-            - name of the servicebus subscription.
+            - Name of the servicebus subscription.
        required: true
    state:
        description:
-            - Assert the state of the servicebus subscription. Use 'present' to create or update and
-              'absent' to delete.
+            - Assert the state of the servicebus subscription. Use C(present) to create or update and use C(absent) to delete.
        default: present
        choices:
            - absent
@ -109,7 +108,7 @@ extends_documentation_fragment:
    - azure_tags

 author:
-    - "Yuwei Zhou (@yuwzho)"
+    - Yuwei Zhou (@yuwzho)

 '''

@ -123,9 +122,12 @@ EXAMPLES = '''
 '''
 RETURN = '''
 id:
-    description: Current state of the subscription.
+    description:
+        - Current state of the subscription.
    returned: success
    type: str
+    sample: "/subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/
+            namespaces/nsb57dc95979/topics/topicb57dc95979/subscriptions/subsb57dc95979"
 '''

 try: