Skip to content

Commit 72d1372

Browse files
chrisdachrisda
authored
Merge pull request #13293 from MicrosoftDocs/wf-chrisda
WF-chrisda to Main
2 parents 76bb1ff + b1201a4 commit 72d1372

6 files changed

Lines changed: 346 additions & 0 deletions

File tree

‎exchange/docs-conceptual/exchange-online-powershell-v2.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,9 @@ Miscellaneous Exchange Online feature cmdlets that happen to be in the module ar
191191
|[Add-VivaOrgInsightsDelegatedRole](/powershell/module/exchangepowershell/add-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.|
192192
|[Get-VivaOrgInsightsDelegatedRole](/powershell/module/exchangepowershell/get-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.|
193193
|[Remove-VivaOrgInsightsDelegatedRole](/powershell/module/exchangepowershell/remove-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.|
194+
|[Add-WorkforceInsightsDelegationAccess](/powershell/module/exchangepowershell/add-workforceinsightsdelegationaccess)|Available in v3.9.2-Preview1 or later.|
195+
|[Get-WorkforceInsightsDelegationAccess](/powershell/module/exchangepowershell/get-workforceinsightsdelegationaccess)|Available in v3.9.2-Preview1 or later.|
196+
|[Remove-WorkforceInsightsDelegationAccess](/powershell/module/exchangepowershell/remove-workforceinsightsdelegationaccess)|Available in v3.9.2-Preview1 or later.|
194197

195198
## Install and maintain the Exchange Online PowerShell module
196199

‎exchange/exchange-ps/ExchangePowerShell/Add-WorkforceInsightsDelegationAccess.md‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
applicable: Exchange Online
3+
author: chrisda
4+
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
5+
Locale: en-US
6+
Module Name: ExchangePowerShell
7+
ms.author: chrisda
8+
online version: https://learn.microsoft.com/powershell/module/exchange/add-workforceinsightsdelegationaccess
9+
schema: 2.0.0
10+
title: Add-WorkforceInsightsDelegationAccess
11+
---
12+
13+
# Add-WorkforceInsightsDelegationAccess
14+
15+
## SYNOPSIS
16+
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).
17+
18+
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).
19+
20+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
21+
22+
## SYNTAX
23+
24+
```
25+
Add-WorkforceInsightsDelegationAccess -Delegate <Guid> -Delegator <Guid>
26+
[-ResultSize <Unlimited>]
27+
[<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
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:
32+
33+
- Global Administrator
34+
- AI Administrator
35+
36+
> [!IMPORTANT]
37+
> 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.
38+
39+
## EXAMPLES
40+
41+
### Example 1
42+
```powershell
43+
Add-WorkforceInsightsDelegationAccess -Delegate 8bd05978-667c-4eda-a029-291ea8930677 -Delegator a5f5dbca-8cc8-4a36-bbfc-9b8947b4eb60
44+
```
45+
46+
This example adds the workforce insights delegation access capability of the specified delegator account to the specified delegate account.
47+
48+
## PARAMETERS
49+
50+
### -Delegate
51+
52+
> Applicable: Exchange Online
53+
54+
The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account).
55+
56+
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.
57+
58+
```yaml
59+
Type: Guid
60+
Parameter Sets: (All)
61+
Aliases:
62+
63+
Required: True
64+
Position: Named
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### -Delegator
71+
72+
> Applicable: Exchange Online
73+
74+
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.
75+
76+
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.
77+
78+
```yaml
79+
Type: Guid
80+
Parameter Sets: (All)
81+
Aliases:
82+
83+
Required: True
84+
Position: Named
85+
Default value: None
86+
Accept pipeline input: False
87+
Accept wildcard characters: False
88+
```
89+
90+
### -ResultSize
91+
92+
> Applicable: Exchange Online
93+
94+
This parameter is reserved for internal Microsoft use.
95+
96+
```yaml
97+
Type: Unlimited
98+
Parameter Sets: (All)
99+
Aliases:
100+
101+
Required: False
102+
Position: Named
103+
Default value: None
104+
Accept pipeline input: False
105+
Accept wildcard characters: False
106+
```
107+
108+
### CommonParameters
109+
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).
110+
111+
## INPUTS
112+
113+
## OUTPUTS
114+
115+
## NOTES
116+
117+
## RELATED LINKS

