Skip to content

Commit 0b55ee9

Browse files
chrisdachrisda
committed
Viva Feature cmdlet updates
1 parent b3ca314 commit 0b55ee9

File tree

5 files changed

+275
-22
lines changed

5 files changed

+275
-22
lines changed

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

Lines changed: 55 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,34 @@ Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a spec
2020
- You can assign up to 10 policies per feature. An additional one policy per feature can be assigned to the entire tenant.
2121
- 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.
2222

23-
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.
23+
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.
2424

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

2727
## SYNTAX
2828

29+
### FeaturePolicy
2930
```
30-
Add-VivaModuleFeaturePolicy -FeatureId <String> -IsFeatureEnabled <Boolean> -ModuleId <String> -Name <String>
31+
Add-VivaModuleFeaturePolicy -FeatureId <String> -IsFeatureEnabled <Boolean> -ModuleId <String> -Name <String> [-IsUserControlEnabled <Boolean>]
3132
[-Confirm]
33+
[-Everyone]
3234
[-GroupIds <String[]>]
35+
[-ProgressAction <ActionPreference>]
36+
[-ResultSize <Unlimited>]
3337
[-UserIds <String[]>]
38+
[-WhatIf]
39+
[<CommonParameters>]
40+
```
41+
42+
### CategoryPolicy
43+
```
44+
Add-VivaModuleFeaturePolicy -CategoryId <String> -IsCategoryEnabled <Boolean> -Name <String>
45+
[-Confirm]
3446
[-Everyone]
35-
[-IsUserControlEnabled <Boolean>]
47+
[-GroupIds <String[]>]
48+
[-ProgressAction <ActionPreference>]
3649
[-ResultSize <Unlimited>]
50+
[-UserIds <String[]>]
3751
[-WhatIf]
3852
[<CommonParameters>]
3953
```
@@ -81,14 +95,48 @@ This example adds a policy for the Reflection feature in Viva Insights. The poli
8195

8296
## PARAMETERS
8397

98+
### -CategoryId
99+
**Note**: This parameter is available only in the Exchange Online PowerShell module v3.5.0-Preview??? or later.
100+
101+
{{ Fill CategoryId Description }}
102+
103+
```yaml
104+
Type: String
105+
Parameter Sets: CategoryPolicy
106+
Aliases:
107+
Applicable: Exchange Online
108+
109+
Required: True
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: False
113+
Accept wildcard characters: False
114+
```
115+
84116
### -FeatureId
85117
The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for.
86118
87119
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.
88120
89121
```yaml
90122
Type: String
91-
Parameter Sets: (All)
123+
Parameter Sets: FeaturePolicy
124+
Aliases:
125+
Applicable: Exchange Online
126+
127+
Required: True
128+
Position: Named
129+
Default value: None
130+
Accept pipeline input: False
131+
Accept wildcard characters: False
132+
```
133+
134+
### -IsCategoryEnabled
135+
{{ Fill IsCategoryEnabled Description }}
136+
137+
```yaml
138+
Type: Boolean
139+
Parameter Sets: CategoryPolicy
92140
Aliases:
93141
Applicable: Exchange Online
94142

@@ -107,7 +155,7 @@ The IsFeatureEnabled parameter specifies whether or not the feature is enabled b
107155
108156
```yaml
109157
Type: Boolean
110-
Parameter Sets: (All)
158+
Parameter Sets: FeaturePolicy
111159
Aliases:
112160
Applicable: Exchange Online
113161

@@ -123,7 +171,7 @@ The ModuleId parameter specifies the Viva module that you want to add the featur
123171
124172
```yaml
125173
Type: String
126-
Parameter Sets: (All)
174+
Parameter Sets: FeaturePolicy
127175
Aliases:
128176
Applicable: Exchange Online
129177

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

224272
```yaml
225273
Type: Boolean
226-
Parameter Sets: (All)
274+
Parameter Sets: FeaturePolicy
227275
Aliases:
228276
Applicable: Exchange Online
229277

‎exchange/exchange-ps/exchange/Get-VivaFeatureCategory.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
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-Preview??? or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
17+
18+
Use the Get-VivaFeatureCategory cmdlet to ???
19+
20+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
21+
22+
## SYNTAX
23+
24+
```
25+
Get-VivaFeatureCategory
26+
[-ResultSize <Unlimited>]
27+
[-ProgressAction <ActionPreference>]
28+
[<CommonParameters>]
29+
```
30+
31+
## DESCRIPTION
32+
{{ Fill in the Description }}
33+
34+
## EXAMPLES
35+
36+
### Example 1
37+
```powershell
38+
{{ Add example code here }}
39+
```
40+
41+
{{ Add example description here }}
42+
43+
## PARAMETERS
44+
45+
### -ResultSize
46+
{{ Fill ResultSize Description }}
47+
48+
```yaml
49+
Type: Unlimited
50+
Parameter Sets: (All)
51+
Aliases:
52+
53+
Required: False
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -ProgressAction
61+
{{ Fill ProgressAction Description }}
62+
63+
```yaml
64+
Type: ActionPreference
65+
Parameter Sets: (All)
66+
Aliases: proga
67+
68+
Required: False
69+
Position: Named
70+
Default value: None
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
75+
### CommonParameters
76+
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).
77+
78+
## INPUTS
79+
80+
## OUTPUTS
81+
82+
## NOTES
83+
84+
## RELATED LINKS

