| external help file | online version | applicable | title | schema | author | ms.author | ms.reviewer |
|---|---|---|---|---|---|---|---|
Microsoft.Exchange.RolesAndAccess-Help.xml |
Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
Get-AddressBookPolicy |
2.0.0 |
chrisda |
chrisda |
This cmdlet is available in on-premises Exchange 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.
In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. 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.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Get-AddressBookPolicy [[-Identity] <MailboxPolicyIdParameter>]
[-DomainController <Fqdn>]
[<CommonParameters>]
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.
Get-AddressBookPolicy | Format-ListThis example returns detailed information about all address book policies in your organization by pipelining the Format-List cmdlet.
Get-AddressBookPolicy -Identity "All Fabrikam"This example returns default information about the address book policy All Fabrikam
Get-AddressBookPolicy | where {$_.OfflineAddressBook -eq "\Fabrikam All OAB"}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.
The Identity parameter specifies the identity of the address book policy.
Type: MailboxPolicyIdParameter
Parameter Sets: (All)
Aliases:
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
Required: False
Position: 1
Default value: None
Accept pipeline input: True
Accept wildcard characters: FalseThis parameter is available only in on-premises Exchange.
The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
Type: Fqdn
Parameter Sets: (All)
Aliases:
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.