Don't assume UserName is SamAccountName

Fix New-ADUser to use '-Name' instead of '-SamAccountName' for specifying the user account name. Change parameter descriptions to clarify that UserName can be more than just SamAccountName.
dsccommunity · May 17, 2021 · cb91a2a · cb91a2a
1 parent a385d84
commit cb91a2a
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/source/DSCResources/MSFT_ADUser/MSFT_ADUser.psm1 b/source/DSCResources/MSFT_ADUser/MSFT_ADUser.psm1
@@ -27,7 +27,8 @@ $adPropertyMap = (Import-PowerShellDataFile -Path $adPropertyMapPath).Parameters
         Name of the domain where the user account is located (only used if password is managed).
 
     .PARAMETER UserName
-        Specifies the Security Account Manager (SAM) account name of the user (ldapDisplayName 'sAMAccountName').
+        Specifies the account name of the user. (You can identify a user by its distinguished
+    name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name.)
 
     .PARAMETER DomainController
         Specifies the Active Directory Domain Services instance to use to perform the task.
@@ -185,7 +186,8 @@ function Get-TargetResource
         Name of the domain where the user account is located (only used if password is managed).
 
     .PARAMETER UserName
-        Specifies the Security Account Manager (SAM) account name of the user (ldapDisplayName 'sAMAccountName').
+        Specifies the account name of the user. (You can identify a user by its distinguished
+    name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name.)
 
     .PARAMETER Password
         Specifies a new password value for the account.
@@ -869,7 +871,8 @@ function Test-TargetResource
         Name of the domain where the user account is located (only used if password is managed).
 
     .PARAMETER UserName
-        Specifies the Security Account Manager (SAM) account name of the user (ldapDisplayName 'sAMAccountName').
+        Specifies the account name of the user. (You can identify a user by its distinguished
+    name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name.)
 
     .PARAMETER Password
         Specifies a new password value for the account.
@@ -1506,7 +1509,7 @@ function Set-TargetResource
 
                 Write-Debug -Message ('New-ADUser Parameters:' + ($newADUserParams | Out-String))
 
-                $newADUser = New-ADUser @newADUserParams -SamAccountName $UserName -Passthru
+                $newADUser = New-ADUser @newADUserParams -Name $UserName -Passthru
 
                 if ($updateCnRequired)
                 {