Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion exchange/docs-conceptual/exchange-online-powershell-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: About the Exchange Online PowerShell V3 module
ms.author: chrisda
author: chrisda
manager: deniseb
ms.date: 09/25/2024
ms.date: 10/28/2024
ms.audience: Admin
audience: Admin
ms.topic: article
Expand Down Expand Up @@ -193,6 +193,9 @@ Miscellaneous Exchange Online cmdlets that happen to be in the module are listed
|[Get-VivaModuleFeaturePolicy](/powershell/module/exchange/get-vivamodulefeaturepolicy)|Available in v3.2.0 or later.|
|[Remove-VivaModuleFeaturePolicy](/powershell/module/exchange/remove-vivamodulefeaturepolicy)|Available in v3.2.0 or later.|
|[Update-VivaModuleFeaturePolicy](/powershell/module/exchange/update-vivamodulefeaturepolicy)|Available in v3.2.0 or later.|
|[Add-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/add-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.|
|[Get-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/get-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.|
|[Remove-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/remove-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.|

## Install and maintain the Exchange Online PowerShell module

Expand Down
110 changes: 110 additions & 0 deletions exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
Module Name: ExchangeOnlineManagement
online version: https://learn.microsoft.com/powershell/module/exchange/add-vivaorginsightsdelegatedrole
title: Add-VivaOrgInsightsDelegatedRole
schema: 2.0.0
author: chrisda
ms.author: chrisda
ms.reviewer:
---

# Add-VivaOrgInsightsDelegatedRole

## SYNOPSIS
This cmdlet is available only in the Exchange Online PowerShell module v3.7.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).

Use the Add-VivaOrgInsightsDelegatedRole cmdlet to add delegate access to the specified account (the delegate) so they can view organizational insights like the leader (the delegator).

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

## SYNTAX

```
Add-VivaOrgInsightsDelegatedRole -Delegate <Guid> -Delegator <Guid>
[-ResultSize <Unlimited>]
[<CommonParameters>]
```

## DESCRIPTION
To run this cmdlet, you need to be a member of one of the following role groups in Microsoft Entra ID in the destination organization:

- Global Administrator
- Insights Administrator

> [!IMPORTANT]
> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role.

## EXAMPLES

### Example 1
```powershell
Add-VivaOrgInsightsDelegatedRole -Delegate 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9
```

This example adds the organization insights viewing capability of the specified delegator account to the specified delegate account.

## PARAMETERS

### -Delegate
The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account).

A valid value for this parameter is the Microsoft Entra ObjectId value of the delegate account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value.

```yaml
Type: Guid
Parameter Sets: (All)
Aliases:
Applicable: Exchange Online

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

### -Delegator
The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is delegated to the account specified by the Delegate parameter.

A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value.

```yaml
Type: Guid
Parameter Sets: (All)
Aliases:
Applicable: Exchange Online

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

### -ResultSize
This parameter is reserved for internal Microsoft use.

```yaml
Type: Unlimited
Parameter Sets: (All)
Aliases:
Applicable: Exchange Online

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

### CommonParameters
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).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
94 changes: 94 additions & 0 deletions exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
Module Name: ExchangeOnlineManagement
online version: https://learn.microsoft.com/powershell/module/exchange/get-vivaorginsightsdelegatedrole
title: Get-VivaOrgInsightsDelegatedRole
schema: 2.0.0
author: chrisda
ms.author: chrisda
ms.reviewer:
---

# Get-VivaOrgInsightsDelegatedRole

## SYNOPSIS
This cmdlet is available only in the Exchange Online PowerShell module v3.7.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).

Use the Get-VivaOrgInsightsDelegatedRole cmdlet to view all delegates of the specified delegator. Delegate accounts can view organizational insights like the specified delegator.

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

## SYNTAX

```
Get-VivaOrgInsightsDelegatedRole -Delegator <Guid>
[-ResultSize <Unlimited>]
[<CommonParameters>]
```

## DESCRIPTION
Typically, you use this cmdlet with the Remove-VivaOrgInsightsDelegatedRole cmdlet to find the Microsoft Entra ObjectId values of the delegate accounts.

To run this cmdlet, you need to be a member of one of the following role groups in Microsoft Entra ID in the destination organization:

- Global Administrator
- Insights Administrator

> [!IMPORTANT]
> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role.

## EXAMPLES

### Example 1
```powershell
Get-VivaOrgInsightsDelegatedRole -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9
```

This example filters the results by the specified delegator.

## PARAMETERS

### -Delegator
The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is given to delegates.

A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value.

```yaml
Type: Guid
Parameter Sets: (All)
Aliases:
Applicable: Exchange Online

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

### -ResultSize
The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

```yaml
Type: Unlimited
Parameter Sets: (All)
Aliases:
Applicable: Exchange Online

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

### CommonParameters
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).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
112 changes: 112 additions & 0 deletions exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
---
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
Module Name: ExchangeOnlineManagement
online version: https://learn.microsoft.com/powershell/module/exchange/remove-vivaorginsightsdelegatedrole
title: Remove-VivaOrgInsightsDelegatedRole
schema: 2.0.0
author: chrisda
ms.author: chrisda
ms.reviewer:
---

# Remove-VivaOrgInsightsDelegatedRole

## SYNOPSIS
This cmdlet is available only in the Exchange Online PowerShell module v3.7.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).

Use the Remove-VivaOrgInsightsDelegatedRole cmdlet to remove delegate access from the specified account (the delegate) so they can't view organizational insights like the leader (the delegator).

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

## SYNTAX

```
Remove-VivaOrgInsightsDelegatedRole -Delegate <Guid> -Delegator <Guid>
[-ResultSize <Unlimited>]
[<CommonParameters>]
```

## DESCRIPTION
Use the Get-VivaOrgInsightsDelegatedRole cmdlet to find the Microsoft Entra ObjectId values of delegate accounts that were given the capabilities of delegator accounts.

To run this cmdlet, you need to be a member of one of the following role groups in Microsoft Entra ID in the destination organization:

- Global Administrator
- Insights Administrator

> [!IMPORTANT]
> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role.

## EXAMPLES

### Example 1
```powershell
Remove-VivaOrgInsightsDelegatedRole -Delegate 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9
```

This example removes the organization insights viewing capability of the specified delegator account from the specified delegate account.

## PARAMETERS

### -Delegate
The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account).

A valid value for this parameter is the Microsoft Entra ObjectId value of the delegate account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value.

```yaml
Type: Guid
Parameter Sets: (All)
Aliases:
Applicable: Exchange Online

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

### -Delegator
The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is delegated to the account specified by the Delegate parameter.

A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value.

```yaml
Type: Guid
Parameter Sets: (All)
Aliases:
Applicable: Exchange Online

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

### -ResultSize
This parameter is reserved for internal Microsoft use.

```yaml
Type: Unlimited
Parameter Sets: (All)
Aliases:
Applicable: Exchange Online

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

### CommonParameters
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).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
6 changes: 6 additions & 0 deletions exchange/exchange-ps/exchange/exchange.md
Original file line number Diff line number Diff line change
Expand Up @@ -2337,6 +2337,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow
## powershell-v3-module Cmdlets
### [Add-VivaModuleFeaturePolicy](Add-VivaModuleFeaturePolicy.md)

