Export (0) Print
Expand All

Remove-AddressList

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-05

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

Use the Remove-AddressList cmdlet to remove an existing address list.

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

Remove-AddressList -Identity <AddressListIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Recursive <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

This example removes the address list Address_List_1 and all of its child address lists.

Remove-AddressList -Identity "Address_List_1" -Recursive

The Remove-AddressList cmdlet can be used in conjunction with the Get-AddressList cmdlet as follows:

  • Use the Get-AddressList cmdlet to get address list information, and then pipe the output to the Format-List cmdlet to get the GUID, distinguished name (DN), or path and name of an existing address list.

  • Use the Get-AddressList cmdlet to get a specific existing address list, and then pipe the output directly to the Remove-AddressList cmdlet.

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

Identity

Required

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 by using the format Path\AddressListName.

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

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

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.

Recursive

Optional

System.Management.Automation.SwitchParameter

The Recursive switch specifies whether the command removes all child address lists of the address list specified by the Identity parameter. If you don't specify this parameter and the address list to remove has child address lists, the command fails.

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.

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