‎exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2354,6 +2354,8 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line
23542354

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

2357+
### [Add-WorkforceInsightsDelegationAccess](Add-WorkforceInsightsDelegationAccess.md)
2358+
23572359
### [Connect-ExchangeOnline](Connect-ExchangeOnline.md)
23582360

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

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

2403+
### [Get-WorkforceInsightsDelegationAccess](Get-WorkforceInsightsDelegationAccess.md)
2404+
24012405
### [Remove-VivaModuleFeaturePolicy](Remove-VivaModuleFeaturePolicy.md)
24022406

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

2409+
### [Remove-WorkforceInsightsDelegationAccess](Remove-WorkforceInsightsDelegationAccess.md)
2410+
24052411
### [Set-DefaultTenantBriefingConfig](Set-DefaultTenantBriefingConfig.md)
24062412

24072413
### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md)

‎exchange/exchange-ps/ExchangePowerShell/Get-WorkforceInsightsDelegationAccess.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
applicable: Exchange Online
3+
author: chrisda
4+
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
5+
Locale: en-US
6+
Module Name: ExchangePowerShell
7+
ms.author: chrisda
8+
online version: https://learn.microsoft.com/powershell/module/exchange/get-workforceinsightsdelegationaccess
9+
schema: 2.0.0
10+
title: Get-WorkforceInsightsDelegationAccess
11+
---
12+
13+
# Get-WorkforceInsightsDelegationAccess
14+
15+
## SYNOPSIS
16+
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).
17+
18+
Use the Get-WorkforceInsightsDelegationAccess cmdlet to view all delegates of the specified delegator. Delegate accounts can view organizational insights like the specified delegator.
19+
20+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
21+
22+
## SYNTAX
23+
24+
```
25+
Get-WorkforceInsightsDelegationAccess -Delegator <Guid>
26+
[-ResultSize <Unlimited>]
27+
[<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
Typically, you use this cmdlet with the Remove-WorkforceInsightsDelegationAccess cmdlet to find the Microsoft Entra ObjectId values of the delegate accounts.
32+
33+
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:
34+
35+
- Global Administrator
36+
- AI Administrator
37+
38+
> [!IMPORTANT]
39+
> 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.
40+
41+
## EXAMPLES
42+
43+
### Example 1
44+
```powershell
45+
Get-WorkforceInsightsDelegationAccess -Delegator a5f5dbca-8cc8-4a36-bbfc-9b8947b4eb60
46+
```
47+
48+
This example filters the results by the specified delegator.
49+
50+
## PARAMETERS
51+
52+
### -Delegator
53+
54+
> Applicable: Exchange Online
55+
56+
The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is given to delegates.
57+
58+
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.
59+
60+
```yaml
61+
Type: Guid
62+
Parameter Sets: (All)
63+
Aliases:
64+
65+
Required: True
66+
Position: Named
67+
Default value: None
68+
Accept pipeline input: False
69+
Accept wildcard characters: False
70+
```
71+
72+
### -ResultSize
73+
74+
> Applicable: Exchange Online
75+
76+
This parameter is reserved for internal Microsoft use.
77+
78+
```yaml
79+
Type: Unlimited
80+
Parameter Sets: (All)
81+
Aliases:
82+
83+
Required: False
84+
Position: Named
85+
Default value: None
86+
Accept pipeline input: False
87+
Accept wildcard characters: False
88+
```
89+
90+
### CommonParameters
91+
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).
92+
93+
## INPUTS
94+
95+
## OUTPUTS
96+
97+
## NOTES
98+
99+
## RELATED LINKS

‎exchange/exchange-ps/ExchangePowerShell/Remove-WorkforceInsightsDelegationAccess.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
applicable: Exchange Online
3+
author: chrisda
4+
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
5+
Locale: en-US
6+
Module Name: ExchangePowerShell
7+
ms.author: chrisda
8+
online version: https://learn.microsoft.com/powershell/module/exchange/remove-workforceinsightsdelegationaccess
9+
schema: 2.0.0
10+
title: Remove-WorkforceInsightsDelegationAccess
11+
---
12+
13+
# Remove-WorkforceInsightsDelegationAccess
14+
15+
## SYNOPSIS
16+
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).
17+
18+
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).
19+
20+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
21+
22+
## SYNTAX
23+
24+
```
25+
Remove-WorkforceInsightsDelegationAccess -Delegate <Guid> -Delegator <Guid>
26+
[-ResultSize <Unlimited>] [<CommonParameters>]
27+
```
28+
29+
## DESCRIPTION
30+
Use the Get-WorkforceInsightsDelegationAccess cmdlet to find the Microsoft Entra ObjectId values of delegate accounts that were given the capabilities of delegator accounts.
31+
32+
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:
33+
34+
- Global Administrator
35+
- AI Administrator
36+
37+
> [!IMPORTANT]
38+
> 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.
39+
40+
## EXAMPLES
41+
42+
### Example 1
43+
```powershell
44+
Remove-WorkforceInsightsDelegationAccess -Delegate 8bd05978-667c-4eda-a029-291ea8930677 -Delegator a5f5dbca-8cc8-4a36-bbfc-9b8947b4eb60
45+
```
46+
47+
This example removes the workforce insights delegation access capability of the specified delegator account from the specified delegate account.
48+
49+
## PARAMETERS
50+
51+
### -Delegate
52+
53+
> Applicable: Exchange Online
54+
55+
The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account).
56+
57+
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.
58+
59+
```yaml
60+
Type: Guid
61+
Parameter Sets: (All)
62+
Aliases:
63+
64+
Required: True
65+
Position: Named
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### -Delegator
72+
73+
> Applicable: Exchange Online
74+
75+
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.
76+
77+
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.
78+
79+
```yaml
80+
Type: Guid
81+
Parameter Sets: (All)
82+
Aliases:
83+
84+
Required: True
85+
Position: Named
86+
Default value: None
87+
Accept pipeline input: False
88+
Accept wildcard characters: False
89+
```
90+
91+
### -ResultSize
92+
93+
> Applicable: Exchange Online
94+
95+
This parameter is reserved for internal Microsoft use.
96+
97+
```yaml
98+
Type: Unlimited
99+
Parameter Sets: (All)
100+
Aliases:
101+
102+
Required: False
103+
Position: Named
104+
Default value: None
105+
Accept pipeline input: False
106+
Accept wildcard characters: False
107+
```
108+
109+
### CommonParameters
110+
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).
111+
112+
## INPUTS
113+
114+
## OUTPUTS
115+
116+
## NOTES
117+
118+
## RELATED LINKS

