Set-EOPDistributionGroup

 

Applies to: Exchange Online Protection

This cmdlet is available only in Exchange Online Protection.

Use the Set-EOPDistributionGroup cmdlet to modify the settings of distribution groups or 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 Set-DistributionGroup 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.

Set-EOPDistributionGroup -Identity <DistributionGroupIdParameter> [-Alias <String>] [-DisplayName <String>] [-ExternalDirectoryObjectId <String>] [-ManagedBy <String[]>] [-PrimarySmtpAddress <SmtpAddress>]

This example changes the current SMTP address of the Security Team EOP distribution group to "NewSecTeamId@Contoso.com".

Set-EOPDistributionGroup -Identity "Security Team" -PrimarySmtpAddress NewSecTeamId@Contoso.com

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 modify. You can use any value that uniquely identifies the group.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • Email address

  • GUID

Alias

Optional

System.String

The Alias parameter specifies the alias of the distribution group.

The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', *, +, -, /, =, ?, ^, _, `, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters.

DisplayName

Optional

System.String

The DisplayName parameter specifies the name of the distribution group in the Exchange admin center (EAC).

ExternalDirectoryObjectId

Optional

System.String

This parameter is reserved for internal Microsoft use.

ManagedBy

Optional

System.String[]

The ManagedBy parameter specifies one or more group owners. A group must have at least one owner. You can use any value that uniquely identifies the owner.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

You can specify multiple owners by using the following syntax: @("<user1>","<user2>"...). The values that you specify will overwrite the current list of owners.

The users specified with the ManagedBy parameter aren't automatically members of the distribution group. If you want any of the owners to be added as members of the distribution group, you need to add them by using the Update-EOPDistributionGroupMember cmdlet.

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The PrimarySmtpAddress parameter specifies the primary return SMTP email address for the distribution group.

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: