Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2013-01-11
Use the Remove-DistributionGroupMember cmdlet to remove an existing recipient from a distribution group.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Remove-DistributionGroupMember -Identity
<DistributionGroupIdParameter>
[-BypassSecurityGroupManagerCheck <SwitchParameter>]
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-Member <GeneralRecipientIdParameter>]
[-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example removes Jan Dryml from the distribution group Technical Support.
Copy Code | |
---|---|
Remove-DistributionGroupMember -Identity "Technical Support" -Member "Jan Dryml" |
Detailed Description
The Remove-DistributionGroupMember cmdlet removes an existing recipient from a distribution group or a mail-enabled security group. You can't use the Remove-DistributionGroupMember cmdlet to remove a recipient from a dynamic distribution group. A dynamic distribution group queries Active Directory mail-enabled objects and builds the group's membership based on the results. The group's membership is recalculated whenever an email message is sent to the group.
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 "Distribution groups" entry in the Recipients Permissions topic.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.DistributionGroupIdParameter |
The Identity parameter specifies the distribution group that you want to modify. This parameter accepts the following values:
|
BypassSecurityGroupManagerCheck |
Optional |
System.Management.Automation.SwitchParameter |
The BypassSecurityGroupManagerCheck parameter specifies whether to bypass security checks and moderation for the member being added, if the specified distribution group is a moderated distribution group. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch can be used to suppress the
confirmation prompt that appears by default when this cmdlet is
run. To suppress the confirmation prompt, use the syntax
|
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. |
Member |
Optional |
Microsoft.Exchange.Configuration.Tasks.GeneralRecipientIdParameter |
The Member parameter specifies the recipient that you want to remove from the distribution group. This parameter accepts the following values:
|
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. |
Input Types
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.
Return Types
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.