Skip to content

Commit ef934a3

Browse files
chrisdachrisda
committed
Merge branch 'main' into chrisda
2 parents 04b5277 + 7b619f3 commit ef934a3

File tree

7 files changed

+357
-4
lines changed

7 files changed

+357
-4
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: About the Exchange Online PowerShell V3 module
33
ms.author: chrisda
44
author: chrisda
55
manager: deniseb
6-
ms.date: 09/25/2024
6+
ms.date: 10/28/2024
77
ms.audience: Admin
88
audience: Admin
99
ms.topic: article
@@ -193,6 +193,9 @@ Miscellaneous Exchange Online cmdlets that happen to be in the module are listed
193193
|[Get-VivaModuleFeaturePolicy](/powershell/module/exchange/get-vivamodulefeaturepolicy)|Available in v3.2.0 or later.|
194194
|[Remove-VivaModuleFeaturePolicy](/powershell/module/exchange/remove-vivamodulefeaturepolicy)|Available in v3.2.0 or later.|
195195
|[Update-VivaModuleFeaturePolicy](/powershell/module/exchange/update-vivamodulefeaturepolicy)|Available in v3.2.0 or later.|
196+
|[Add-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/add-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.|
197+
|[Get-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/get-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.|
198+
|[Remove-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/remove-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.|
196199

197200
## Install and maintain the Exchange Online PowerShell module
198201

‎exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md

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

‎exchange/exchange-ps/exchange/Connect-ExchangeOnline.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Connect-ExchangeOnline
4444
[-Device]
4545
[-EnableErrorReporting]
4646
[-InlineCredential]
47+
[-LoadCmdletHelp]
4748
[-LogDirectoryPath <String>]
4849
[-LogLevel <LogLevel>]
4950
[-ManagedIdentity]
@@ -496,6 +497,28 @@ Accept pipeline input: False
496497
Accept wildcard characters: False
497498
```
498499

500+
### -LoadCmdletHelp
501+
**Note**: This parameter is available in version 3.7.0-Preview1 or later of the module.
502+
503+
The LoadCmdletHelp switch downloads cmdlet help files for the Get-Help cmdlet in REST API connections. You don't need to specify a value with this switch.
504+
505+
Starting in v3.7.0-Preview1, help files for the command line aren't downloaded by default. Use this switch to download the files for cmdlet help at the command line.
506+
507+
**Tip**: This parameter replaces the SkipLoadingCmdletHelp parameter. The SkipLoadingCmdletHelp parameter is no longer required and no longer works, because cmdlet help files are no longer downloaded by default.
508+
509+
```yaml
510+
Type: SwitchParameter
511+
Parameter Sets: (All)
512+
Aliases:
513+
Applicable: Exchange Online
514+
515+
Required: False
516+
Position: Named
517+
Default value: None
518+
Accept pipeline input: False
519+
Accept wildcard characters: False
520+
```
521+
499522
### -LogDirectoryPath
500523
The LogDirectoryPath parameter specifies the location of the log files. The default location is `%TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv`.
501524

@@ -678,9 +701,11 @@ Accept wildcard characters: False
678701
### -SkipLoadingCmdletHelp
679702
**Note**: This parameter is available in version 3.3.0 or later of the module.
680703

681-
The SkipLoadingCmdletHelp switch avoids downloading the cmdlet help files for REST API connections. You don't need to specify a value with this switch.
704+
In version 3.7.0-Preview1 or later, this parameter is replaced by the LoadCmdletHelp parameter. The SkipLoadingCmdletHelp parameter is no longer required and no longer does anything, because cmdlet help files are no longer downloaded by default. Eventually, this parameter will be retired, so remove it from any scripts.
705+
706+
The SkipLoadingCmdletHelp switch prevents downloading the cmdlet help files for the Get-Help cmdlet in REST API connections. You don't need to specify a value with this switch.
682707

683-
When you use this switch, you don't get local help files for any cmdlet.
708+
When you use this switch, you don't get local help files for any cmdlet at the command line.
684709

685710
This switch doesn't work with the UseRPSSession switch.
686711

@@ -698,7 +723,7 @@ Accept wildcard characters: False
698723
```
699724

700725
### -SkipLoadingFormatData
701-
The SkipLoadingFormatData switch avoids downloading the format data for REST API connections. You don't need to specify a value with this switch.
726+
The SkipLoadingFormatData switch prevents downloading the format data for REST API connections. You don't need to specify a value with this switch.
702727

703728
When you use this switch, the output of any Exchange cmdlet will be unformatted.
704729

‎exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md

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

‎exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
3+
Module Name: ExchangeOnlineManagement
4+
online version: https://learn.microsoft.com/powershell/module/exchange/remove-vivaorginsightsdelegatedrole
5+
title: Remove-VivaOrgInsightsDelegatedRole
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Remove-VivaOrgInsightsDelegatedRole
13+
14+
## SYNOPSIS
15+
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).
16+
17+
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).
18+
19+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
20+
21+
## SYNTAX
22+
23+
```
24+
Remove-VivaOrgInsightsDelegatedRole -Delegate <Guid> -Delegator <Guid>
25+
[-ResultSize <Unlimited>]
26+
[<CommonParameters>]
27+
```
28+
29+
## DESCRIPTION
30+
Use the Get-VivaOrgInsightsDelegatedRole 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+
- Insights Administrator
36+
37+
> [!IMPORTANT]
38+
> 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.
39+
40+
## EXAMPLES
41+
42+
### Example 1
43+
```powershell
44+
Remove-VivaOrgInsightsDelegatedRole -Delegate 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9
45+
```
46+
47+
This example removes the organization insights viewing capability of the specified delegator account from the specified delegate account.
48+
49+
## PARAMETERS
50+
51+
### -Delegate
52+
The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account).
53+
54+
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.
55+
56+
```yaml
57+
Type: Guid
58+
Parameter Sets: (All)
59+
Aliases:
60+
Applicable: Exchange Online
61+
62+
Required: True
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### -Delegator
70+
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.
71+
72+
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.
73+
74+
```yaml
75+
Type: Guid
76+
Parameter Sets: (All)
77+
Aliases:
78+
Applicable: Exchange Online
79+
80+
Required: True
81+
Position: Named
82+
Default value: None
83+
Accept pipeline input: False
84+
Accept wildcard characters: False
85+
```
86+
87+
### -ResultSize
88+
This parameter is reserved for internal Microsoft use.
89+
90+
```yaml
91+
Type: Unlimited
92+
Parameter Sets: (All)
93+
Aliases:
94+
Applicable: Exchange Online
95+
96+
Required: False
97+
Position: Named
98+
Default value: None
99+
Accept pipeline input: False
100+
Accept wildcard characters: False
101+
```
102+
103+
### CommonParameters
104+
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).
105+
106+
## INPUTS
107+
108+
## OUTPUTS
109+
110+
## NOTES
111+
112+
## RELATED LINKS

0 commit comments

Comments
 (0)