New-O365User

Azure AD: Creates a new user account

Script

#Requires -Version 5.1
#Requires -Modules AzureAD

[CmdletBinding()]
Param(
    [Parameter(Mandatory = $true)]
    [string]$UserPrincipalName,

    [Parameter(Mandatory = $true)]
    [securestring]$Password,

    [Parameter(Mandatory = $true)]
    [string]$DisplayName,

    [Parameter(Mandatory = $true)]
    [bool]$Enabled,

    [string]$FirstName,
    [string]$LastName,
    [string]$PostalCode,
    [string]$City,
    [string]$Street,
    [string]$PhoneNumber,
    [string]$MobilePhone,
    [string]$Department,
    [bool]$ForceChangePasswordNextLogin,
    [bool]$ShowInAddressList,

    [ValidateSet('Member', 'Guest')]
    [string]$UserType = 'Member'
)

Process {
    try {
        $PasswordProfile = New-Object -TypeName Microsoft.Open.AzureAD.Model.PasswordProfile
        $PasswordProfile.Password = $Password
        $PasswordProfile.ForceChangePasswordNextLogin = $ForceChangePasswordNextLogin

        $nick = $UserPrincipalName.Substring(0, $UserPrincipalName.IndexOf('@'))

        $user = New-AzureADUser -UserPrincipalName $UserPrincipalName -DisplayName $DisplayName -AccountEnabled $Enabled -MailNickName $nick -UserType $UserType -PasswordProfile $PasswordProfile -ShowInAddressList $ShowInAddressList -ErrorAction Stop | Select-Object *

        if ($null -eq $user) { throw "User not created" }

        if ($PSBoundParameters.ContainsKey('FirstName')) { $null = Set-AzureADUser -ObjectId $user.ObjectId -GivenName $FirstName -ErrorAction Stop }
        if ($PSBoundParameters.ContainsKey('LastName')) { $null = Set-AzureADUser -ObjectId $user.ObjectId -Surname $LastName -ErrorAction Stop }
        if ($PSBoundParameters.ContainsKey('PostalCode')) { $null = Set-AzureADUser -ObjectId $user.ObjectId -PostalCode $PostalCode -ErrorAction Stop }
        if ($PSBoundParameters.ContainsKey('City')) { $null = Set-AzureADUser -ObjectId $user.ObjectId -City $City -ErrorAction Stop }
        if ($PSBoundParameters.ContainsKey('Street')) { $null = Set-AzureADUser -ObjectId $user.ObjectId -StreetAddress $Street -ErrorAction Stop }
        if ($PSBoundParameters.ContainsKey('PhoneNumber')) { $null = Set-AzureADUser -ObjectId $user.ObjectId -TelephoneNumber $PhoneNumber -ErrorAction Stop }
        if ($PSBoundParameters.ContainsKey('MobilePhone')) { $null = Set-AzureADUser -ObjectId $user.ObjectId -Mobile $MobilePhone -ErrorAction Stop }
        if ($PSBoundParameters.ContainsKey('Department')) { $null = Set-AzureADUser -ObjectId $user.ObjectId -Department $Department -ErrorAction Stop }

        $createdUser = Get-AzureADUser -ErrorAction Stop | Where-Object { $_.UserPrincipalName -eq $UserPrincipalName } | Select-Object *

        [PSCustomObject]@{
            Timestamp         = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
            Status            = "Success"
            ObjectId          = $createdUser.ObjectId
            UserPrincipalName = $createdUser.UserPrincipalName
            DisplayName       = $createdUser.DisplayName
        }
    }
    catch { throw }
}

Customize

UserPrincipalName string

UPN for the new user

Password securestring

Password for the new user (secure string)

DisplayName string

Display name of the user

Enabled bool

Whether the account is enabled for sign-in

FirstName string

First name of the user

LastName string

Last name of the user

PostalCode string

Postal code of the user

City string

City of the user

Street string

Street address of the user

PhoneNumber string

Phone number of the user

MobilePhone string

Mobile phone number of the user

Department string

Department of the user

ForceChangePasswordNextLogin bool

Forces password change on next sign-in

ShowInAddressList bool

Show this user in the address list

UserType string

Type of user: Member or Guest