Set-VivaInsightsSettings

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

Note: This cmdlet is available only in version 2.0.5-Preview2 or later of the EXO V2 module.

Use the Set-VivaInsightsSettings cmdlet to control user access to features in Viva Insights.

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

Syntax

Set-VivaInsightsSettings
   -Identity <String>
   -Enabled <Boolean>
   -Feature <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
  • Teams Administrator

To learn more about administrator role permissions in Azure Active Directory, see Role template IDs.

Examples

Example 1

Set-VivaInsightsSettings -Identity roy@contoso.onmicrosoft.com -Enabled $false -Feature headspace

This example disables access to all the Headspace features in Microsoft Viva Insights in Microsoft Teams for the specified user.

Parameters

-Enabled

The Enabled parameter enables or disables access to specific features of Microsoft Viva Insights in Microsoft Teams for the user. Valid values are:

  • $true: The specified features in Microsoft Viva Insights in Microsoft Teams are enabled for the user.
  • $false: The specified features in Microsoft Viva Insights in Microsoft Teams are disabled for the user.
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-Feature

The Feature parameter specifies feature of Microsoft Viva Insights in Microsoft Teams for the user. Current valid values are:

  • headspace: Represents all features of Headspace.
Type:String
Accepted values:headspace
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-Identity

The Identity parameter specifies the user that you want to modify. You identify the user by their account name (for example, roy@contoso.onmicrosoft.com).

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

Inputs

Outputs