Get-VivaModuleFeatureEnablement
This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module.
Use the Get-VivaModuleFeatureEnablement cmdlet to view whether or not a feature in a Viva module is enabled for a specific user or group. Whether or not the feature is enabled is referred to as the feature's "enablement state". The enablement state returned by this cmdlet is based on the access policies set by the admin.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Get-VivaModuleFeatureEnablement
-FeatureId <String>
-Identity <String>
-ModuleId <String>
[-ResultSize <Unlimited>]
[<CommonParameters>] Description
Use the Get-VivaModuleFeatureEnablement cmdlet to view whether or not a feature in a Viva module is enabled for a specific user or group.
You need to use the Connect-ExchangeOnline cmdlet to authenticate.
This cmdlet requires the .NET Framework 4.7.2 or later.
Currently, you need to be a member of the Global Administrators role to run this cmdlet.
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
Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity [email protected]This example returns the enablement state of the Reflection feature in Viva Insights for the [email protected] user.
Example 2
Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity [email protected]This example returns the enablement state of the Reflection feature in Viva Insights for the [email protected] group.
Parameters
-FeatureId
The FeatureId parameter specifies the feature in the Viva module.
To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier.
| Type: | Exchange Online |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Identity
The Identity parameter specifies the user principal name (UPN) of the user or the SMTP address (email address) of the group that you want to view the feature enablement status of.
Mail-enabled Microsoft Entra groups are supported.
| Type: | Exchange Online |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ModuleId
The ModuleId parameter specifies the Viva module.
| Type: | Exchange Online |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResultSize
This parameter is reserved for internal Microsoft use.
| Type: | Exchange Online |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |