Skip to content

Commit 3c36782

Browse files
authored
Merge pull request MicrosoftDocs#11838 from MicrosoftDocs/VivaFeature-chrisda
VivaFeature-chrisda to Main
2 parents 58bbf92 + 3f2eac5 commit 3c36782

File tree

5 files changed

+407
-37
lines changed

5 files changed

+407
-37
lines changed

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

Lines changed: 110 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,37 +15,58 @@ 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-Preview2 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

2529
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
2630

2731
## SYNTAX
2832

33+
### FeaturePolicy
2934
```
3035
Add-VivaModuleFeaturePolicy -FeatureId <String> -IsFeatureEnabled <Boolean> -ModuleId <String> -Name <String>
3136
[-Confirm]
37+
[-Everyone]
3238
[-GroupIds <String[]>]
39+
[-IsUserControlEnabled <Boolean>]
40+
[-ResultSize <Unlimited>]
3341
[-UserIds <String[]>]
42+
[-WhatIf]
43+
[<CommonParameters>]
44+
```
45+
46+
### CategoryPolicy
47+
```
48+
Add-VivaModuleFeaturePolicy -CategoryId <String> -IsCategoryEnabled <Boolean> -Name <String>
49+
[-Confirm]
3450
[-Everyone]
35-
[-IsUserControlEnabled <Boolean>]
51+
[-GroupIds <String[]>]
3652
[-ResultSize <Unlimited>]
53+
[-UserIds <String[]>]
3754
[-WhatIf]
3855
[<CommonParameters>]
3956
```
4057

4158
## DESCRIPTION
42-
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-Preview2 or later of the module.
4362

4463
You need to use the Connect-ExchangeOnline cmdlet to authenticate.
4564

4665
This cmdlet requires the .NET Framework 4.7.2 or later.
4766

48-
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 assigned at the feature level to run this cmdlet.
68+
69+
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).
4970

5071
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).
5172

@@ -79,16 +100,94 @@ Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name U
79100

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

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+
82138
## PARAMETERS
83139

140+
### -CategoryId
141+
This parameter is available in version 3.5.0-Preview2 or later of the module.
142+
143+
**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available.
144+
145+
The CategoryId parameter specifies the Viva category that you want to add the policy for.
146+
147+
```yaml
148+
Type: String
149+
Parameter Sets: CategoryPolicy
150+
Aliases:
151+
Applicable: Exchange Online
152+
153+
Required: True
154+
Position: Named
155+
Default value: None
156+
Accept pipeline input: False
157+
Accept wildcard characters: False
158+
```
159+
84160
### -FeatureId
85161
The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for.
86162
87163
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.
88164
89165
```yaml
90166
Type: String
91-
Parameter Sets: (All)
167+
Parameter Sets: FeaturePolicy
168+
Aliases:
169+
Applicable: Exchange Online
170+
171+
Required: True
172+
Position: Named
173+
Default value: None
174+
Accept pipeline input: False
175+
Accept wildcard characters: False
176+
```
177+
178+
### -IsCategoryEnabled
179+
This parameter is available in version 3.5.0-Preview2 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.
187+
188+
```yaml
189+
Type: Boolean
190+
Parameter Sets: CategoryPolicy
92191
Aliases:
93192
Applicable: Exchange Online
94193

@@ -107,7 +206,7 @@ The IsFeatureEnabled parameter specifies whether or not the feature is enabled b
107206
108207
```yaml
109208
Type: Boolean
110-
Parameter Sets: (All)
209+
Parameter Sets: FeaturePolicy
111210
Aliases:
112211
Applicable: Exchange Online
113212

@@ -123,7 +222,7 @@ The ModuleId parameter specifies the Viva module that you want to add the featur
123222
124223
```yaml
125224
Type: String
126-
Parameter Sets: (All)
225+
Parameter Sets: FeaturePolicy
127226
Aliases:
128227
Applicable: Exchange Online
129228

@@ -212,7 +311,7 @@ Accept wildcard characters: False
212311
```
213312

214313
### -IsUserControlEnabled
215-
**Note**: This parameter is available in version 3.3.0 or later of the module. If the feature supports user controls for opting out, make sure you set the *IsUserControlEnabled* parameter when you create the policy. Otherwise, user controls for the policy use the default state for the feature.
314+
This parameter is available in version 3.3.0 or later of the module.
216315

217316
The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are:
218317

@@ -223,7 +322,7 @@ Only features that allow admins to enable and disable user controls by policy ca
223322

224323
```yaml
225324
Type: Boolean
226-
Parameter Sets: (All)
325+
Parameter Sets: FeaturePolicy
227326
Aliases:
228327
Applicable: Exchange Online
229328
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
3+
Module Name: ExchangeOnlineManagement
4+
online version: https://learn.microsoft.com/powershell/module/exchange/get-vivafeaturecategory
5+
applicable: Exchange Online
6+
title: Get-VivaFeatureCategory
7+
schema: 2.0.0
8+
author: chrisda
9+
ms.author: chrisda
10+
ms.reviewer:
11+
---
12+
13+
# Get-VivaFeatureCategory
14+
15+
## SYNOPSIS
16+
This cmdlet is available only in the Exchange Online PowerShell module v3.5.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
17+
18+
**Note**: While we are adding support for category policies in the Exchange Online PowerShell module v3.5.0-Preview1 or later, we have not yet released any categories in Viva. We will update when there are categories available.
19+
20+
Use the Get-VivaFeatureCategory cmdlet to view all categories in Viva that support feature access controls. This cmdlet provides details about the categories, including the category identifiers, descriptions, and Viva module features that belong to the category. A category contains a group of features in the same or different Viva module.
21+
22+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
23+
24+
## SYNTAX
25+
26+
```
27+
Get-VivaFeatureCategory
28+
[-ResultSize <Unlimited>]
29+
[<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
Use the Get-VivaFeatureCategory cmdlet to view the categories in Viva that support feature access controls.
34+
35+
You need to use the Connect-ExchangeOnline cmdlet to authenticate.
36+
37+
This cmdlet requires the .NET Framework 4.7.2 or later.
38+
39+
## EXAMPLES
40+
41+
### Example 1
42+
```powershell
43+
Get-VivaFeatureCategory
44+
```
45+
46+
This example returns all categories in Viva that support feature access controls.
47+
48+
## PARAMETERS
49+
50+
### -ResultSize
51+
This parameter is reserved for internal Microsoft use.
52+
53+
```yaml
54+
Type: Unlimited
55+
Parameter Sets: (All)
56+
Aliases:
57+
58+
Required: False
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### CommonParameters
66+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
67+
68+
## INPUTS
69+
70+
## OUTPUTS
71+
72+
## NOTES
73+
74+
## RELATED LINKS
75+
[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange)
76+
77+
[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2)
78+
79+
[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids)

0 commit comments

Comments
 (0)