Export (0) Print
Expand All
Expand Minimize

New-EOPDistributionGroup

Exchange 2013
 

Applies to: Exchange Online Protection

Topic Last Modified: 2014-06-23

This cmdlet is available only in Exchange Online Protection.

Use the New-EOPDistributionGroup cmdlet to create distribution groups or mail-enabled security groups in Microsoft Exchange Online Protection.

NoteNote:
Typically, Exchange Online Protection (EOP) 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.

New-EOPDistributionGroup -Name <String> [-Alias <String>] [-DisplayName <String>] [-ManagedBy <String[]>] [-Members <String[]>] [-Notes <String>] [-Organization <OrganizationIdParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-Type <Distribution | Security>]

This example creates a mail-enabled universal security group named Managers that's managed by Kitty Petersen.

New-EOPDistributionGroup -Name Managers -Type Security -ManagedBy "Kitty Petersen"

This example creates a distribution group named "Security Team" and adds two users to the group.

New-EOPDistributionGroup -Name "Security Team" -ManagedBy "Tyson Fawcett" -Alias SecurityTeamThree -DisplayName "Security Team" -Notes "Security leads from each division" -PrimarySmtpAddress SecTeamThree@contoso.com -Type Distribution -Members @("Tyson Fawcett","Kitty Petersen")

You can use the New-EOPDistributionGroup cmdlet to create the following types of groups:

  • Mail-enabled universal security group (USG)

  • Universal distribution group

Distribution groups are used to consolidate groups of recipients into a single point of contact for email messages. Security groups are used to grant permissions to multiple users.

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

ManagedBy

Required

System.String[]

The ManagedBy parameter specifies one or more group owners. A group must have at least one owner.

This parameter accepts the following values:

  • Alias

    Example: JPhillips

  • Canonical DN

    Example: Atlanta.Corp.Contoso.Com/Users/JPhillips

  • Display Name

    Example: Jeff Phillips

  • Distinguished Name (DN)

    Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com

  • Domain\Account

    Example: Atlanta\JPhillips

  • GUID

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

  • Immutable ID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com

  • Legacy Exchange DN

    Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips

  • SMTP Address

    Example: Jeff.Phillips@contoso.com

  • User Principal Name

    Example: JPhillips@contoso.com

You can specify multiple owners by using the following syntax: @("<user1>","<user2>"...).

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 Members parameter.

Name

Required

System.String

The Name parameter specifies the name of the distribution group object. The value specified in the Name parameter is also used for the DisplayName parameter if the DisplayName parameter isn't specified.

The Name parameter value can't exceed 64 characters.

Alias

Optional

System.String

The Alias parameter specifies the email alias of the distribution group. The Alias parameter value is used to generate the primary SMTP email address if you don't use the PrimarySmtpAddress parameter.

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, but they will be mapped to a best-fit US-ASCII text character if the Alias value is used to generate the email address.

DisplayName

Optional

System.String

The DisplayName parameter specifies the name of the distribution group in the Exchange admin center (EAC). If the DisplayName parameter isn't specified, the value of the Name parameter is used for the DisplayName parameter.

Members

Optional

System.String[]

The Members parameter specifies the initial list of recipients (mail-enabled objects) in the distribution 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"

You can specify multiple recipients by using the following syntax: @("<recipient1>","<recipient2>"...).

Notes

Optional

System.String

The Notes parameter specifies additional information about the distribution group.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

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

Type

Optional

Microsoft.Exchange.Management.RecipientTasks.GroupType

The Type parameter specifies the group type. Valid values are Distribution or Security.

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