Skip to content

Commit 782fcba

Browse files
committed
Update Add-VivaModuleFeaturePolicy.md
Recreation of PR #11675
1 parent 9b0f0da commit 782fcba

File tree

1 file changed

+64
-13
lines changed

1 file changed

+64
-13
lines changed

exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md

Lines changed: 64 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,14 @@ ms.reviewer:
1515
## SYNOPSIS
1616
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](https://aka.ms/exov3-module).
1717

18-
Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva. The attributes of the policy are defined using the cmdlet parameters. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. Note that:
18+
**Note**: Support for categories is available in version 3.5.0-Preview1 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available.
1919

20-
- You can assign up to 10 policies per feature. An additional one policy per feature can be assigned to the entire tenant.
21-
- Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature is enabled. If a user has multiple policies assigned for a feature (directly as a user or member of a group), the most restrictive policy applies.
20+
Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature or a category in Viva. The attributes of the policy are defined using the cmdlet parameters. Policies are used to restrict or grant access to the specified feature or category for specific users, groups, or the entire tenant.
21+
22+
- You can assign up to 10 policies per feature/category. An additional one policy per feature/category can be assigned to the entire tenant.
23+
- Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature/category is enabled. If a user has multiple policies assigned for a feature/category (directly as a user or member of a group), the most restrictive policy applies.
24+
- If a category is disabled by category policies, all features under the category are disabled regardless of the policies set at the feature level.
25+
- You can only update user controls at the feature policy level, not the category policy level.
2226

2327
Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for.
2428

@@ -28,11 +32,11 @@ For information about the parameter sets in the Syntax section below, see [Excha
2832

2933
### FeaturePolicy
3034
```
31-
Add-VivaModuleFeaturePolicy -FeatureId <String> -IsFeatureEnabled <Boolean> -ModuleId <String> -Name <String> [-IsUserControlEnabled <Boolean>]
35+
Add-VivaModuleFeaturePolicy -FeatureId <String> -IsFeatureEnabled <Boolean> -ModuleId <String> -Name <String>
3236
[-Confirm]
3337
[-Everyone]
3438
[-GroupIds <String[]>]
35-
[-ProgressAction <ActionPreference>]
39+
[-IsUserControlEnabled <Boolean>]
3640
[-ResultSize <Unlimited>]
3741
[-UserIds <String[]>]
3842
[-WhatIf]
@@ -45,21 +49,24 @@ Add-VivaModuleFeaturePolicy -CategoryId <String> -IsCategoryEnabled <Boolean> -N
4549
[-Confirm]
4650
[-Everyone]
4751
[-GroupIds <String[]>]
48-
[-ProgressAction <ActionPreference>]
4952
[-ResultSize <Unlimited>]
5053
[-UserIds <String[]>]
5154
[-WhatIf]
5255
[<CommonParameters>]
5356
```
5457

5558
## DESCRIPTION
56-
Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva.
59+
Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature or category in Viva.
60+
61+
Support for categories is available in version 3.5.0-Preview1 or later of the module.
5762

5863
You need to use the Connect-ExchangeOnline cmdlet to authenticate.
5964

6065
This cmdlet requires the .NET Framework 4.7.2 or later.
6166

62-
Currently, you need to be a member of the Global administrators role to run this cmdlet.
67+
Currently, you need to be a member of the Global Administrators role or the roles that have been permissioned at the feature level to run this cmdlet.
68+
69+
To learn more about permissioned roles at the feature level, see [Features Available for Feature Access Management](https://learn.microsoft.com/viva/feature-access-management#features-available-for-feature-access-management).
6370

6471
To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids).
6572

@@ -93,12 +100,49 @@ Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name U
93100

94101
This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for the specified users and group members.
95102

103+
### Example 5
104+
```powershell
105+
Add-VivaModuleFeaturePolicy -CategoryId <category_id> -Name DisableCategoryForAll -IsCategoryEnabled $false -Everyone
106+
```
107+
108+
This example adds a policy for the `<cateogry_id>` category in Viva. The policy disables the category (effectively all features under the category) for all users in the organization.
109+
110+
### Example 6
111+
```powershell
112+
Add-VivaModuleFeaturePolicy -CategoryId <category_id> -Name MultipleGroups -IsCategoryEnabled $false -GroupIds [email protected],[email protected]
113+
```
114+
115+
This example adds a policy for the `<cateogry_id>` category in Viva. The policy disables the category (effectively all features under the category) for all users in the specified groups.
116+
117+
### Example 7
118+
```powershell
119+
Add-VivaModuleFeaturePolicy -CategoryId <category_id> -Name MultipleUsers -IsCategoryEnabled $false -UserIds [email protected],[email protected]
120+
```
121+
122+
This example adds a policy for the `<cateogry_id>` category in Viva. The policy disables the category (effectively all features under the category) for the specified users.
123+
124+
### Example 8
125+
```powershell
126+
Add-VivaModuleFeaturePolicy -CategoryId <category_id> -Name UsersAndGroups -IsCategoryEnabled $false -GroupIds [email protected],[email protected] -UserIds [email protected],[email protected]
127+
```
128+
129+
This example adds a policy for the `<cateogry_id>` category in Viva. The policy disables the category (effectively all features under the category) for the specified users and group members.
130+
131+
### Example 9
132+
```powershell
133+
Add-VivaModuleFeaturePolicy -CategoryId <category_id> -Name "Disable Category For All" -IsCategoryEnabled $false -Everyone
134+
```
135+
136+
This example adds a policy for the `<cateogry_id>` category in Viva where the policy name is with spaces. The policy disables the category (effectively all features under the category) for all users in the organization.
137+
96138
## PARAMETERS
97139

98140
### -CategoryId
99-
**Note**: This parameter is available only in the Exchange Online PowerShell module v3.5.0-Preview??? or later.
141+
This parameter is available in version 3.5.0-Preview1 or later of the module.
142+
143+
**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available.
100144

101-
{{ Fill CategoryId Description }}
145+
The CategoryId parameter specifies the Viva category that you want to add the policy for.
102146

103147
```yaml
104148
Type: String
@@ -132,7 +176,14 @@ Accept wildcard characters: False
132176
```
133177
134178
### -IsCategoryEnabled
135-
{{ Fill IsCategoryEnabled Description }}
179+
This parameter is available in version 3.5.0-Preview1 or later of the module.
180+
181+
**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available.
182+
183+
The IsCategoryEnabled parameter specifies whether or not the category is enabled by the policy. Valid values are:
184+
185+
- $true: The category is enabled by the policy.
186+
- $false: The category is not enabled by the policy.
136187
137188
```yaml
138189
Type: Boolean
@@ -260,9 +311,9 @@ Accept wildcard characters: False
260311
```
261312

262313
### -IsUserControlEnabled
263-
**Note**: This parameter is available in version 3.3.0 or later of the module.
314+
This parameter is available in version 3.3.0 or later of the module.
264315

265-
The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are:
316+
The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are:
266317

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

0 commit comments

Comments
 (0)