Skip to content

Commit 6028208

Browse files
committed
updates documentation for Add-VivaModuleFeaturePolicy and Update-VivaModuleFeaturePolicy
1 parent 9ad47f2 commit 6028208

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a spec
2323
- 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.
2424
- If a category is disabled by category policies, all features under the category are disabled regardless of the policies set at the feature level.
2525
- You can only update user controls at the feature policy level, not the category policy level.
26+
- A policy can not be added if the policy scope of the feature doesn't match with who has access to the policy being added. To see allowed policy scopes for this feature, use [this commandlet](https://learn.microsoft.com/en-us/powershell/module/exchange/get-vivamodulefeature).
2627

2728
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.
2829

@@ -278,6 +279,8 @@ Accept wildcard characters: False
278279
### -Everyone
279280
The Everyone switch specifies that the policy applies to all users in the organization. You don't need to specify a value with this switch.
280281

282+
Only use this parameter if the feature has the Tenant policy scope.
283+
281284
Don't use this switch with the GroupIds or UserIds parameters.
282285

283286
```yaml
@@ -298,6 +301,8 @@ The GroupIds parameter specifies the email addresses or security group object ID
298301

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

304+
Only use this parameter if the feature has the Group policy scope.
305+
301306
To have the policy apply to all users in the organization, use the Everyone switch.
302307

303308
**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.
@@ -359,6 +364,8 @@ The UserIds parameter specifies the user principal names (UPNs) of the users tha
359364

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

367+
Only use this parameter if the feature has the User policy scope.
368+
362369
To have the policy apply to all users in the organization, use the Everyone switch.
363370

364371
```yaml

exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a f
2222
- You can't update a policy for a particular user or group to include the entire tenant if a policy for the entire tenant already exists for the feature. Only one tenant-wide policy is supported.
2323
- 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.
2424
- You can only update user controls at the feature policy level, not the category policy level.
25+
- A policy can not be updated if the policy scope of the feature doesn't match with who has access to the policy being updated. To see allowed policy scopes for this feature, use [this commandlet](https://learn.microsoft.com/en-us/powershell/module/exchange/get-vivamodulefeature).
2526

2627
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.
2728

@@ -246,6 +247,8 @@ The Everyone parameter specifies that the updated policy applies to all users in
246247
- $true: The policy applies to all users. This is the only useful value for this parameter.
247248
- $false: Don't use this value.
248249

250+
Only use this parameter if the feature has the Tenant policy scope.
251+
249252
If you don't want to update who the policy applies to, don't use this parameter.
250253

251254
Don't use this parameter with the GroupIds or UserIds parameters.
@@ -272,6 +275,8 @@ The values that you specify for this parameter or the UserIds parameter replace
272275

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

278+
Only use this parameter if the feature has the Group policy scope.
279+
275280
To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true.
276281

277282
**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.
@@ -405,6 +410,8 @@ The values that you specify for this parameter or the GroupIds parameter replace
405410

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

413+
Only use this parameter if the feature has the User policy scope.
414+
408415
To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true.
409416

410417
```yaml

0 commit comments

Comments
 (0)