Support 'description' to azure_rm_adgroup

plugins/modules/azure_rm_adgroup.py

@@ -63,6 +63,10 @@
             - The azure ad objects asserted to not be owners of the group.
         type: list
         elements: str
+    description:
+        description:
+            - An optional description for the group.
+        type: str
 extends_documentation_fragment:
     - azure.azcollection.azure
 author:
@@ -74,6 +78,7 @@
   azure_rm_adgroup:
     display_name: "Group-Name"
     mail_nickname: "Group-Mail-Nickname"
+    description: 'fortest'
     state: 'present'
 
 - name: Delete Group using display_name and mail_nickname
@@ -201,6 +206,12 @@
         - The members of the group.
     returned: always
     type: list
+description:
+    description:
+        - An optional description for the group.
+    type: str
+    returned: always
+    sample: 'fortest'
 '''
 
 from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common_ext import AzureRMModuleBase
@@ -228,6 +239,7 @@ def __init__(self):
             present_owners=dict(type='list', elements='str'),
             absent_members=dict(type='list', elements='str'),
             absent_owners=dict(type='list', elements='str'),
+            description=dict(type='str'),
             state=dict(
                 type='str',
                 default='present',
@@ -287,6 +299,7 @@ def exec_module(self, **kwargs):
                             group_types=[],
                             display_name=self.display_name,
                             mail_nickname=self.mail_nickname,
+                            description=self.description
                         )
 
                         ad_groups = [asyncio.get_event_loop().run_until_complete(self.create_group(group))]
@@ -390,7 +403,8 @@ def group_to_dict(self, object):
             mail_nickname=object.mail_nickname,
             mail_enabled=object.mail_enabled,
             security_enabled=object.security_enabled,
-            mail=object.mail
+            mail=object.mail,
+            description=object.description
         )
 
     def user_to_dict(self, object):

plugins/modules/azure_rm_adgroup_info.py

@@ -156,6 +156,12 @@
         - The members of the group.
     returned: always
     type: list
+description:
+    description:
+        - An optional description for the group.
+    type: str
+    returned: always
+    sample: 'fortest'
 '''
 
 from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common_ext import AzureRMModuleBase
@@ -259,7 +265,8 @@ def group_to_dict(self, object):
             mail_nickname=object.mail_nickname,
             mail_enabled=object.mail_enabled,
             security_enabled=object.security_enabled,
-            mail=object.mail
+            mail=object.mail,
+            description=object.description
         )
 
     def user_to_dict(self, object):

tests/integration/targets/azure_rm_adgroup/tasks/main.yml

@@ -15,13 +15,15 @@
   azure_rm_adgroup:
     display_name: "{{ resource_prefix }}-Group-Root"
     mail_nickname: "{{ resource_prefix }}-Group-Root"
+    description: 'for test'
     state: 'present'
   register: group_create_changed_shouldpass
 
 - name: Create Group Should Return Not Changed
   azure_rm_adgroup:
     display_name: "{{ resource_prefix }}-Group-Root"
     mail_nickname: "{{ resource_prefix }}-Group-Root"
+    description: 'for test'
     state: 'present'
   register: group_create_unchanged_shouldpass
 
@@ -45,6 +47,7 @@
   ansible.builtin.assert:
     that:
       - get_created_object_id_shouldpass.ad_groups[0].object_id == group_create_unchanged_shouldpass.object_id
+      - get_created_object_id_shouldpass.ad_groups[0].description == 'for test'
 
 - name: Create Group Member 1
   azure_rm_adgroup: