Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Get-AddressList

 

Applies to: Exchange Server 2013

Topic Last Modified: 2013-03-19

Use the Get-AddressList cmdlet to retrieve all attributes of an address list.

For information about the parameter sets in the Syntax section below, see Syntax.

Get-AddressList -Container <AddressListIdParameter> <COMMON PARAMETERS>
Get-AddressList [-SearchText <String>] <COMMON PARAMETERS>
Get-AddressList [-Identity <AddressListIdParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>]

This example retrieves the attributes of all the address lists under the All Address Lists container.

Get-AddressList 

This example retrieves the attributes of the address list building4, located under the All Users\Sales\ address list, using the domain controller DomainController01.

Get-AddressList -Identity "All Users\Sales\building4" -DomainController DomainController01

You can pipe the output from the Get-AddressList cmdlet to the Remove-AddressList, Set-AddressList, Update-Addresslist, and Move-AddressList cmdlets instead of using the Identity parameter with each of those cmdlets.

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 lists" 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

Container

Required

Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter

The Container parameter specifies the identity of the parent address list of the address list or lists that you want to view. If no parent address list is specified, the command gets all address lists under the root All Address Lists.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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.AddressListIdParameter

The Identity parameter specifies the GUID, distinguished name (DN), or address list name that represents a specific address list. You can also include the path using the format Path\AddressListName.

You can omit the parameter label so that only the address list name or GUID is supplied.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

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.

SearchText

Optional

System.String

The SearchText parameter specifies that you can search the names of all organizational units (OUs) in your organization for the specified string. Only the OUs that match the string you specify are returned. If the string you specify contains spaces, enclose it in quotation marks ("). This parameter can't be used with the Identity parameter.

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.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.