Skip to content

Commit 9af308a

Browse files
authored
Update Get-VivaModuleFeaturePolicy.md
Updating Get-VivaModuleFeaturePolicy to support FeaturePolicyWithMembers added syntax block, examples, and additional information in description
1 parent b425364 commit 9af308a

File tree

1 file changed

+74
-4
lines changed

1 file changed

+74
-4
lines changed

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

Lines changed: 74 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,36 @@ 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 Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module in Viva. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. This cmdlet provides details about the policies, including the policy's identifier, name, and creation date.
18+
Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module in Viva. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. This cmdlet provides details about the policies, including the policy's identifier, name, and creation date. The cmdlet can filter policies based on MemberIds, allowing administrators to view policies specific to certain users or groups.
1919

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

2222
## SYNTAX
23+
24+
### FeaturePolicy
2325
```
2426
Get-VivaModuleFeaturePolicy -FeatureId <String> -ModuleId <String>
2527
[[-PolicyId] <String>]
2628
[-ResultSize <Unlimited>]
2729
[<CommonParameters>]
2830
```
2931

32+
### FeaturePolicyWithMembers
33+
```
34+
Get-VivaModuleFeaturePolicy -ModuleId <String>
35+
[[-FeatureId] <String>]
36+
[[-MemberIds] <String[]>]
37+
[-ResultSize <Unlimited>]
38+
[<CommonParameters>]
39+
```
40+
3041
## DESCRIPTION
3142
Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module in Viva.
3243

3344
You can view all policies for a specified feature in a Viva module in Viva. To view a specific policy, you can include the PolicyId parameter.
3445

46+
The cmdlet can filter policies based on MemberIds, allowing administrators to view policies specific to certain users or groups.
47+
3548
You need to use the Connect-ExchangeOnline cmdlet to authenticate.
3649

3750
This cmdlet requires the .NET Framework 4.7.2 or later.
@@ -61,6 +74,20 @@ Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Policy
6174

6275
This example returns details about a specific policy added for the Reflection feature in Viva Insights.
6376

77+
### Example 3
78+
```powershell
79+
Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -MemberIds user1@contoso.com
80+
```
81+
82+
This example returns details about the policies for the Reflection feature in Viva Insights that apply to the user with the email user1@contoso.com.
83+
84+
### Example 4
85+
```powershell
86+
Get-VivaModuleFeaturePolicy -ModuleId * -FeatureId * -MemberIds user1@contoso.com,group1@contoso.com
87+
```
88+
89+
This example returns details about the policies for all features across all Viva modules that apply to the user with the email user1@contoso.com and the group with the email group1@contoso.com.
90+
6491
## PARAMETERS
6592

6693
### -FeatureId
@@ -70,7 +97,7 @@ To view details about the features in a Viva module that support feature access
7097

7198
```yaml
7299
Type: String
73-
Parameter Sets: (All)
100+
Parameter Sets: FeaturePolicy
74101
Aliases:
75102
Applicable: Exchange Online
76103

@@ -80,13 +107,25 @@ Default value: None
80107
Accept pipeline input: False
81108
Accept wildcard characters: False
82109
```
110+
```yaml
111+
Type: String
112+
Parameter Sets: FeaturePolicyWithMembers
113+
Aliases:
114+
Applicable: Exchange Online
115+
116+
Required: False
117+
Position: Named
118+
Default value: None
119+
Accept pipeline input: False
120+
Accept wildcard characters: True
121+
```
83122
84123
### -ModuleId
85124
The ModuleId parameter specifies the Viva module of the feature policies that you want to view.
86125
87126
```yaml
88127
Type: String
89-
Parameter Sets: (All)
128+
Parameter Sets: FeaturePolicy
90129
Aliases:
91130
Applicable: Exchange Online
92131

@@ -96,6 +135,18 @@ Default value: None
96135
Accept pipeline input: False
97136
Accept wildcard characters: False
98137
```
138+
```yaml
139+
Type: String
140+
Parameter Sets: FeaturePolicyWithMembers
141+
Aliases:
142+
Applicable: Exchange Online
143+
144+
Required: True
145+
Position: Named
146+
Default value: None
147+
Accept pipeline input: False
148+
Accept wildcard characters: True
149+
```
99150
100151
### -PolicyId
101152
The PolicyId parameter specifies the specific policy for the feature in the Viva module that you want to view.
@@ -104,7 +155,7 @@ To view details about all policies for a feature in a Viva module, run this cmdl
104155
105156
```yaml
106157
Type: String
107-
Parameter Sets: (All)
158+
Parameter Sets: FeaturePolicy
108159
Aliases:
109160
Applicable: Exchange Online
110161

@@ -115,6 +166,25 @@ Accept pipeline input: False
115166
Accept wildcard characters: False
116167
```
117168
169+
170+
### -MemberIds
171+
The MemberIds parameter specifies the specific users or groups for which you want to view the policies for the feature in the Viva module.
172+
173+
You can provide up to 3 member IDs. The * character can be used to specify all modules or features.
174+
175+
```yaml
176+
Type: String[]
177+
Parameter Sets: FeaturePolicyWithMembers
178+
Aliases:
179+
Applicable: Exchange Online
180+
181+
Required: False
182+
Position: Named
183+
Default value: None
184+
Accept pipeline input: False
185+
Accept wildcard characters: False
186+
```
187+
118188
### -ResultSize
119189
This parameter is reserved for internal Microsoft use.
120190

0 commit comments

Comments
 (0)