Skip to content

Commit 4d40c67

Browse files
authored
Merge pull request #11678 from YanyuZhongZyy/patch-11
Update Update-VivaModuleFeaturePolicy.md for VFAM feature category preview release
2 parents 029c931 + 5840570 commit 4d40c67

File tree

1 file changed

+64
-14
lines changed

1 file changed

+64
-14
lines changed

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

Lines changed: 64 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,13 @@ 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 Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module. 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.
19+
20+
Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module or a category in Viva.
1921

2022
- 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.
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.
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+
- You can only update user controls at the feature policy level, not the category policy level.
2225

2326
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.
2427

@@ -28,12 +31,13 @@ For information about the parameter sets in the Syntax section below, see [Excha
2831

2932
### FeaturePolicy
3033
```
31-
Update-VivaModuleFeaturePolicy -ModuleId <String> -FeatureId <String> -PolicyId <String> [-IsFeatureEnabled <Boolean>] [-IsUserControlEnabled <Boolean>]
34+
Update-VivaModuleFeaturePolicy -FeatureId <String> -ModuleId <String> -PolicyId <String>
3235
[-Confirm]
3336
[-Everyone <Boolean>]
37+
[-IsFeatureEnabled <Boolean>]
38+
[-IsUserControlEnabled <Boolean>]
3439
[-GroupIds <String[]>]
3540
[-Name <String>]
36-
[-ProgressAction <ActionPreference>]
3741
[-ResultSize <Unlimited>]
3842
[-UserIds <String[]>]
3943
[-WhatIf]
@@ -42,37 +46,40 @@ Update-VivaModuleFeaturePolicy -ModuleId <String> -FeatureId <String> -PolicyId
4246

4347
### CategoryPolicy
4448
```
45-
Update-VivaModuleFeaturePolicy> -CategoryId <String> [-IsCategoryEnabled <Boolean>] -PolicyId <String>
49+
Update-VivaModuleFeaturePolicy> -CategoryId <String> -PolicyId <String>
4650
[-Confirm]
4751
[-Everyone <Boolean]
52+
[-IsCategoryEnabled <Boolean>]
4853
[-GroupIds <String[]>]
4954
[-Name <String>]
50-
[-ProgressAction <ActionPreference>]
5155
[-ResultSize <Unlimited>]
5256
[-UserIds <String[]>]
5357
[-WhatIf]
5458
[<CommonParameters>]
5559
```
5660

5761
## DESCRIPTION
58-
Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module.
62+
Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module or a category in Viva.
63+
64+
Support for categories is available in version 3.5.0-Preview1 or later of the module.
5965

6066
This cmdlet updates the attributes of the policy that you specify. These attributes include:
6167

6268
- The policy name (Name parameter).
63-
- Whether or not the policy enables the feature (IsFeatureEnabled parameter).
64-
- Whether or not the policy enables user controls (IsUserControlEnabled parameter).
69+
- Whether or not the policy enables the feature (IsFeatureEnabled parameter) or the category (IsCategoryEnabled parameter).
70+
- Whether or not the policy enables user controls (IsUserControlEnabled parameter, only applicable to a feature policy).
6571
- Who the policy applies to (the UserIds and GroupIds parameters or the Everyone parameter).
6672

67-
You can update these attributes independently of each other. For example, if you specify the Name parameter but not the IsFeatureEnabled parameter, the name of the policy is updated but whether or not the policy enables the feature remains unchanged.
73+
You can update these attributes independently of each other. For example, if you specify the Name parameter but not the IsFeatureEnabled/IsCategoryEnabled parameter, the name of the policy is updated but whether or not the policy enables the feature/category remains unchanged.
6874

6975
**Important**: Values that you specify for the UserIds and/or GroupIds parameters or the Everyone parameter **overwrite** any existing users or groups. To preserve the existing users and groups, you need to specify those existing users or groups **and** any additional users or groups that you want to add. Not including existing users or groups in the command effectively removes those specific users or groups from the policy. For more information, see the examples.
7076

7177
You need to use the Connect-ExchangeOnline cmdlet to authenticate.
7278

7379
This cmdlet requires the .NET Framework 4.7.2 or later.
7480

75-
Currently, you need to be a member of the Global administrators role to run this cmdlet.
81+
Currently, you need to be a member of the Global administrators role or the roles that have been assigned at the feature level to run this cmdlet.
82+
To learn more about assigned 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).
7683

7784
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).
7885

@@ -106,10 +113,44 @@ Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Pol
106113

107114
This example updates the name of the specified policy, makes it so the policy enables the feature, and updates who the policy applies to. The policy now applies **only** to the specified users and groups, overwriting the users and groups the policy used to apply to.
108115

116+
### Example 5
117+
```powershell
118+
Update-VivaModuleFeaturePolicy -CategoryId <category_id> -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsCategoryEnabled $false
119+
```
120+
121+
This example updates the name of the specified policy and makes it so the policy does not enable the category (effectively all features under the category).
122+
123+
### Example 6
124+
```powershell
125+
Update-VivaModuleFeaturePolicy -CategoryId <category_id> -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -GroupIds [email protected],[email protected]
126+
```
127+
128+
This example updates who the specified policy applies to. The policy now applies **only** to the specified groups, overwriting the users and groups the policy used to apply to.
129+
130+
### Example 7
131+
```powershell
132+
Update-VivaModuleFeaturePolicy -CategoryId <category_id> -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -UserIds [email protected],[email protected]
133+
```
134+
135+
This example updates who the specified policy applies to. The policy now applies **only** to the specified users, overwriting the users and groups the policy used to apply to.
136+
137+
### Example 8
138+
```powershell
139+
Update-VivaModuleFeaturePolicy -CategoryId <category_id> -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsCategoryEnabled $true -GroupIds [email protected] -UserIds [email protected]
140+
```
141+
142+
This example updates the name of the specified policy, makes it so the policy enables the category (effectively all features under the category), and updates who the policy applies to. The policy now applies **only** to the specified users and groups, overwriting the users and groups the policy used to apply to.
143+
109144
## PARAMETERS
110145

111146
### -CategoryId
112-
{{ Fill CategoryId Description }}
147+
This parameter is available in version 3.5.0-Preview1 or later of the module.
148+
149+
**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available.
150+
151+
The CategoryId parameter specifies the category of the policy that you want to update.
152+
153+
To view details about the categories that support feature access controls, use the Get-FeatureCategory cmdlet. The CategoryId value is returned in the output of the cmdlet.
113154

114155
```yaml
115156
Type: String
@@ -243,7 +284,16 @@ Accept wildcard characters: False
243284
```
244285

245286
### -IsCategoryEnabled
246-
{{ Fill IsCategoryEnabled Description }}
287+
This parameter is available in version 3.5.0-Preview1 or later of the module.
288+
289+
**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available.
290+
291+
The IsCategoryEnabled parameter specifies whether the category is enabled by the updated policy. Valid values are:
292+
293+
- $true: The category (effectively all features under the category) is enabled by the policy.
294+
- $false: The category (effectively all features under the category) is not enabled by the policy.
295+
296+
If you don't want to update whether the category is enabled by the policy, don't use this parameter.
247297

248298
```yaml
249299
Type: Boolean
@@ -282,7 +332,7 @@ Accept wildcard characters: False
282332
### -IsUserControlEnabled
283333
**Note**: This parameter is available in version 3.3.0 or later of the module.
284334

285-
The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are:
335+
The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are:
286336

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

0 commit comments

Comments
 (0)