Edit

Remove-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.

Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module. Once you delete a policy, the policy is permanently deleted. You cannot undo the deletion.

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

Syntax

Remove-VivaModuleFeaturePolicy
      -FeatureId <String>
      -ModuleId <String>
      -PolicyId <String>
      [-Confirm]
      [-ResultSize <Unlimited>]
      [-WhatIf]
      [<CommonParameters>]

Description

Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module.

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.

Examples

Example 1

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

This example deletes the specified policy for the Reflection feature in Viva Insights.

Parameters

-Confirm

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.
Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
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 remove the policy from.

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.

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 that you want to remove the policy from.

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 policy for the feature in the Viva module that you want to remove.

To view details about the added policies for a feature in a Viva module, refer to the Get-VivaModuleFeaturePolicy cmdlet. The details provided by the Get-VivaModuleFeaturePolicy cmdlet include the policy identifier.

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

-WhatIf

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.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online