[This topic is in progress.]

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2011-12-06

Use the New-AddressBookPolicy cmdlet to create an address book policy. Address book policies allow you to define the global address list (GAL), offline address book (OAB), room list, and address lists that will be displayed to mailbox users who are assigned the policy.

Syntax

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

Detailed Description

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the “Address book policies" entry in the Mailbox Permissions topic.

Parameters

Parameter Required Type Description

Name

Required

System.String

The Name parameter specifies the name of the address book policy.

AddressLists

Required

Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter[]

The AddressLists parameter specifies the address lists that will be used by mailbox users who are assigned this address book policy. This parameter accepts multiple values, which should be separated by a comma. For example, "\Mrs. Munger's Class","Mr. McKay's Class","Mrs. Crabapple's Class".

GlobalAddressList

Required

Microsoft.Exchange.Configuration.Tasks.GlobalAddressListIdParameter

The GlobalAddressList parameter specifies the identity of the GAL that will be used by mailbox users who are assigned this address book policy. You can specify only one GAL for each address book policy.

OfflineAddressBook

Required

Microsoft.Exchange.Configuration.Tasks.OfflineAddressBookIdParameter

The OfflineAddressBook parameter specifies the identity of the OAB that will be used by mailbox users who are assigned this address book policy. You can specify only one OAB for each address book policy.

RoomList

Required

Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter

The RoomList parameter specifies the room address list that will be used by mailbox users who are assigned this address book policy. You can specify only one room list for each address book policy.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch can be used to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support.

The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

Errors

Error Description

 

Examples

EXAMPLE 1

This example creates an address book policy with the following settings:

  • Name: All Fabrikam ABP

  • Included address lists: All Fabrikam, All Fabrikam Mailboxes, All Fabrikam DLs, All Fabrikam Contacts

  • Included room list: All Fabrikam-Rooms

  • Included OAB: Fabrikam-All-OAB

  • Included GAL: All Fabrikam

Copy Code
New-AddressBookPolicy -Name "All Fabrikam ABP" -AddressLists "\All Fabrikam","\All Fabrikam Mailboxes","\All Fabrikam DLs", "\All Fabrikam Contacts" -RoomList "\All Fabrikam-Rooms" -OfflineAddressBook "\Fabrikam-All-OAB" -GlobalAddressList "\All Fabrikam"