Commands › Exchange Online

Set-OfflineAddressBook

Exchange Online ExchangeOnlineManagement Set-*

Modify offline address book (OAB) settings. 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

# Set-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)
Set-OfflineAddressBook -Identity <OfflineAddressBookIdParameter> -WhatIf
Set-OfflineAddressBook -Identity <OfflineAddressBookIdParameter>

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

Syntax

Set-OfflineAddressBook [-Identity] <OfflineAddressBookIdParameter>
 [-AddressLists <AddressBookBaseIdParameter[]>]
 [-ApplyMandatoryProperties]
 [-ConfiguredAttributes <MultiValuedProperty>]
 [-Confirm]
 [-DiffRetentionPeriod <Unlimited>]
 [-DomainController <Fqdn>]
 [-FullOabDownloadPreventionThreshold <Int32>]
 [-GeneratingMailbox <MailboxIdParameter>]
 [-GlobalWebDistributionEnabled <Boolean>]
 [-IsDefault <Boolean>]
 [-MaxBinaryPropertySize <Int32>]
 [-MaxMultivaluedBinaryPropertySize <Int32>]
 [-MaxMultivaluedStringPropertySize <Int32>]
 [-MaxStringPropertySize <Int32>]
 [-Name <String>]
 [-PublicFolderDistributionEnabled <Boolean>]
 [-Schedule <Schedule>]
 [-ShadowMailboxDistributionEnabled <Boolean>]
 [-UpgradeFromE14]
 [-UseDefaultAttributes]
 [-Versions <MultiValuedProperty>]
 [-VirtualDirectories <VirtualDirectoryIdParameter[]>]
 [-WhatIf]
 [-ZipOabFilesBeforeUploading <Boolean>]
 [<CommonParameters>]

Parameters (25)

Parameter	Type	Required	What it controls
-Identity	OfflineAddressBookIdParameter	yes	The Identity parameter specifies the OAB that you want to modify. You can use any value that uniquely identifies the OAB. For example:
-AddressLists	AddressBookBaseIdParameter[]		The AddressLists parameter specifies the address lists or global address lists that are included in the OAB. You can use any value that uniquely identifies the address list. For example:
-ApplyMandatoryProperties	SwitchParameter		The ApplyMandatoryProperties switch specifies whether to update the mandatory properties of a legacy OAB. You don't need to specify a value with this switch.
-ConfiguredAttributes	MultiValuedProperty		The ConfiguredAttributes parameter specifies the recipient MAPI properties that are available in the OAB. This parameter uses the syntax: `"Name1,Type1","Name2,Type2",..."NameN,TypeN"` where Name is the name of the...
-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.
-DiffRetentionPeriod	Unlimited		The DiffRetentionPeriod parameter specifies the number of days that the OAB difference files are stored on the server. Valid values are integers from 7 to 1825, or the value unlimited. The default value is 30.
-DomainController	Fqdn		This parameter is available only in on-premises Exchange.
-FullOabDownloadPreventionThreshold	Int32		This parameter is reserved for internal Microsoft use.
-GeneratingMailbox	MailboxIdParameter		This parameter is available only in on-premises Exchange.
-GlobalWebDistributionEnabled	Boolean		This parameter is available only in on-premises Exchange.
-IsDefault	Boolean		The IsDefault parameter specifies whether the OAB is used by all mailboxes and mailbox databases that don't have an OAB specified. Valid values are:
-MaxBinaryPropertySize	Int32		This parameter is available only in on-premises Exchange.
-MaxMultivaluedBinaryPropertySize	Int32		This parameter is available only in on-premises Exchange.
-MaxMultivaluedStringPropertySize	Int32		This parameter is available only in on-premises Exchange.
-MaxStringPropertySize	Int32		This parameter is available only in on-premises Exchange.
-Name	String		The Name parameter specifies the unique name of the OAB. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks.
-PublicFolderDistributionEnabled	Boolean		The PublicFolderDistributionEnabled parameter specifies whether the OAB is to be distributed via public folders. Setting the PublicFolderDistributionEnabled parameter to a value of $true sets the OAB to be...
-Schedule	Schedule		This parameter is functional only in Exchange 2010.
-ShadowMailboxDistributionEnabled	Boolean		This parameter is available only in on-premises Exchange.
-UpgradeFromE14	SwitchParameter		This parameter is reserved for internal Microsoft use.
-UseDefaultAttributes	SwitchParameter		The UseDefaultAttributes switch specifies whether to revert the recipient MAPI properties that are available in the OAB to the default list. You don't need to specify a value with this switch.
-Versions	MultiValuedProperty		The Versions parameter specifies the OAB versions that are generated for client download. Valid values are:
-VirtualDirectories	VirtualDirectoryIdParameter[]		This parameter is available only in on-premises Exchange.
-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.
-ZipOabFilesBeforeUploading	Boolean		The ZipOabFilesBeforeUploading specifies whether to use ZIP file compression on the OAB files before uploading them to the server. Valid values are:

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