Edit

Get-UserBriefingConfig

  • Reference
Module:
ExchangePowerShell
Applies to:
Exchange Online

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

Use the Get-UserBriefingConfig cmdlet to get the current state of the Briefing email flag for the specified user. For more 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

Get-UserBriefingConfig
   -Identity <String>
   [-ResultSize <Unlimited>]

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

To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs.

Examples

Example 1

Get-UserBriefingConfig -Identity lila@contoso.com

This example returns the Briefing configuration for the user lila@contoso.com.

Parameters

-Identity

The Identity parameter specifies the user that you want to view (for example, lila@contoso.com).

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:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online