‎exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,21 @@ For information about the parameter sets in the Syntax section below, see [Excha
2121

2222
## SYNTAX
2323

24+
### FeaturePolicy
2425
```
25-
Get-VivaModuleFeaturePolicy -FeatureId <String> -ModuleId <String>
26+
Get-VivaModuleFeaturePolicy -ModuleId <String> -FeatureId <String>
2627
[[-PolicyId] <String>]
27-
[-ResultSize <Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32]>]
28+
[-ProgressAction <ActionPreference>]
29+
[-ResultSize <Unlimited>]
30+
[<CommonParameters>]
31+
```
32+
33+
### CategoryPolicy
34+
```
35+
Get-VivaModuleFeaturePolicy -CategoryId <String>
36+
[[-PolicyId] <String>]
37+
[-ProgressAction <ActionPreference>]
38+
[-ResultSize <Unlimited>]
2839
[<CommonParameters>]
2940
```
3041

@@ -59,14 +70,32 @@ This example returns details about a specific policy added for the Reflection fe
5970

6071
## PARAMETERS
6172

73+
### -CategoryId
74+
**Note**: This parameter is available only in the Exchange Online PowerShell module v3.5.0-Preview??? or later.
75+
76+
{{ Fill CategoryId Description }}
77+
78+
```yaml
79+
Type: String
80+
Parameter Sets: CategoryPolicy
81+
Aliases:
82+
Applicable: Exchange Online
83+
84+
Required: True
85+
Position: Named
86+
Default value: None
87+
Accept pipeline input: False
88+
Accept wildcard characters: False
89+
```
90+
6291
### -FeatureId
6392
The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for.
6493
6594
To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier.
6695
6796
```yaml
6897
Type: String
69-
Parameter Sets: (All)
98+
Parameter Sets: FeaturePolicy
7099
Aliases:
71100
Applicable: Exchange Online
72101

@@ -82,7 +111,7 @@ The ModuleId parameter specifies the Viva module of the feature policies that yo
82111
83112
```yaml
84113
Type: String
85-
Parameter Sets: (All)
114+
Parameter Sets: FeaturePolicy
86115
Aliases:
87116
Applicable: Exchange Online
88117

@@ -111,6 +140,24 @@ Accept pipeline input: False
111140
Accept wildcard characters: False
112141
```
113142
143+
### -ProgressAction
144+
**Note**: This parameter is available only in the Exchange Online PowerShell module v3.5.0-Preview??? or later.
145+
146+
{{ Fill ProgressAction Description }}
147+
148+
```yaml
149+
Type: ActionPreference
150+
Parameter Sets: (All)
151+
Aliases: proga
152+
Applicable: Exchange Online
153+
154+
Required: False
155+
Position: Named
156+
Default value: None
157+
Accept pipeline input: False
158+
Accept wildcard characters: False
159+
```
160+
114161
### -ResultSize
115162
This parameter is reserved for internal Microsoft use.
116163

‎exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,21 @@ For information about the parameter sets in the Syntax section below, see [Excha
2121

2222
## SYNTAX
2323

24+
### FeaturePolicy
2425
```
25-
Remove-VivaModuleFeaturePolicy -FeatureId <String> -ModuleId <String> -PolicyId <String>
26+
Remove-VivaModuleFeaturePolicy -ModuleId <String> -FeatureId <String> -PolicyId <String>
2627
[-Confirm]
28+
[-ProgressAction <ActionPreference>]
29+
[-ResultSize <Unlimited>]
30+
[-WhatIf]
31+
[<CommonParameters>]
32+
```
33+
34+
### CategoryPolicy
35+
```
36+
Remove-VivaModuleFeaturePolicy -CategoryId <String> -PolicyId <String>
37+
[-Confirm]
38+
[-ProgressAction <ActionPreference>]
2739
[-ResultSize <Unlimited>]
2840
[-WhatIf]
2941
[<CommonParameters>]
@@ -51,14 +63,30 @@ This example deletes the specified policy for the Reflection feature in Viva Ins
5163

5264
## PARAMETERS
5365

66+
### -CategoryId
67+
{{ Fill CategoryId Description }}
68+
69+
```yaml
70+
Type: String
71+
Parameter Sets: CategoryPolicy
72+
Aliases:
73+
Applicable: Exchange Online
74+
75+
Required: True
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: False
79+
Accept wildcard characters: False
80+
```
81+
5482
### -FeatureId
5583
The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from.
5684
5785
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.
5886
5987
```yaml
6088
Type: String
61-
Parameter Sets: (All)
89+
Parameter Sets: FeaturePolicy
6290
Aliases:
6391
Applicable: Exchange Online
6492

@@ -74,7 +102,7 @@ The ModuleId parameter specifies the Viva module of the feature that you want to
74102
75103
```yaml
76104
Type: String
77-
Parameter Sets: (All)
105+
Parameter Sets: FeaturePolicy
78106
Aliases:
79107
Applicable: Exchange Online
80108

0 commit comments

Comments
 (0)