Edit

Set-DefaultTenantBriefingConfig

  • Reference
Module:
ExchangePowerShell
Applies to:
Exchange Online

This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see About the Exchange Online PowerShell module.

Use the Set-DefaultTenantBriefingConfig cmdlet to modify the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see Configure Briefing email.

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

Syntax

Set-DefaultTenantBriefingConfig
   -IsEnabledByDefault <String>
   [-ResultSize <Unlimited>]
   [<CommonParameters>]

Description

This cmdlet requires the .NET Framework 4.7.2 or later.

To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:

  • Global Administrator
  • Exchange Administrator
  • Insights Administrator

For more information, see Microsoft Entra built-in roles.

Examples

Example 1

Set-DefaultTenantBriefingConfig -IsEnabledByDefault Opt-in

This example sets the default Briefing email configuration for the organization to receive the Briefing email.

Parameters

-IsEnabledByDefault

The IsEnabledByDefault parameter specifies the default Briefing email configuration for the organization. Valid values are:

  • Opt-in: By default, all users in the organization are subscribed to receive the Briefing email.
  • Opt-out: By default, no users in the organization are subscribed to receive the Briefing email. This is the default value.

This setting affects the following users:

  • Existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email.
  • New users that you create.

This setting does not affect users who've already updated their user settings to opt-in or opt-out of the Briefing email.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-ResultSize

This parameter is reserved for internal Microsoft use.

Type:Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online