Skip to content

Update Get-VivaModuleFeaturePolicy.md #12651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 3, 2025
Merged

Update Get-VivaModuleFeaturePolicy.md #12651

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba3bc0c
Update Get-VivaModuleFeaturePolicy.md
knovichenko Apr 3, 2025
cfc54ee
Merge branch 'Viva-chrisda' into patch-3
chrisda Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 5 additions & 53 deletions exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ ms.reviewer:
## SYNOPSIS
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).

**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.

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

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

Expand All @@ -31,20 +29,10 @@ Get-VivaModuleFeaturePolicy -FeatureId <String> -ModuleId <String>
[<CommonParameters>]
```

### CategoryPolicy
```
Get-VivaModuleFeaturePolicy -CategoryId <String>
[[-PolicyId] <String>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
```

## DESCRIPTION
Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module or a category in Viva.

Support for categories is available in version 3.5.0-Preview2 or later of the module.
Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module in Viva.

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

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

Expand Down Expand Up @@ -75,44 +63,8 @@ Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Policy

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

### Example 3
```powershell
Get-VivaModuleFeaturePolicy -CategoryId <category_id>
```

This example returns details about all the policies added for the `<category_id>` category in Viva.

### Example 4
```powershell
Get-VivaModuleFeaturePolicy -CategoryId <category_id> -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b
```

This example returns details about a specific policy added for the `<category_id>` category in Viva.

## PARAMETERS

### -CategoryId
This parameter is available in version 3.5.0-Preview2 or later of the module.

**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available.

The CategoryId parameter specifies the category that you want to view the policies for.

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.

```yaml
Type: String
Parameter Sets: CategoryPolicy
Aliases:
Applicable: Exchange Online

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -FeatureId
The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for.

Expand Down Expand Up @@ -148,9 +100,9 @@ Accept wildcard characters: False
```

### -PolicyId
The PolicyId parameter specifies the specific policy for the feature in the Viva module or the category that you want to view.
The PolicyId parameter specifies the specific policy for the feature in the Viva module that you want to view.

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

```yaml
Type: String
Expand Down