Commands › Exchange Online

New-AddressBookPolicy

Exchange Online ExchangeOnlineManagement New-*

Create an address book policy. Address book policies define the global address list (GAL), offline address book (OAB), room list, and address lists shown to mailbox users who are assigned the policy. 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

# New-AddressBookPolicy — 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-AddressBookPolicy
$before | Format-List

# 3. Make the change (dry run first)
New-AddressBookPolicy -Name <String> -AddressLists <AddressListIdParameter[]> -GlobalAddressList <GlobalAddressListIdParameter> -WhatIf
New-AddressBookPolicy -Name <String> -AddressLists <AddressListIdParameter[]> -GlobalAddressList <GlobalAddressListIdParameter>

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

Syntax

New-AddressBookPolicy [-Name] <String> -AddressLists <AddressListIdParameter[]> -GlobalAddressList <GlobalAddressListIdParameter> -OfflineAddressBook <OfflineAddressBookIdParameter> -RoomList <AddressListIdParameter>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (8)

Parameter	Type	Required	What it controls
-Name	String	yes	The Name parameter specifies the name of the address book policy.
-AddressLists	AddressListIdParameter[]	yes	The AddressLists parameter specifies the address lists for mailbox users who are assigned this address book policy. You can use any value that uniquely identifies the address list. For example:
-GlobalAddressList	GlobalAddressListIdParameter	yes	The GlobalAddressList parameter specifies the GAL for mailbox users who are assigned this address book policy. You can use any value that uniquely identifies the GAL. For example:
-OfflineAddressBook	OfflineAddressBookIdParameter	yes	The OfflineAddressBook parameter specifies the OAB for mailbox users who are assigned this address book policy. You can use any value that uniquely identifies the OAB. For example:
-RoomList	AddressListIdParameter	yes	The RoomList parameter specifies an address list that used for location experiences for mailbox users who have this address book policy assigned to them.
-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.
-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.