‎exchange/mapping/serviceMapping.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1153,6 +1153,7 @@
11531153
"Validate-RetentionRuleQuery": "policy-and-compliance-retention",
11541154
"Add-VivaModuleFeaturePolicy": "powershell-v3-module",
11551155
"Add-VivaOrgInsightsDelegatedRole": "powershell-v3-module",
1156+
"Add-WorkforceInsightsDelegationAccess": "powershell-v3-module",
11561157
"Connect-ExchangeOnline": "powershell-v3-module",
11571158
"Connect-IPPSSession": "powershell-v3-module",
11581159
"Disconnect-ExchangeOnline": "powershell-v3-module",
@@ -1175,8 +1176,10 @@
11751176
"Get-VivaModuleFeatureEnablement": "powershell-v3-module",
11761177
"Get-VivaModuleFeaturePolicy": "powershell-v3-module",
11771178
"Get-VivaOrgInsightsDelegatedRole": "powershell-v3-module",
1179+
"Get-WorkforceInsightsDelegationAccess": "powershell-v3-module",
11781180
"Remove-VivaModuleFeaturePolicy": "powershell-v3-module",
11791181
"Remove-VivaOrgInsightsDelegatedRole": "powershell-v3-module",
1182+
"Remove-WorkforceInsightsDelegationAccess": "powershell-v3-module",
11801183
"Set-DefaultTenantBriefingConfig": "powershell-v3-module",
11811184
"Set-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v3-module",
11821185
"Set-MyAnalyticsFeatureConfig": "powershell-v3-module",

0 commit comments

Comments
 (0)