### [Add-VivaOrgInsightsDelegatedRole](Add-VivaOrgInsightsDelegatedRole.md)

### [Connect-ExchangeOnline](Connect-ExchangeOnline.md)

### [Connect-IPPSSession](Connect-IPPSSession.md)
Expand Down Expand Up @@ -2379,8 +2381,12 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow

### [Get-VivaModuleFeaturePolicy](Get-VivaModuleFeaturePolicy.md)

### [Get-VivaOrgInsightsDelegatedRole](Get-VivaOrgInsightsDelegatedRole.md)

### [Remove-VivaModuleFeaturePolicy](Remove-VivaModuleFeaturePolicy.md)

### [Remove-VivaOrgInsightsDelegatedRole](Remove-VivaOrgInsightsDelegatedRole.md)

### [Set-DefaultTenantBriefingConfig](Set-DefaultTenantBriefingConfig.md)

### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md)
Expand Down
3 changes: 3 additions & 0 deletions exchange/mapping/serviceMapping.json
Original file line number Diff line number Diff line change
Expand Up @@ -1149,6 +1149,7 @@
"Stop-ManagedFolderAssistant": "policy-and-compliance-retention",
"Validate-RetentionRuleQuery": "policy-and-compliance-retention",
"Add-VivaModuleFeaturePolicy": "powershell-v3-module",
"Add-VivaOrgInsightsDelegatedRole": "powershell-v3-module",
"Connect-ExchangeOnline": "powershell-v3-module",
"Connect-IPPSSession": "powershell-v3-module",
"Disconnect-ExchangeOnline": "powershell-v3-module",
Expand All @@ -1170,7 +1171,9 @@
"Get-VivaModuleFeature": "powershell-v3-module",
"Get-VivaModuleFeatureEnablement": "powershell-v3-module",
"Get-VivaModuleFeaturePolicy": "powershell-v3-module",
"Get-VivaOrgInsightsDelegatedRole": "powershell-v3-module",
"Remove-VivaModuleFeaturePolicy": "powershell-v3-module",
"Remove-VivaOrgInsightsDelegatedRole": "powershell-v3-module",
"Set-DefaultTenantBriefingConfig": "powershell-v3-module",
"Set-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v3-module",
"Set-MyAnalyticsFeatureConfig": "powershell-v3-module",
Expand Down