Export (0) Print
Expand All
Expand Minimize

Update-EOPDistributionGroupMember

Exchange 2013
 

Applies to: Exchange Online Protection

Topic Last Modified: 2014-10-15

This cmdlet is available only in Exchange Online Protection.

Use the Update-EOPDistributionGroupMember cmdlet to add or remove members from distribution groups and mail-enabled security groups in Microsoft Exchange Online Protection (EOP) standalone. This cmdlet isn't available in Exchange Enterprise CAL with Services (EOP Premium). In EOP Premium, use the Update-DistributionGroupMember cmdlet.

NoteNote:
Typically, EOP standalone customers that also have on-premises Active Directory organizations would use directory synchronization to create users and groups in EOP. However, if you can’t use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP.
ImportantImportant:
This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible.

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

Update-EOPDistributionGroupMember [-ExternalDirectoryObjectId <String>] [-Identity <DistributionGroupIdParameter>] [-Members <String[]>] [-Organization <OrganizationIdParameter>]

This example replaces the current members of the Security Team distribution group with Kitty Petersen and Tyson Fawcett.

Update-EOPDistributionGroupMember -Identity "Security Team" -Members @("Kitty Petersen","Tyson Fawcett")

This example adds a new user named Tyson Fawcett to the distribution group named Security Team while preserving the current members of the group. The current member objects are retrieved in a collection, the collection is filtered to extract the names, the user "Tyson Fawcett" is added, and the updated name list replaces the current membership of the distribution group.

$CurrentMemberObjects = Get-DistributionGroupMember "Security Team"
$CurrentMemberNames = $CurrentMemberObjects | % {$_.name}
$CurrentMemberNames += "Tyson Fawcett"
Update-EOPDistributionGroupMember -Identity "Security Team" -members $CurrentMemberNames

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 and Security Groups" entry in the Feature permissions in EOP topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.DistributionGroupIdParameter

The Identity parameter specifies the distribution group or mail-enabled security group that you want to update.

You can use any value that uniquely identifies the distribution group object. For example:

  • Alias

    Example: Marketing

  • Canonical DN

    Example: "Atlanta.Corp.Contoso.Com/Users/Marketing Group"

  • Display name

    Example: "Marketing Group"

  • Distinguished name (DN)

    Example: "CN=Marketing Group,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com"

  • Email address

    Example: marketing@contoso.com

  • GUID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2

  • Legacy Exchange DN

    Example: "/o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=Marketing Group"

  • Name

    Example: "Marketing Group"

ExternalDirectoryObjectId

Optional

System.String

This parameter is reserved for internal Microsoft use.

Members

Optional

System.String[]

The Members parameter specifies the list of recipients (mail-enabled objects) in the distribution group or mail-enabled security group. In Exchange Online Protection, the valid recipient types are:

  • Mail users

  • Distribution groups

  • Mail-enabled security groups

You can use any value that uniquely identifies the recipient object. For example:

  • Alias

    Example: Marketing

  • Canonical DN

    Example: "Atlanta.Corp.Contoso.Com/Users/Jeff Phillips"

  • Display name

    Example: "Marketing Group"

  • Distinguished name (DN)

    Example: CN=Jeff Phillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com

  • Email address

    Example: marketing@contoso.com

  • GUID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2

  • Name

    Example: "Marketing Group"

To replace the current members of the group with the recipients that you specify, use the syntax @("<recipient1>","<recipient2>"...). To add new group members without affecting the existing members, see Example 2 in the Examples section.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

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