Commands › Exchange Online
Set-DistributionGroup
Modify the settings of existing distribution groups or mail-enabled security groups. To add or remove group members, use the Add-DistributionGroupMember, Remove-DistributionGroupMember or Update-DistributionGroupMember cmdlets.
Quick start script
# Set-DistributionGroup — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org
# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-DistributionGroup
$before | Format-List
# 3. Make the change (dry run first)
Set-DistributionGroup -Identity <DistributionGroupIdParameter> -WhatIf
Set-DistributionGroup -Identity <DistributionGroupIdParameter>
# 4. Verify and diff
$after = Get-DistributionGroup
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-DistributionGroup [-Identity] <DistributionGroupIdParameter>
[-AcceptMessagesOnlyFrom <MultiValuedProperty>]
[-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>]
[-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>]
[-Alias <String>]
[-ArbitrationMailbox <MailboxIdParameter>]
[-BccBlocked <Boolean>]
[-BypassModerationFromSendersOrMembers <MultiValuedProperty>]
[-BypassNestedModerationEnabled <Boolean>]
[-BypassSecurityGroupManagerCheck]
[-Confirm]
[-CreateDTMFMap <Boolean>]
[-CustomAttribute1 <String>]
[-CustomAttribute10 <String>]
[-CustomAttribute11 <String>]
[-CustomAttribute12 <String>]
[-CustomAttribute13 <String>]
[-CustomAttribute14 <String>]
[-CustomAttribute15 <String>]
[-CustomAttribute2 <String>]
[-CustomAttribute3 <String>]
[-CustomAttribute4 <String>]
[-CustomAttribute5 <String>]
[-CustomAttribute6 <String>]
[-CustomAttribute7 <String>]
[-CustomAttribute8 <String>]
[-CustomAttribute9 <String>]
[-Description <MultiValueProperty>]
[-DisplayName <String>]
[-DomainController <Fqdn>]
[-EmailAddresses <ProxyAddressCollection>]
[-EmailAddressPolicyEnabled <Boolean>]
[-ExpansionServer <String>]
[-ExtensionCustomAttribute1 <MultiValuedProperty>]
[-ExtensionCustomAttribute2 <MultiValuedProperty>]
[-ExtensionCustomAttribute3 <MultiValuedProperty>]
[-ExtensionCustomAttribute4 <MultiValuedProperty>]
[-ExtensionCustomAttribute5 <MultiValuedProperty>]
[-ForceUpgrade]
[-GrantSendOnBehalfTo <MultiValuedProperty>]
[-HiddenFromAddressListsEnabled <Boolean>]
[-HiddenGroupMembershipEnabled]
[-IgnoreDefaultScope]
[-IgnoreNamingPolicy]
[-MailTip <String>]
[-MailTipTranslations <MultiValuedProperty>]
[-ManagedBy <MultiValuedProperty>]
[-MaxReceiveSize <Unlimited>]
[-MaxSendSize <Unlimited>]
[-MemberDepartRestriction <MemberUpdateType>]
[-MemberJoinRestriction <MemberUpdateType>]
[-ModeratedBy <MultiValuedProperty>]
[-ModerationEnabled <Boolean>]
[-Name <String>]
[-PrimarySmtpAddress <SmtpAddress>]
[-RejectMessagesFrom <MultiValuedProperty>]
[-RejectMessagesFromDLMembers <MultiValuedProperty>]
[-RejectMessagesFromSendersOrMembers <MultiValuedProperty>]
[-ReportToManagerEnabled <Boolean>]
[-ReportToOriginatorEnabled <Boolean>]
[-RequireSenderAuthenticationEnabled <Boolean>]
[-ResetMigrationToUnifiedGroup]
[-RoomList]
[-SamAccountName <String>]
[-SendModerationNotifications <TransportModerationNotificationFlags>]
[-SendOofMessageToOriginatorEnabled <Boolean>]
[-SimpleDisplayName <String>]
[-UMDtmfMap <MultiValuedProperty>]
[-UpdateMemberCount]
[-WhatIf]
[-WindowsEmailAddress <SmtpAddress>]
[<CommonParameters>]Parameters (71)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | DistributionGroupIdParameter | yes | 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: |
| -AcceptMessagesOnlyFrom | MultiValuedProperty | The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. | |
| -AcceptMessagesOnlyFromDLMembers | MultiValuedProperty | The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. | |
| -AcceptMessagesOnlyFromSendersOrMembers | MultiValuedProperty | The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. | |
| -Alias | String | The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email... | |
| -ArbitrationMailbox | MailboxIdParameter | This parameter is available only in on-premises Exchange. | |
| -BccBlocked | Boolean | This parameter is available only in the cloud-based service. | |
| -BypassModerationFromSendersOrMembers | MultiValuedProperty | The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and... | |
| -BypassNestedModerationEnabled | Boolean | The ByPassNestedModerationEnabled parameter specifies how to handle message approval when a moderated group contains other moderated groups as members. Valid values are: | |
| -BypassSecurityGroupManagerCheck | SwitchParameter | The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. | |
| -Confirm | SwitchParameter | The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. | |
| -CreateDTMFMap | Boolean | This parameter is available only in on-premises Exchange. | |
| -CustomAttribute1 | String | This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute10 | String | This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute11 | String | This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute12 | String | This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute13 | String | This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute14 | String | This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute15 | String | This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute2 | String | This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute3 | String | This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute4 | String | This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute5 | String | This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute6 | String | This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute7 | String | This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute8 | String | This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute9 | String | This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -Description | MultiValuedProperty | This parameter is available only in the cloud-based service. | |
| -DisplayName | String | The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces,... | |
| -DomainController | Fqdn | This parameter is available only in on-premises Exchange. | |
| -EmailAddresses | ProxyAddressCollection | The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy... | |
| -EmailAddressPolicyEnabled | Boolean | This parameter is available only in on-premises Exchange. | |
| -ExpansionServer | String | This parameter is available only in on-premises Exchange. | |
| -ExtensionCustomAttribute1 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExtensionCustomAttribute2 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExtensionCustomAttribute3 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExtensionCustomAttribute4 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExtensionCustomAttribute5 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ForceUpgrade | SwitchParameter | The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. | |
| -GrantSendOnBehalfTo | MultiValuedProperty | The GrantSendOnBehalfTo parameter specifies who can send on behalf of this group. Although messages send on behalf of the group clearly show the sender in the From field (`<Sender> on behalf of <Group>`), replies to... | |
| -HiddenFromAddressListsEnabled | Boolean | The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: | |
| -HiddenGroupMembershipEnabled | SwitchParameter | This parameter is available only in the cloud-based service. | |
| -IgnoreDefaultScope | SwitchParameter | This parameter is available only in on-premises Exchange. | |
| -IgnoreNamingPolicy | SwitchParameter | The IgnoreNamingPolicy switch specifies whether to prevent this group from being affected by your organization's group naming policy. You don't need to specify a value with this switch. | |
| -MailTip | String | The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value... | |
| -MailTipTranslations | MultiValuedProperty | The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags... | |
| -ManagedBy | MultiValuedProperty | The ManagedBy parameter specifies an owner for the group. A group must have at least one owner. If you don't use this parameter to specify the owner when you create the group, the user account that created the group... | |
| -MaxReceiveSize | Unlimited | This parameter is available only in on-premises Exchange. | |
| -MaxSendSize | Unlimited | This parameter is available only in on-premises Exchange. | |
| -MemberDepartRestriction | MemberUpdateType | The MemberDepartRestriction parameter specifies the restrictions that you put on requests to leave the group. Valid values are: | |
| -MemberJoinRestriction | MemberUpdateType | The MemberJoinRestriction parameter specifies the restrictions that you put on requests to join the group. Valid values are: | |
| -ModeratedBy | MultiValuedProperty | The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail... | |
| -ModerationEnabled | Boolean | The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: | |
| -Name | String | The Name parameter specifies the unique name of the group. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). | |
| -PrimarySmtpAddress | SmtpAddress | The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. | |
| -RejectMessagesFrom | MultiValuedProperty | The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. | |
| -RejectMessagesFromDLMembers | MultiValuedProperty | The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. | |
| -RejectMessagesFromSendersOrMembers | MultiValuedProperty | The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. | |
| -ReportToManagerEnabled | Boolean | The ReportToManagerEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to the owner (first one listed if more than one) of... | |
| -ReportToOriginatorEnabled | Boolean | The ReportToOriginatorEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to senders who send messages to this group. Valid... | |
| -RequireSenderAuthenticationEnabled | Boolean | The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: | |
| -ResetMigrationToUnifiedGroup | SwitchParameter | This parameter is available only in the cloud-based service. | |
| -RoomList | SwitchParameter | The RoomList switch specifies that all members of this distribution group are room mailboxes. You don't need to specify a value with this switch. | |
| -SamAccountName | String | This parameter is available only in on-premises Exchange. | |
| -SendModerationNotifications | TransportModerationNotificationFlags | The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: | |
| -SendOofMessageToOriginatorEnabled | Boolean | The SendOofMessageToOriginatorEnabled parameter specifies how to handle out of office (OOF) messages for members of the group. Valid values are: | |
| -SimpleDisplayName | String | The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: | |
| -UMDtmfMap | MultiValuedProperty | This parameter is available only in on-premises Exchange. | |
| -UpdateMemberCount | SwitchParameter | This parameter is available only in the cloud-based service. | |
| -WhatIf | SwitchParameter | The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch. | |
| -WindowsEmailAddress | SmtpAddress | The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using... |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.