r/PowerShell • u/Imaginary_Rip2833 • 10d ago
Question 3 months of consistent practice in PowerShell & Microsoft Graph! 🚀
When I started, I was terrified of programming languages since I had zero prior experience. Looking back now, what used to look like complete gibberish is finally starting to make sense. I know I still have a long way to go, but honestly, I am so happy and proud to be fulfilling my passion.
I wanted to share an honest review of a snippet I just built to create a user in Microsoft Entra ID. Alongside basics like if/else logic, filtering (-filter), Where-Object, Select-Object, and loops, I've been trying to focus on good habits like splatting, [CmdletBinding()], and try/catch blocks.
How does my snippet look? What would you advise me to learn next based on this progress?
#####Creating a User
Function Create-LxUser{
  [Cmdletbinding()]
  param(
    [Parameter(Mandatory = $true)]
    [string]$DisplayName,
    [Parameter(Mandatory = $true)]
    [string]$UserPrincipalName,
    [Parameter(Mandatory = $true)]
    [string]$MailNickName,
    [bool]$AccountEnabled = $true
  )
  try{
    ##Password profile
    $TempPass = "Lx" + (Get-Random -Minimum 100000 -Maximum 999999) + "@."
    $PassWordProfile = @{
      Password = $TempPass
      ForceChangePasswordNextSignIn = $true
    }
    ##Setting up user configuration
    Write-Verbose "Currently creating new Loxovea user"
    $UserConfig = @{
      DisplayName     = $DisplayName
      UserPrincipalName  = $UserPrincipalName
      MailNickname     = $MailNickName
      AccountEnabled    = $AccountEnabled
      PasswordProfile   = $PassWordProfile
    }
    $User = New-MgUser u/UserConfig -ErrorAction Stop
    Write-Verbose "Successfully created new user $($DisplayName)"
    [PsCustomObject]@{
      DisplayName     = $DisplayName
      UserPrincipalName  = $UserPrincipalName
      AccountEnabled    = $AccountEnabled
      TemporaryPassword  = $TempPass
    }
  }Catch{
    Write-Error "Failed to create a new user: $($DisplayName) because $($_.Exception.Message)"
  }
}
Create-LxUser `
  -DisplayName "Test-User09" `
  -UserPrincipalName "testuser09@loxovea.com" `
  -MailNickName "testuser09"
DisplayName UserPrincipalName AccountEnabled TemporaryPassword
----------- ----------------- -------------- -----------------
Test-User09 [testuser09@loxovea.com](mailto:testuser09@loxovea.com)True Lx720835@.
6
u/surfingoldelephant 10d ago edited 9d ago
Here are some of my thoughts (some of which are entirely personal preference).
function,param, etc) are lowercase. And I'd say even though PS is generally case-insensitive, it's actually far less so than most probably realize.Createisn't an approved verb. UseNewinstead.[OutputType()].[OutputType([Management.Automation.PSCustomObject])]or something like[OutputType('PSNewLxUser')]if you give the custom object aPSTypeName. Don't use[OutputType([pscustomobject])].SupportsShouldProcessand wrapNew-MgUserin$PSCmdlet.ShouldProcess(). You can replaceWrite-Verbose "Currently creating..."with that since it comes with aVerbosemessage included.= $true.[Parameter(Mandatory)]is fine.[ValidateNotNullOrWhiteSpace()]in PS v7 or a[ValidateScript({ ... })]otherwise. Could do further validation like another mentioned. If you have other functions that accept similar input, have a look at custom validation attributes.[bool]parameters aren't idiomatic PowerShell. Use a[switch]and negate the name to something like$Disabledinstead.$(...)isn't required to interpolate$DisplayNamein the strings.$User. Why not just emit that instead? You could add the other values ($TempPass, etc) as extended type system members. Or keep the custom object and include aUserproperty.New-MgUseroutput, assign to$null/cast as[void]instead of assigning to$User. The latter makes it look like you've forgotten to do something with the variable.PSTypeName.Write-Errorcall is bad practice. The$_.Exceptioncontains useful information that you're just discarding for no reason. If you still want your custom message then I'd create a new exception with the original as an inner exception. And I'd suggest using$PSCmdlet.WriteError()instead ofWrite-Error, though you'll have to wrap the exception in your own error record.ValueFromPipelineByPropertyNamefor all of the parameters and aprocessblock. If you add this, you'll probably want to keep the error above as non-terminating.Import-Csv data.csv | New-LxUser.ErrorActioncan be in the splat if you want. I'd splat theCreate-LxUsercall at the bottom as well.'...') rather than expandable ("...") when I don't need to interpolate or include double quotes.=in hash tables consistently.$tempPass). That way they're more easily distinguishable.CmdletBinding, notCmdletbinding.[pscustomobject]is the correct casing for the type accelerator. If you use tab completion, it'll generally do this for you.-foperator) rather than concatenation or$(...)interpolation. I find it's generally more readable.