Get-AddressList

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Get-AddressList cmdlet to view address lists.

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

Get-AddressList [-Identity <AddressListIdParameter>] <COMMON PARAMETERS>

Get-AddressList -Container <AddressListIdParameter> <COMMON PARAMETERS>

Get-AddressList [-SearchText <String>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-DomainController <Fqdn>]

This example returns a summary list of all the address lists.

Get-AddressList

This example returns detailed information for the address list named building4that's located under the All Users\Sales\ address list.

Get-AddressList -Identity "All Users\Sales\building4" | Format-List

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 more information, see the "Add a role to a role group" section in the topic, Manage role groups.

 

Parameter Required Type Description

Container

Required

Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter

The Container parameter filters the results based on the location of the address list. Only address lists under the specified path are returned. Valid input for this parameter is the root "\" (also known as All Address Lists) or an existing address list. You can use any value that uniquely identifies the address list. For example:

  • Name

  • Display name

  • Distinguished name (DN)

  • GUID

  • Path   (\<Name>) or [<Container>\<Name>)

You can't use this parameter with the Identity or SearchText parameters.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter

The Identity parameter specifies the address list that you want to view. You can use any value that uniquely identifies the address list. For example:

  • Name

  • Display name

  • Distinguished name (DN)

  • GUID

  • Path   (\<Name>) or [<Container>\<Name>)

You can't use this parameter with the Container or SearchText parameters.

SearchText

Optional

System.String

The SearchText parameter filters the results based on the name and display name of the address list. Only address lists whose names or display names that contain the specified text string returned. If the value contains spaces, enclose the value in quotation marks (").

You can't use this parameter with the Container or Identity parameters.

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.

 
Show: