Skip to content

Commit dbb4a6c

Browse files
authored
Merge pull request #11676 from YanyuZhongZyy/patch-9
Update Get-VivaModuleFeaturePolicy.md for VFAM feature category preview release
2 parents 782fcba + 1d14ab9 commit dbb4a6c

File tree

1 file changed

+33
-29
lines changed

1 file changed

+33
-29
lines changed

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

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,18 @@ 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. 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+
**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 Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module or category in Viva. Policies are used to restrict or grant access to the specified feature or category for specific users, groups, or the entire tenant. This cmdlet provides details about the policies, including the policy's identifier, name, and creation date.
1921

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

2224
## SYNTAX
2325

2426
### FeaturePolicy
2527
```
26-
Get-VivaModuleFeaturePolicy -ModuleId <String> -FeatureId <String>
28+
Get-VivaModuleFeaturePolicy -FeatureId <String> -ModuleId <String>
2729
[[-PolicyId] <String>]
28-
[-ProgressAction <ActionPreference>]
2930
[-ResultSize <Unlimited>]
3031
[<CommonParameters>]
3132
```
@@ -34,21 +35,24 @@ Get-VivaModuleFeaturePolicy -ModuleId <String> -FeatureId <String>
3435
```
3536
Get-VivaModuleFeaturePolicy -CategoryId <String>
3637
[[-PolicyId] <String>]
37-
[-ProgressAction <ActionPreference>]
3838
[-ResultSize <Unlimited>]
3939
[<CommonParameters>]
4040
```
4141

4242
## DESCRIPTION
43-
Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module.
43+
Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module or a category in Viva.
44+
45+
Support for categories is available in version 3.5.0-Preview1 or later of the module.
4446

45-
You can view all policies for a specified feature in a Viva module. To view a specific policy, you can include the PolicyId parameter.
47+
You can view all policies for a specified feature in a Viva module or a category in Viva. To view a specific policy, you can include the PolicyId parameter.
4648

4749
You need to use the Connect-ExchangeOnline cmdlet to authenticate.
4850

4951
This cmdlet requires the .NET Framework 4.7.2 or later.
5052

51-
Currently, you need to be a member of the Global administrators role to run this cmdlet.
53+
Currently, you need to be a member of the Global administrators role or the roles that have been permissioned at the feature level to run this cmdlet.
54+
55+
To learn more about permissioned 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).
5256

5357
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).
5458

@@ -68,12 +72,30 @@ Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Policy
6872

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

75+
### Example 3
76+
```powershell
77+
Get-VivaModuleFeaturePolicy -CategoryId <category_id>
78+
```
79+
80+
This example returns details about all the policies added for the `<category_id>` category in Viva.
81+
82+
### Example 4
83+
```powershell
84+
Get-VivaModuleFeaturePolicy -CategoryId <category_id> -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b
85+
```
86+
87+
This example returns details about a specific policy added for the `<category_id>` category in Viva.
88+
7189
## PARAMETERS
7290

7391
### -CategoryId
74-
**Note**: This parameter is available only in the Exchange Online PowerShell module v3.5.0-Preview??? or later.
92+
This parameter is available in version 3.5.0-Preview1 or later of the module.
93+
94+
**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available.
95+
96+
The CategoryId parameter specifies the category that you want to view the policies for.
7597

76-
{{ Fill CategoryId Description }}
98+
To view details about the categories in Viva that support feature access controls, refer to the Get-VivaFeatureCategory cmdlet. The details provided by the Get-VivaFeatureCategory cmdlet include the category identifier.
7799

78100
```yaml
79101
Type: String
@@ -123,9 +145,9 @@ Accept wildcard characters: False
123145
```
124146
125147
### -PolicyId
126-
The PolicyId parameter specifies the specific policy for the feature in the Viva module that you want to view.
148+
The PolicyId parameter specifies the specific policy for the feature in the Viva module or the category that you want to view.
127149
128-
To view details about all policies for a feature in a Viva module, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module.
150+
To view details about all policies for a feature in a Viva module or a category, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module or a category.
129151
130152
```yaml
131153
Type: String
@@ -140,24 +162,6 @@ Accept pipeline input: False
140162
Accept wildcard characters: False
141163
```
142164
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-
161165
### -ResultSize
162166
This parameter is reserved for internal Microsoft use.
163167

0 commit comments

Comments
 (0)