Merge pull request Azure#9183 from lwajswaj/enhancement/issue_9004

Added ability to set 'Description' field when calling New-AzADGroup (Issue Azure#9004)

Author: cormacpayne

src/Resources/Resources/ActiveDirectory/Cmdlets/NewAzureADGroupCommand.cs

@@ -31,13 +31,22 @@ public class NewAzureADGroupCommand : ActiveDirectoryBaseCmdlet
         [ValidateNotNullOrEmpty]
         public string MailNickname { get; set; }
 
+        [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "The description for the group.")]
+        public string Description { get; set; }
+ 
         public override void ExecuteCmdlet()
         {
             var groupCreateParams = new GroupCreateParameters()
             {
                 DisplayName = DisplayName,
-                MailNickname = MailNickname
+                MailNickname = MailNickname,
+                AdditionalProperties = new System.Collections.Generic.Dictionary<string, object>()
             };
+      
+            if (!string.IsNullOrEmpty(Description))
+            {
+                groupCreateParams.AdditionalProperties.Add("description", Description);
+            }
 
             ExecutionBlock(() =>
             {

src/Resources/Resources/ActiveDirectory/Models/ActiveDirectoryClientExtensions.cs

@@ -1,4 +1,4 @@
-// ----------------------------------------------------------------------------------
+// ----------------------------------------------------------------------------------
 //
 // Copyright Microsoft Corporation
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -60,7 +60,8 @@ public static PSADObject ToPSADObject(this AADObject obj)
                     Id = obj.ObjectId,
                     Type = obj.ObjectType,
                     SecurityEnabled = obj.SecurityEnabled,
-                    MailNickname = obj.Mail
+                    MailNickname = !string.IsNullOrEmpty(obj.Mail) ? obj.Mail : obj.AdditionalProperties.ContainsKey("mailNickname") ? obj.AdditionalProperties["mailNickname"]?.ToString() : null,
+                    Description = obj.AdditionalProperties.ContainsKey("description") ? obj.AdditionalProperties["description"]?.ToString() : null
                 };
             }
             else if (obj.ObjectType == typeof(ServicePrincipal).Name)
@@ -110,7 +111,8 @@ public static PSADGroup ToPSADGroup(this ADGroup group)
                 DisplayName = group.DisplayName,
                 Id = group.ObjectId,
                 SecurityEnabled = group.SecurityEnabled,
-                MailNickname = group.Mail
+                MailNickname =  !string.IsNullOrEmpty(group.Mail) ? group.Mail : group.AdditionalProperties.ContainsKey("mailNickname") ? group.AdditionalProperties["mailNickname"]?.ToString() : null,
+                Description = group.AdditionalProperties.ContainsKey("description") ? group.AdditionalProperties["description"]?.ToString() : null
             };
         }
 

src/Resources/Resources/ActiveDirectory/Models/PSADGroup.cs

@@ -21,5 +21,7 @@ public class PSADGroup : PSADObject
         public string MailNickname { get; set; }
 
         public string ObjectType => "Group";
+
+        public string Description { get; set; }
     }
 }

src/Resources/Resources/ChangeLog.md

@@ -21,6 +21,9 @@
 
 ## Version 1.4.0
 * Add new cmdlet Get-AzureRmDenyAssignment for retrieving deny assignments
+* Added 'Description' parameter when working with Azure AD Groups:
+    - Added a parameter to New-AzAdGroup
+    - Added as output on Get-AzAdGroup
 
 ## Version 1.3.1
 * Fix documentation for wildcards

src/Resources/Resources/help/New-AzADGroup.md

@@ -13,7 +13,7 @@ Creates a new active directory group.
 ## SYNTAX
 
 ```
-New-AzADGroup -DisplayName <String> -MailNickname <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
+New-AzADGroup -DisplayName <String> -MailNickname <String> [-Description <string>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
  [-Confirm] [<CommonParameters>]
 ```
 
@@ -47,6 +47,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -Description
+The description for the group.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -DisplayName
 The display name for the group.