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
3 changes: 3 additions & 0 deletions exchange/docs-conceptual/exchange-online-powershell-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,9 @@ Miscellaneous Exchange Online feature cmdlets that happen to be in the module ar
|[Add-VivaOrgInsightsDelegatedRole](/powershell/module/exchangepowershell/add-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.|
|[Get-VivaOrgInsightsDelegatedRole](/powershell/module/exchangepowershell/get-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.|
|[Remove-VivaOrgInsightsDelegatedRole](/powershell/module/exchangepowershell/remove-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.|
|[Add-WorkforceInsightsDelegationAccess](/powershell/module/exchangepowershell/add-workforceinsightsdelegationaccess)|Available in v3.9.2-Preview1 or later.|
|[Get-WorkforceInsightsDelegationAccess](/powershell/module/exchangepowershell/get-workforceinsightsdelegationaccess)|Available in v3.9.2-Preview1 or later.|
|[Remove-WorkforceInsightsDelegationAccess](/powershell/module/exchangepowershell/remove-workforceinsightsdelegationaccess)|Available in v3.9.2-Preview1 or later.|

## Install and maintain the Exchange Online PowerShell module

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
---
applicable: Exchange Online
author: chrisda
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
Locale: en-US
Module Name: ExchangePowerShell
ms.author: chrisda
online version: https://learn.microsoft.com/powershell/module/exchange/add-workforceinsightsdelegationaccess
schema: 2.0.0
title: Add-WorkforceInsightsDelegationAccess
---

# Add-WorkforceInsightsDelegationAccess

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

Use the Add-WorkforceInsightsDelegationAccess 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-WorkforceInsightsDelegationAccess -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
- AI Administrator

> [!IMPORTANT]
> Microsoft strongly advocates for the principle of least privilege. Assigning accounts only the minimum permissions necessary to perform their tasks helps reduce security risks and strengthens your organization's overall protection. Global Administrator is a highly privileged role that you typically limit to emergency scenarios or when you can't use a different role.

## EXAMPLES

### Example 1
```powershell
Add-WorkforceInsightsDelegationAccess -Delegate 8bd05978-667c-4eda-a029-291ea8930677 -Delegator a5f5dbca-8cc8-4a36-bbfc-9b8947b4eb60
```

This example adds the workforce insights delegation access capability of the specified delegator account to the specified delegate account.

## PARAMETERS

### -Delegate

> Applicable: Exchange Online

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:

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

### -Delegator

> Applicable: Exchange Online

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:

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

### -ResultSize

> Applicable: Exchange Online

This parameter is reserved for internal Microsoft use.

```yaml
Type: Unlimited
Parameter Sets: (All)
Aliases:

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/ExchangePowerShell/ExchangePowerShell.md
Original file line number Diff line number Diff line change
Expand Up @@ -2354,6 +2354,8 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line

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

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

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

### [Connect-IPPSSession](Connect-IPPSSession.md)
Expand Down Expand Up @@ -2398,10 +2400,14 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line

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

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

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

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

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

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

### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
applicable: Exchange Online
author: chrisda
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
Locale: en-US
Module Name: ExchangePowerShell
ms.author: chrisda
online version: https://learn.microsoft.com/powershell/module/exchange/get-workforceinsightsdelegationaccess
schema: 2.0.0
title: Get-WorkforceInsightsDelegationAccess
---

# Get-WorkforceInsightsDelegationAccess

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

Use the Get-WorkforceInsightsDelegationAccess 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-WorkforceInsightsDelegationAccess -Delegator <Guid>
[-ResultSize <Unlimited>]
[<CommonParameters>]
```

## DESCRIPTION
Typically, you use this cmdlet with the Remove-WorkforceInsightsDelegationAccess 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
- AI Administrator

> [!IMPORTANT]
> Microsoft strongly advocates for the principle of least privilege. Assigning accounts only the minimum permissions necessary to perform their tasks helps reduce security risks and strengthens your organization's overall protection. Global Administrator is a highly privileged role that you typically limit to emergency scenarios or when you can't use a different role.

## EXAMPLES

### Example 1
```powershell
Get-WorkforceInsightsDelegationAccess -Delegator a5f5dbca-8cc8-4a36-bbfc-9b8947b4eb60
```

This example filters the results by the specified delegator.

## PARAMETERS

### -Delegator

> Applicable: Exchange Online

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:

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

### -ResultSize

> Applicable: Exchange Online

This parameter is reserved for internal Microsoft use.

```yaml
Type: Unlimited
Parameter Sets: (All)
Aliases:

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
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
---
applicable: Exchange Online
author: chrisda
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
Locale: en-US
Module Name: ExchangePowerShell
ms.author: chrisda
online version: https://learn.microsoft.com/powershell/module/exchange/remove-workforceinsightsdelegationaccess
schema: 2.0.0
title: Remove-WorkforceInsightsDelegationAccess
---

# Remove-WorkforceInsightsDelegationAccess

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

Use the Remove-WorkforceInsightsDelegationAccess 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-WorkforceInsightsDelegationAccess -Delegate <Guid> -Delegator <Guid>
[-ResultSize <Unlimited>] [<CommonParameters>]
```

## DESCRIPTION
Use the Get-WorkforceInsightsDelegationAccess 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
- AI Administrator

> [!IMPORTANT]
> Microsoft strongly advocates for the principle of least privilege. Assigning accounts only the minimum permissions necessary to perform their tasks helps reduce security risks and strengthens your organization's overall protection. Global Administrator is a highly privileged role that you typically limit to emergency scenarios or when you can't use a different role.

## EXAMPLES

### Example 1
```powershell
Remove-WorkforceInsightsDelegationAccess -Delegate 8bd05978-667c-4eda-a029-291ea8930677 -Delegator a5f5dbca-8cc8-4a36-bbfc-9b8947b4eb60
```

This example removes the workforce insights delegation access capability of the specified delegator account from the specified delegate account.

## PARAMETERS

### -Delegate

> Applicable: Exchange Online

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:

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

### -Delegator

> Applicable: Exchange Online

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:

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

### -ResultSize

> Applicable: Exchange Online

This parameter is reserved for internal Microsoft use.

```yaml
Type: Unlimited
Parameter Sets: (All)
Aliases:

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
3 changes: 3 additions & 0 deletions exchange/mapping/serviceMapping.json
Original file line number Diff line number Diff line change
Expand Up @@ -1153,6 +1153,7 @@
"Validate-RetentionRuleQuery": "policy-and-compliance-retention",
"Add-VivaModuleFeaturePolicy": "powershell-v3-module",
"Add-VivaOrgInsightsDelegatedRole": "powershell-v3-module",
"Add-WorkforceInsightsDelegationAccess": "powershell-v3-module",
"Connect-ExchangeOnline": "powershell-v3-module",
"Connect-IPPSSession": "powershell-v3-module",
"Disconnect-ExchangeOnline": "powershell-v3-module",
Expand All @@ -1175,8 +1176,10 @@
"Get-VivaModuleFeatureEnablement": "powershell-v3-module",
"Get-VivaModuleFeaturePolicy": "powershell-v3-module",
"Get-VivaOrgInsightsDelegatedRole": "powershell-v3-module",
"Get-WorkforceInsightsDelegationAccess": "powershell-v3-module",
"Remove-VivaModuleFeaturePolicy": "powershell-v3-module",
"Remove-VivaOrgInsightsDelegatedRole": "powershell-v3-module",
"Remove-WorkforceInsightsDelegationAccess": "powershell-v3-module",
"Set-DefaultTenantBriefingConfig": "powershell-v3-module",
"Set-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v3-module",
"Set-MyAnalyticsFeatureConfig": "powershell-v3-module",
Expand Down