Skip to content

Commit 5c8b7e8

Browse files
authored
Merge pull request #12718 from bowerke/patch-2
Update Get-VivaModuleFeaturePolicy.md
2 parents b425364 + dab7215 commit 5c8b7e8

File tree

1 file changed

+60
-5
lines changed

1 file changed

+60
-5
lines changed

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

Lines changed: 60 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,22 @@ 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 admins 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
25+
```
26+
Get-VivaModuleFeaturePolicy -FeatureId <String> -ModuleId <String> [[-PolicyId] <String>]
27+
[-ResultSize <Unlimited>]
28+
[<CommonParameters>]
29+
```
30+
31+
### FeaturePolicyWithMembers
2332
```
24-
Get-VivaModuleFeaturePolicy -FeatureId <String> -ModuleId <String>
25-
[[-PolicyId] <String>]
33+
Get-VivaModuleFeaturePolicy -ModuleId <String> [[-FeatureId] <String>] [[-MemberIds] <String[]>]
2634
[-ResultSize <Unlimited>]
2735
[<CommonParameters>]
2836
```
@@ -32,6 +40,8 @@ Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a spe
3240

3341
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.
3442

43+
The cmdlet can filter policies based on MemberIds, allowing admins to view policies specific to certain users or groups.
44+
3545
You need to use the Connect-ExchangeOnline cmdlet to authenticate.
3646

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

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

74+
### Example 3
75+
```powershell
76+
Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -MemberIds user1@contoso.com
77+
```
78+
79+
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.
80+
81+
### Example 4
82+
```powershell
83+
Get-VivaModuleFeaturePolicy -ModuleId * -FeatureId * -MemberIds user1@contoso.com,group1@contoso.com
84+
```
85+
86+
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.
87+
6488
## PARAMETERS
6589

6690
### -FeatureId
@@ -70,7 +94,7 @@ To view details about the features in a Viva module that support feature access
7094

7195
```yaml
7296
Type: String
73-
Parameter Sets: (All)
97+
Parameter Sets: FeaturePolicy
7498
Aliases:
7599
Applicable: Exchange Online
76100

@@ -81,6 +105,19 @@ Accept pipeline input: False
81105
Accept wildcard characters: False
82106
```
83107
108+
```yaml
109+
Type: String
110+
Parameter Sets: FeaturePolicyWithMembers
111+
Aliases:
112+
Applicable: Exchange Online
113+
114+
Required: False
115+
Position: Named
116+
Default value: None
117+
Accept pipeline input: False
118+
Accept wildcard characters: True
119+
```
120+
84121
### -ModuleId
85122
The ModuleId parameter specifies the Viva module of the feature policies that you want to view.
86123
@@ -104,7 +141,7 @@ To view details about all policies for a feature in a Viva module, run this cmdl
104141
105142
```yaml
106143
Type: String
107-
Parameter Sets: (All)
144+
Parameter Sets: FeaturePolicy
108145
Aliases:
109146
Applicable: Exchange Online
110147

@@ -115,6 +152,24 @@ Accept pipeline input: False
115152
Accept wildcard characters: False
116153
```
117154
155+
### -MemberIds
156+
The MemberIds parameter specifies the specific users or groups for which you want to view the policies for the feature in the Viva module.
157+
158+
You can provide up to three member IDs. Use the \* character to specify all modules or features.
159+
160+
```yaml
161+
Type: String[]
162+
Parameter Sets: FeaturePolicyWithMembers
163+
Aliases:
164+
Applicable: Exchange Online
165+
166+
Required: False
167+
Position: Named
168+
Default value: None
169+
Accept pipeline input: False
170+
Accept wildcard characters: False
171+
```
172+
118173
### -ResultSize
119174
This parameter is reserved for internal Microsoft use.
120175

0 commit comments

Comments
 (0)