Set-MyAnalyticsFeatureConfig

  • 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 Set-MyAnalyticsFeatureConfig cmdlet to configure the availability and features of MyAnalytics for the specified user.

Note: This cmdlet replaces the Set-UserAnalyticsConfig cmdlet.

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

Syntax

Set-MyAnalyticsFeatureConfig
   -Identity <String>
   [-Feature <String>]
   [-IsEnabled <Boolean>]
   [-PrivacyMode <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

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

Important

Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role.

Examples

Example 1

Set-MyAnalyticsFeatureConfig -Identity vikram@contoso.com -PrivacyMode opt-in

This example makes MyAnalytics and all features available to Vikram.

Example 2

Set-MyAnalyticsFeatureConfig -Identity swathy@contoso.com -PrivacyMode opt-in -Feature digest-email -IsEnabled $false

This example makes MyAnalytics available to Swathy, but disables the digest email feature.

Example 3

Set-MyAnalyticsFeatureConfig -Identity akshath@contoso.com -Feature digest-email -IsEnabled $false

This example disables the digest email feature for Akshath.

Parameters

-Feature

The Feature parameter specifies the MyAnalytics features to enable or disable for the user. Valid values are:

  • all (this is the default value)
  • add-in
  • dashboard
  • digest-email

To actually enable or disable a feature that's specified by this parameter, use the IsEnabled parameter in the same command.

Type:String
Accepted values:dashboard, add-in, digest-email, all
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Identity

The Identity parameter specifies the user you want to view. You identify the user by their email address.

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

-IsEnabled

The IsEnabled parameter specifies whether to enable or disable the feature that's specified by the Feature parameter. Valid values are:

  • $true: The specified feature is enabled.
  • $false: The specified feature is disabled.
Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-PrivacyMode

The PrivacyMode parameter specifies whether to enable or disable MyAnalytics for the specified user. Valid values are:

-opt-in: MyAnalytics is enabled for the user. Use the Feature and IsEnabled parameters to enable or disable specific MyAnalytics features. -opt-out: MyAnalytics is disabled for the user.

Type:String
Accepted values:opt-in, opt-out
Position:Named
Default value:None
Required:False
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