Commands › Exchange Online

Remove-OfflineAddressBook

Exchange Online ExchangeOnlineManagement Remove-*

Remove (delete) offline address books (OABs). In Exchange Online, To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

Quick start script

# Remove-OfflineAddressBook — 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-OfflineAddressBook
$before | Format-List

# 3. Make the change (dry run first)
Remove-OfflineAddressBook -Identity <OfflineAddressBookIdParameter> -WhatIf
Remove-OfflineAddressBook -Identity <OfflineAddressBookIdParameter>

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

Syntax

Remove-OfflineAddressBook [-Identity] <OfflineAddressBookIdParameter>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-Force]
 [-WhatIf]
 [<CommonParameters>]

Parameters (5)

ParameterTypeRequiredWhat it controls
-Identity OfflineAddressBookIdParameter yes The Identity parameter specifies the OAB that you want to remove. You can use any value that uniquely identifies the OAB. For example:
-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 This parameter is available only in on-premises Exchange.
-Force SwitchParameter The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch.
-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.