Get-VivaInsightsSettings

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.

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

Use the Get-VivaInsightsSettings cmdlet to check whether a user has access to features in Microsoft Viva Insights in Microsoft Teams. Only users with provisioned Exchange Online mailboxes can access features within the Viva Insights app in Teams.

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

Syntax

Get-VivaInsightsSettings
   -Identity <String>
   [-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 Microsoft Entra ID, see Role template IDs.

Examples

Example 1

Get-VivaInsightsSettings -Identity roy@contoso.onmicrosoft.com

UserId : roy@contoso.onmicrosoft.com
IsInsightsHeadspaceEnabled : True

This example shows the configuration of Microsoft Viva Insights in Microsoft Teams for the user roy@contoso.onmicrosoft.com. The output of the command shows that the features of Headspace are available to Roy.

Parameters

-Feature

The Feature parameter filters the results by the specified Microsoft Viva Insights feature. Valid values are:

Headspace: Represents all features of Headspace.
MeetingEffectivenessSurvey: This value is available only in version 2.0.6-Preview2 of the module as part of a Private Preview.

Type:	String
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 that you want to view. You identify the user by their User Principal Name (UPN) (for example, roy@contoso.onmicrosoft.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