Commands › Exchange Online

Set-AddressRewriteEntry

Exchange Online ExchangeOnlineManagement Set-*

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. Use the Set-AddressRewriteEntry cmdlet to modify an existing address rewrite entry that rewrites sender and recipient email addresses in messages sent to or sent from your organization through an Edge Transport server.

Quick start script

# Set-AddressRewriteEntry — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-AddressRewriteEntry
$before | Format-List

# 3. Make the change (dry run first)
Set-AddressRewriteEntry -Identity <AddressRewriteEntryIdParameter> -WhatIf
Set-AddressRewriteEntry -Identity <AddressRewriteEntryIdParameter>

# 4. Verify and diff
$after = Get-AddressRewriteEntry
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-AddressRewriteEntry [-Identity] <AddressRewriteEntryIdParameter>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-ExceptionList <MultiValuedProperty>]
 [-ExternalAddress <String>]
 [-InternalAddress <String>]
 [-Name <String>]
 [-OutboundOnly <Boolean>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (9)

Parameter	Type	Required	What it controls
-Identity	AddressRewriteEntryIdParameter	yes	The Identity parameter specifies the address rewrite entry you want to modify. You can specify the name or GUID of the address rewrite entry.
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DomainController	Fqdn		The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name...
-ExceptionList	MultiValuedProperty		The ExceptionList parameter specifies the domain names that should be excluded from address rewriting when the InternalAddress parameter contains a value that specifies multiple domain names. You can separate...
-ExternalAddress	String		The ExternalAddress parameter specifies the final email addresses that you want. If the InternalAddress parameter specifies a single email address (chris@contoso.com), the ExternalAddress parameter must also specify...
-InternalAddress	String		The InternalAddress parameter specifies the original email addresses that you want to change. You can use the following values:
-Name	String		The Name parameter specifies a unique name for this address rewrite entry.
-OutboundOnly	Boolean		The OutboundOnly parameter enables or disables outbound-only address rewriting. Valid input for this parameter is $true or $false. The value $true means address rewriting occurs in outbound mail only. The value...
-WhatIf	SwitchParameter		The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.