Export (0) Print
Expand All

Get-AddressBookPolicy

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-12

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-AddressBookPolicy cmdlet to return address book policies that match the specified conditions.

Get-AddressBookPolicy [-Identity <MailboxPolicyIdParameter>] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>]

This example returns detailed information about all address book policies in your organization by pipelining the Format-List cmdlet.

Get-AddressBookPolicy | Format-List

This example returns default information about the address book policy All Fabrikam

Get-AddressBookPolicy -Identity "All Fabrikam"

This example returns information about all address book policies for which the offline address book (OAB) that the address book policy uses is named Fabrikam All OAB.

Get-AddressBookPolicy | where {$_.OfflineAddressBook eq "\Fabrikam All OAB"} 

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 Email address and address book permissions topic.

By default in Exchange Online, the Address List role isn’t assigned to any role groups. To use any cmdlets that require the Address List role, you need to add the role to a role group. For details, see the “Add a role to a role assignment policy” section of Manage role assignment policies.

 

Parameter Required Type Description

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The Identity parameter specifies the identity of the address book policy.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft