You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md
+36-101
Original file line number
Diff line number
Diff line change
@@ -15,51 +15,32 @@ ms.reviewer:
15
15
## SYNOPSIS
16
16
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).
17
17
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.
19
19
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.
26
22
- 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.
27
23
28
24
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.
29
25
30
26
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
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.
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.
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.
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.
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.
93
+
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).
141
94
142
95
## PARAMETERS
143
96
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
-
164
97
### -FeatureId
165
98
The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for.
166
99
167
100
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.
168
101
169
102
```yaml
170
103
Type: String
171
-
Parameter Sets: FeaturePolicy
172
-
Aliases:
173
-
Applicable: Exchange Online
174
-
175
-
Required: True
176
-
Position: Named
177
-
Default value: None
178
-
Accept pipeline input: False
179
-
Accept wildcard characters: False
180
-
```
181
-
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
104
+
Parameter Sets: (All)
195
105
Aliases:
196
106
Applicable: Exchange Online
197
107
@@ -210,7 +120,7 @@ The IsFeatureEnabled parameter specifies whether or not the feature is enabled b
210
120
211
121
```yaml
212
122
Type: Boolean
213
-
Parameter Sets: FeaturePolicy
123
+
Parameter Sets: (All)
214
124
Aliases:
215
125
Applicable: Exchange Online
216
126
@@ -226,7 +136,7 @@ The ModuleId parameter specifies the Viva module that you want to add the featur
226
136
227
137
```yaml
228
138
Type: String
229
-
Parameter Sets: FeaturePolicy
139
+
Parameter Sets: (All)
230
140
Aliases:
231
141
Applicable: Exchange Online
232
142
@@ -328,7 +238,32 @@ Only features that allow admins to enable and disable user controls by policy ca
328
238
329
239
```yaml
330
240
Type: Boolean
331
-
Parameter Sets: FeaturePolicy
241
+
Parameter Sets: (All)
242
+
Aliases:
243
+
Applicable: Exchange Online
244
+
245
+
Required: False
246
+
Position: Named
247
+
Default value: None
248
+
Accept pipeline input: False
249
+
Accept wildcard characters: False
250
+
```
251
+
252
+
### -IsUserOptedInByDefault
253
+
This parameter is available in version 3.8.0-Preview2 or later of the module.
254
+
255
+
The IsUserOptedInByDefault parameter specifies whether users are opted in by default by the policy. Valid values are:
256
+
257
+
- $true: By default, users are opted in by the policy if the user hasn't set a preference.
258
+
- $false: By default, users are opted out by the policy if the user hasn't set a preference.
259
+
260
+
This parameter is optional and can be used to override the default user opt-in value set in the feature metadata.
261
+
262
+
This parameter can be set only when the IsUserControlEnabled parameter is set to $true.
0 commit comments