ערוך

Share via

Get-VivaModuleFeaturePolicy

  • Reference
Module:
ExchangePowerShell
Applies to:
Exchange Online

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.

Note: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available.

Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module or category in Viva. Policies are used to restrict or grant access to the specified feature or category for specific users, groups, or the entire tenant. This cmdlet provides details about the policies, including the policy's identifier, name, and creation date.

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

Syntax

Get-VivaModuleFeaturePolicy
   -FeatureId <String>
   -ModuleId <String>
   [[-PolicyId] <String>]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]
Get-VivaModuleFeaturePolicy
   -CategoryId <String>
   [[-PolicyId] <String>]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]

Description

Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module or a category in Viva.

Support for categories is available in version 3.5.0-Preview2 or later of the module.

You can view all policies for a specified feature in a Viva module or a category in Viva. To view a specific policy, you can include the PolicyId parameter.

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 or the roles that have been assigned at the feature level to run this cmdlet.

To learn more about assigned roles at the feature level, see Features Available for Feature Access Management.

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

Examples

Example 1

Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection

This example returns details about all the policies added for the Reflection feature in Viva Insights.

Example 2

Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b

This example returns details about a specific policy added for the Reflection feature in Viva Insights.

Example 3

Get-VivaModuleFeaturePolicy -CategoryId <category_id>

This example returns details about all the policies added for the <category_id> category in Viva.

Example 4

Get-VivaModuleFeaturePolicy -CategoryId <category_id> -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b

This example returns details about a specific policy added for the <category_id> category in Viva.

Parameters

-CategoryId

This parameter is available in version 3.5.0-Preview2 or later of the module.

Note: Currently, no categories are available in Viva. We'll update the documentation when categories are available.

The CategoryId parameter specifies the category that you want to view the policies for.

To view details about the categories in Viva that support feature access controls, refer to the Get-VivaFeatureCategory cmdlet. The details provided by the Get-VivaFeatureCategory cmdlet include the category identifier.

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

-FeatureId

The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for.

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

-ModuleId

The ModuleId parameter specifies the Viva module of the feature policies that you want to view.

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

-PolicyId

The PolicyId parameter specifies the specific policy for the feature in the Viva module or the category that you want to view.

To view details about all policies for a feature in a Viva module or a category, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module or a category.

Type:String
Position:Positional
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:Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online