Skip to content

Commit 53b045d

Browse files
authored
Update Add-VivaModuleFeaturePolicy.md
Removed category-related documentation. Added a new parameter -IsUserOptedInByDefault. Added an example of using the new parameter to create a Soft Disable policy.
1 parent 5bb5db9 commit 53b045d

File tree

1 file changed

+29
-95
lines changed

1 file changed

+29
-95
lines changed

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

Lines changed: 29 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,10 @@ 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-
**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.
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.
1919

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.
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.
2622
- Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the [Get-VivaModuleFeature](https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature) cmdlet.
2723

2824
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.
@@ -44,22 +40,8 @@ Add-VivaModuleFeaturePolicy -FeatureId <String> -IsFeatureEnabled <Boolean> -Mod
4440
[<CommonParameters>]
4541
```
4642

47-
### CategoryPolicy
48-
```
49-
Add-VivaModuleFeaturePolicy -CategoryId <String> -IsCategoryEnabled <Boolean> -Name <String>
50-
[-Confirm]
51-
[-Everyone]
52-
[-GroupIds <String[]>]
53-
[-ResultSize <Unlimited>]
54-
[-UserIds <String[]>]
55-
[-WhatIf]
56-
[<CommonParameters>]
57-
```
58-
5943
## DESCRIPTION
60-
Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature or category in Viva.
61-
62-
Support for categories is available in version 3.5.0-Preview2 or later of the module.
44+
Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva.
6345

6446
You need to use the Connect-ExchangeOnline cmdlet to authenticate.
6547

@@ -106,61 +88,13 @@ This example adds a policy for the Reflection feature in Viva Insights. The poli
10688

10789
### Example 5
10890
```powershell
109-
Add-VivaModuleFeaturePolicy -CategoryId <category_id> -Name DisableCategoryForAll -IsCategoryEnabled $false -Everyone
110-
```
111-
112-
This example adds a policy for the `<category_id>` category in Viva. The policy disables the category (effectively all features under the category) for all users in the organization.
113-
114-
### Example 6
115-
```powershell
116-
Add-VivaModuleFeaturePolicy -CategoryId <category_id> -Name MultipleGroups -IsCategoryEnabled $false -GroupIds group1@contoso.com,group2@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3
117-
```
118-
119-
This example adds a policy for the `<category_id>` category in Viva. The policy disables the category (effectively all features under the category) for all users in the specified groups.
120-
121-
### Example 7
122-
```powershell
123-
Add-VivaModuleFeaturePolicy -CategoryId <category_id> -Name MultipleUsers -IsCategoryEnabled $false -UserIds user1@contoso.com,user2@contoso.com
91+
Add-VivaModuleFeaturePolicy -ModuleId PeopleSkills -FeatureId ShowAISkills -Name SoftDisableShowAISkillsPolicy -IsFeatureEnabled $true -IsUserControlEnabled $true -IsUserOptedInByDefault $false -UserIds user1@contoso.com,user2@contoso.com
12492
```
12593

126-
This example adds a policy for the `<category_id>` category in Viva. The policy disables the category (effectively all features under the category) for the specified users.
127-
128-
### Example 8
129-
```powershell
130-
Add-VivaModuleFeaturePolicy -CategoryId <category_id> -Name UsersAndGroups -IsCategoryEnabled $false -GroupIds group1@contoso.com,group2@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 -UserIds user1@contoso.com,user2@contoso.com
131-
```
132-
133-
This example adds a policy for the `<category_id>` category in Viva. The policy disables the category (effectively all features under the category) for the specified users and group members.
134-
135-
### Example 9
136-
```powershell
137-
Add-VivaModuleFeaturePolicy -CategoryId <category_id> -Name "Disable Category For All" -IsCategoryEnabled $false -Everyone
138-
```
139-
140-
This example adds a policy for the `<category_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.
94+
This example adds a policy for the ShowAISkills feature in Viva Skills. The policy enables the feature for the specified users, allows user controls, and opted out users by default (Soft Disable policy).
14195

14296
## PARAMETERS
14397

144-
### -CategoryId
145-
This parameter is available in version 3.5.0-Preview2 or later of the module.
146-
147-
**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available.
148-
149-
The CategoryId parameter specifies the Viva category that you want to add the policy for.
150-
151-
```yaml
152-
Type: String
153-
Parameter Sets: CategoryPolicy
154-
Aliases:
155-
Applicable: Exchange Online
156-
157-
Required: True
158-
Position: Named
159-
Default value: None
160-
Accept pipeline input: False
161-
Accept wildcard characters: False
162-
```
163-
16498
### -FeatureId
16599
The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for.
166100

@@ -179,29 +113,6 @@ Accept pipeline input: False
179113
Accept wildcard characters: False
180114
```
181115
182-
### -IsCategoryEnabled
183-
This parameter is available in version 3.5.0-Preview2 or later of the module.
184-
185-
**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available.
186-
187-
The IsCategoryEnabled parameter specifies whether or not the category is enabled by the policy. Valid values are:
188-
189-
- $true: The category is enabled by the policy.
190-
- $false: The category is not enabled by the policy.
191-
192-
```yaml
193-
Type: Boolean
194-
Parameter Sets: CategoryPolicy
195-
Aliases:
196-
Applicable: Exchange Online
197-
198-
Required: True
199-
Position: Named
200-
Default value: None
201-
Accept pipeline input: False
202-
Accept wildcard characters: False
203-
```
204-
205116
### -IsFeatureEnabled
206117
The IsFeatureEnabled parameter specifies whether or not the feature is enabled by the policy. Valid values are:
207118
@@ -339,6 +250,29 @@ Accept pipeline input: False
339250
Accept wildcard characters: False
340251
```
341252

253+
### -IsUserOptedInByDefault
254+
This parameter is available in version 3.8.0 or later of the module.
255+
256+
The IsUserOptedInByDefault parameter specifies whether user opted in by default by the policy. Valid values are:
257+
258+
- $true: User opted in by the policy.
259+
- $false: User opted out by the policy.
260+
261+
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.
262+
263+
```yaml
264+
Type: Boolean
265+
Parameter Sets: FeaturePolicy
266+
Aliases:
267+
Applicable: Exchange Online
268+
269+
Required: False
270+
Position: Named
271+
Default value: None
272+
Accept pipeline input: False
273+
Accept wildcard characters: False
274+
```
275+
342276
### -ResultSize
343277
This parameter is reserved for internal Microsoft use.
344278

0 commit comments

Comments
 (0)