Update-VivaModuleFeaturePolicy

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 of the policy that you want to update.

To view details about the categories that support feature access controls, use the Get-FeatureCategory cmdlet. The CategoryId value is returned in the output of the cmdlet.

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

• Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.
• Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

The Everyone parameter specifies that the updated policy applies to all users in the organization. Valid values are:

• $true: The policy applies to all users. This is the only useful value for this parameter.
• $false: Don't use this value.

If you don't want to update who the policy applies to, don't use this parameter.

Don't use this parameter with the GroupIds or UserIds parameters.

The FeatureId parameter specifies the feature in the Viva module of the policy that you want to update.

To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet.

The GroupIds parameter specifies the email addresses or security group object IDs (GUIDs) of groups that the updated policy applies to. Both Mail-enabled and non-mail-enabled Microsoft Entra groups are supported. You can enter multiple values separated by commas.

If you don't want to update who the policy applies to, don't use this parameter.

The values that you specify for this parameter or the UserIds parameter replace any existing groups. To preserve the existing groups, include them along with any new users or groups that you specify.

You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.).

To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true.

Note: In v3.5.1-Preview2 or later of the module, this parameter supports security group object IDs (GUIDs). Previous versions of the module accept only email addresses for this parameter.

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 IsCategoryEnabled parameter specifies whether the category is enabled by the updated policy. Valid values are:

• $true: The category (effectively all features under the category) is enabled by the policy.
• $false: The category (effectively all features under the category) is not enabled by the policy.

If you don't want to update whether the category is enabled by the policy, don't use this parameter.

The IsFeatureEnabled parameter specifies whether the feature is enabled by the updated policy. Valid values are:

• $true: The feature is enabled by the policy.
• $false: The feature is not enabled by the policy.

If you don't want to update whether the feature is enabled by the policy, don't use this parameter.

Note: This parameter is available in version 3.3.0 or later of the module. If the feature supports user controls for opting out, make sure you set the IsUserControlEnabled parameter when you create the policy. Otherwise, user controls for the policy use the default state for the feature.

The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are:

• $true: User control is enabled by the policy. Users can opt out of the feature.
• $false: User control isn't enabled by the policy. Users can't opt of the feature.

Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information.

If you don't want to update whether the user control is enabled by the policy, don't use this parameter.

The ModuleId parameter specifies the Viva module of the policy that you want to update.

The Name parameter specifies the updated name for the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").

Valid characters are English letters, numbers, commas, periods, and spaces.

If you don't want to update the name of the policy, don't use this parameter.

The PolicyId parameter specifies the policy for the feature in the Viva module that you want to update.

To view details about the policies for a feature in a Viva module, use the Get-VivaModuleFeaturePolicy cmdlet. The PolicyId value is returned in the output of the cmdlet.

This parameter is reserved for internal Microsoft use.

The UserIds parameter specifies the user principal names (UPNs) of users that the updated policy applies to. You can enter multiple values separated by commas.

If you don't want to update who the policy applies to, don't use this parameter.

The values that you specify for this parameter or the GroupIds parameter replace any existing users. To preserve the existing users, include them along with any new users or groups that you specify.

You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.).

To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true.

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.