Set-ExchangeAddressListConfig

Exchange: Modifies an existing Address List

Script

#Requires -Version 5.1

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

    [string]$DisplayName,

    [ValidateSet('None', 'AllRecipients', 'MailboxUsers', 'Resources', 'MailContacts', 'MailGroups', 'MailUsers')]
    [string[]]$IncludedRecipients,

    [switch]$ForceUpgrade
)

Process {
    try {
        $params = @{
            'Identity'    = $Identity
            'Confirm'     = $false
            'ErrorAction' = 'Stop'
        }
        if ($DisplayName) { $params.Add('DisplayName', $DisplayName) }
        if ($IncludedRecipients) { $params.Add('IncludedRecipients', $IncludedRecipients) }
        if ($ForceUpgrade.IsPresent) { $params.Add('ForceUpgrade', $true) }

        if ($params.Count -gt 3) {
            Set-AddressList @params
        }

        $addressList = Get-AddressList -Identity $Identity -ErrorAction Stop
        
        $result = [PSCustomObject]@{
            Name           = $addressList.Name
            DisplayName    = $addressList.DisplayName
            IncludedRecipients = $addressList.IncludedRecipients
            Action         = "AddressListUpdated"
            Status         = "Success"
            Timestamp      = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
        }

        Write-Output $result
    }
    catch {
        throw
    }
}

Customize

Identity string

Specifies the Identity of the address list to modify.

DisplayName string

Specifies a new display name for the address list.

IncludedRecipients string

Specifies the types of recipients to include.

ForceUpgrade switch

Off

If set, forces the upgrade of a legacy address list to the current version.