Skip to content

Commit c457aa7

Browse files
authored
Merge pull request #10890 from MicrosoftDocs/P4-chrisda
P4-chrisda to Main
2 parents 90555f2 + 4a32b87 commit c457aa7

7 files changed

+54
-70
lines changed

exchange/docs-conceptual/connect-to-scc-powershell.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To use the older Exchange Online Remote PowerShell Module (the V1 module) to con
3535

3636
> [!NOTE]
3737
>
38-
> If you're using version 3.2.0-Preview3 of the module, and you use `-UseRPSSession:$false` in the **Connect-IPPSSession** command, you have access to REST API cmdlets _only_. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module).
38+
> If you're using version 3.2.0-Preview4 or later of the module, and you don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command, you have access to REST API cmdlets _only_. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module).
3939
4040
- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Microsoft 365 Defender portal](/microsoft-365/security/office-365-security/mdo-portal-permissions) and [Permissions in the Microsoft Purview compliance portal](/microsoft-365/compliance/microsoft-365-compliance-center-permissions).
4141

@@ -58,14 +58,14 @@ Import-Module ExchangeOnlineManagement
5858
The command that you need to run uses the following syntax:
5959

6060
```powershell
61-
Connect-IPPSSession -UserPrincipalName <UPN> [-ConnectionUri <URL>] [-UseRPSSession:$false] [-AzureADAuthorizationEndpointUri <URL>] [-DelegatedOrganization <String>] [-PSSessionOption $ProxyOptions]
61+
Connect-IPPSSession -UserPrincipalName <UPN> [-ConnectionUri <URL>] [-UseRPSSession] [-AzureADAuthorizationEndpointUri <URL>] [-DelegatedOrganization <String>] [-PSSessionOption $ProxyOptions]
6262
```
6363

6464
For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession).
6565

6666
- _\<UPN\>_ is your account in user principal name format (for example, `[email protected]`).
6767

68-
- In v3.2.0-Preview3 of the module, if you use `-UseRPSSession:$false` in the **Connect-IPPSSession** command, you connect in REST API mode. To connect in remote PowerShell mode, don't use the _UseRPSSession_ switch. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module).
68+
- In v3.2.0-Preview4 or later of the module, if you don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command, you connect in REST API mode. To connect in remote PowerShell mode, use the _UseRPSSession_ switch. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module).
6969

7070
- The required _ConnectionUri_ and _AzureADAuthorizationEndpointUri_ values depend on the nature of your Microsoft 365 organization. Common values are described in the following table:
7171

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves
4141

4242
- Cmdlets backed by the REST API are available in the following PowerShell environments based on the version of the EXO V3 module:
4343
- **Exchange Online PowerShell**: v3.0.0 or later.
44-
- **Security & Compliance PowerShell**: v3.2.0-Preview3 or later.
44+
- **Security & Compliance PowerShell**: v3.2.0-Preview4 or later.
4545

4646
REST API cmdlets have the following advantages over their historical counterparts:
4747

@@ -64,11 +64,9 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves
6464

6565
- In Exchange Online PowerShell, virtually all of the available remote PowerShell cmdlets are backed by the REST API.
6666

67-
In Exchange Online PowerShell, REST API connections are used by default. You need to use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command to access cmdlets in remote PowerShell mode.
67+
- In Security & Compliance Center PowerShell using v3.2.0-Preview4 or later of the module, many, but not all of the available remote PowerShell cmdlets are backed by the REST API.
6868

69-
- In Security & Compliance Center PowerShell using v3.2.0-Preview3 of the module, many of the available remote PowerShell cmdlets are backed by the REST API.
70-
71-
In Security & Compliance Center PowerShell, remote PowerShell connections are used by default. You need to use `-UseRPSSession:$false` to access cmdlets in REST API mode. This behavior will change to match **Connect-ExchangeOnline** in a later version of the module as more Security & Compliance cmdlets are available in REST API mode.
69+
- In Exchange Online PowerShell and in Security & Compliance PowerShell, REST API connections are used by default. You need to use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** or **Connect-IPPSSession** command to access cmdlets in remote PowerShell mode.
7270

7371
- Consider the following items if you connect to Exchange Online PowerShell or Security & Compliance PowerShell in remote PowerShell mode:
7472
- [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) is required on your client computer.

exchange/docs-conceptual/whats-new-in-the-exo-module.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,15 @@ description: "Learn about the new features and functionality available in the la
2222

2323
This article lists new features in the Exchange Online PowerShell module that's used for connecting to Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. Features that are currently in preview are denoted with **(preview)**.
2424

25+
## May 2023
26+
27+
- [Version 3.2.0-Preview4](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.2.0-Preview4) has been released.
28+
29+
This version supports the Preview of Security & Compliance cmdlets backed by the REST API. Some, but not all cmdlets are supported. Basic authentication in WinRM is not required in Security & Compliance PowerShell for REST API cmdlets.
30+
31+
> [!NOTE]
32+
> The default value of the _UseRPSSession_ switch in **Connect-IPSSession** is now the same as **Connect-ExchangeOnline**. To connect in REST API mode, don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command. To connect using remote PowerShell mode (which requires [Basic authentication in WinRM](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm)), use the _UseRPSSession_ switch in the **Connect-IPPSSession** command.
33+
2534
## April 2023
2635

2736
- [Version 3.2.0-Preview3](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.2.0-Preview3) has been released.

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

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.reviewer:
1515
## SYNOPSIS
1616
This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
1717

18-
Use the Connect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to connect to Exchange Online PowerShell or standalone Exchange Online Protection PowerShell using modern authentication. This cmdlet works for MFA or non-MFA enabled accounts.
18+
Use the Connect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to connect to Exchange Online PowerShell or standalone Exchange Online Protection PowerShell using modern authentication. This cmdlet works for accounts with or without multi-factor authentication (MFA).
1919

2020
To connect to Security & Compliance PowerShell, use the [Connect-IPPSSession](https://learn.microsoft.com/powershell/module/exchange/connect-ippssession) cmdlet.
2121

@@ -52,6 +52,7 @@ Connect-ExchangeOnline
5252
[-PageSize <UInt32>]
5353
[-ShowBanner]
5454
[-ShowProgress <Boolean>]
55+
[-SigningCertificate <X509Certificate2>]
5556
[-SkipLoadingFormatData]
5657
[-TrackPerformance <Boolean>]
5758
[-UseMultithreading <Boolean>]
@@ -656,6 +657,28 @@ Accept pipeline input: False
656657
Accept wildcard characters: False
657658
```
658659

660+
### -SigningCertificate
661+
**Note**: This parameter is available in version 3.2.0-Preview4 or later of the module.
662+
663+
The SigningCertificate parameter specifies the client certificate that's used to sign the format files (\*.Format.ps1xml) or script module files (.psm1) in the temporary module that Connect-ExchangeOnline creates.
664+
665+
A valid value for this parameter is a variable that contains the certificate, or a command or expression that gets the certificate.
666+
667+
To find the certificate, use the Get-PfxCertificate cmdlet in the Microsoft.PowerShell.Security module or use the Get-ChildItem cmdlet in the certificate (Cert:) drive. If the certificate isn't valid or doesn't have sufficient authority, the command will fail.
668+
669+
```yaml
670+
Type: X509Certificate2
671+
Parameter Sets: (All)
672+
Aliases:
673+
Applicable: Exchange Online
674+
675+
Required: False
676+
Position: Named
677+
Default value: None
678+
Accept pipeline input: False
679+
Accept wildcard characters: False
680+
```
681+
659682
### -SkipLoadingFormatData
660683
The SkipLoadingFormatData switch avoids downloading the format data for REST API connections. You don't need to specify a value with this switch.
661684

exchange/exchange-ps/exchange/Connect-IPPSSession.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This cmdlet is available only in the Exchange Online PowerShell module. For more
1717

1818
Use the Connect-IPPSSession cmdlet in the Exchange Online PowerShell module to connect to Security & Compliance PowerShell PowerShell using modern authentication. The cmdlet works for MFA or non-MFA enabled accounts.
1919

20-
**Note**: Version 3.2.0-Preview3 or later of the module supports REST API mode for most Security & Compliance PowerShell cmdlets (Basic authentication in WinRM on the local computer isn't required for REST API mode). For more information, see [Prerequisites for the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#prerequisites-for-the-exchange-online-powershell-module).
20+
**Note**: Version 3.2.0-Preview4 or later of the module supports REST API mode for most Security & Compliance PowerShell cmdlets (Basic authentication in WinRM on the local computer isn't required for REST API mode). For more information, see [Prerequisites for the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#prerequisites-for-the-exchange-online-powershell-module).
2121

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

@@ -55,15 +55,15 @@ For detailed connection instructions, including prerequisites, see [Connect to S
5555
Connect-IPPSSession -UserPrincipalName [email protected]
5656
```
5757

58-
This example connects to Security & Compliance PowerShell in a Microsoft 365 organization. You're prompted for the password of the [email protected] account. In v3.2.0-Preview3 of the module, we're connecting in remote PowerShell mode, so Basic authentication in WinRM is required on the local computer.
58+
This example connects to Security & Compliance PowerShell using the specified account and modern authentication, with or without MFA. In v3.2.0-Preview4 or later of the module, we're connecting in REST API mode, so Basic authentication in WinRM isn't required on the local computer.
5959

6060

6161
### Example 2
6262
```powershell
63-
Connect-IPPSSession -UserPrincipalName [email protected] -UseRPSSession:$false
63+
Connect-IPPSSession -UserPrincipalName [email protected] -UseRPSSession
6464
```
6565

66-
This example connects to Security & Compliance using modern authentication, with or without MFA. In v3.2.0-Preview3 of the module, we're connecting in REST API mode, so Basic authentication in WinRM isn't required on the local computer.
66+
This example connects to Security & Compliance PowerShell using the specified account and modern authentication, with or without MFA. In v3.2.0-Preview4 or later of the module, we're connecting in remote PowerShell mode, so Basic authentication in WinRM is required on the local computer.
6767

6868
### Example 3
6969
```powershell
@@ -396,11 +396,13 @@ Accept wildcard characters: False
396396
```
397397

398398
### -UseRPSSession
399-
This parameter is available in version 3.2.0-Preview3 or later of the module.
399+
This parameter is available in version 3.2.0-Preview4 or later of the module.
400400

401-
The UseRPSSession switch allows you to connect to Security & Compliance PowerShell using REST API mode. To connect to Security & Compliance PowerShell in REST API mode, use this exact syntax: `-UseRPSSession:$false`.
401+
The UseRPSSession switch allows you to connect to Security & Compliance PowerShell using traditional remote PowerShell access to all cmdlets. You don't need to specify a value with this switch.
402402

403-
If you don't use this switch, you connect in traditional remote PowerShell access mode, and Basic authentication in WinRM is required on your local computer. For more information, see [Prerequisites in the Exchange Online PowerShell module](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm).
403+
This switch requires that Basic authentication is enabled in WinRM on the local computer. For more information, see [Turn on Basic authentication in WinRM](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm).
404+
405+
If you don't use this switch, Basic authentication in WinRM is not required.
404406

405407
```yaml
406408
Type: SwitchParameter
@@ -410,7 +412,7 @@ Applicable: Exchange Online
410412
411413
Required: False
412414
Position: Named
413-
Default value: True
415+
Default value: False
414416
Accept pipeline input: False
415417
Accept wildcard characters: False
416418
```

exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha
2222
## SYNTAX
2323

2424
```
25-
Get-DefaultTenantMyAnalyticsFeatureConfig [-ResultSize <Unlimited]>] [<CommonParameters>]
25+
Get-DefaultTenantMyAnalyticsFeatureConfig [-ResultSize <Unlimited>] [<CommonParameters>]
2626
```
2727

2828
## DESCRIPTION
@@ -34,7 +34,7 @@ To run this cmdlet, you need to be a member of one of the following directory ro
3434
- Exchange Administrator
3535
- Insights Administrator
3636

37-
For more information, see, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).
37+
For more information, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).
3838

3939
## EXAMPLES
4040

@@ -72,8 +72,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
7272
7373
## NOTES
7474
75-
We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios.
76-
7775
## RELATED LINKS
7876
7977
[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide)

exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md

Lines changed: 3 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ For information about the parameter sets in the Syntax section below, see [Excha
2323

2424
```
2525
Set-DefaultTenantMyAnalyticsFeatureConfig
26-
[-PrivacyMode <String>]
2726
[-Feature <String>]
2827
[-IsEnabled <Boolean>]
2928
[-ResultSize <Unlimited>]
@@ -40,40 +39,25 @@ To run this cmdlet, you need to be a member of one of the following directory ro
4039
- Exchange Administrator
4140
- Insights Administrator
4241

43-
For more information, see, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).
42+
For more information, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).
4443

4544
## EXAMPLES
4645

4746
### Example 1
4847
```powershell
49-
Set-DefaultTenantMyAnalyticsFeatureConfig -PrivacyMode Opt-in
48+
Set-DefaultTenantMyAnalyticsFeatureConfig -Feature All -IsEnabled $true
5049
```
5150

5251
This example enables all available Viva Insights features for the organization: add-in, dashboard, digest email, meeting effectiveness survey, schedule send suggestions.
5352

5453
### Example 2
5554
```powershell
56-
Set-DefaultTenantMyAnalyticsFeatureConfig -Feature All -IsEnabled $true
57-
```
58-
59-
This example also enables all available Viva Insights features for the organization: add-in, dashboard, digest email, meeting effectiveness survey, schedule send suggestions.
60-
61-
### Example 3
62-
```powershell
6355
Set-DefaultTenantMyAnalyticsFeatureConfig -Feature Add-in -IsEnabled $false
6456
```
6557

6658
This example disables Viva Insight add-in feature for the organization.
6759

68-
### Example 4
69-
```powershell
70-
Set-DefaultTenantMyAnalyticsFeatureConfig -PrivacyMode Opt-out -Feature Add-in -IsEnabled $true
71-
```
72-
73-
This example enables the Viva Insight add-in feature for the organization while disabling the other features.
74-
75-
76-
### Example 5
60+
### Example 3
7761
```powershell
7862
Set-DefaultTenantMyAnalyticsFeatureConfig -Feature Meeting-Effectiveness-Survey-Sampling-Rate -SamplingRate 0.2
7963
```
@@ -126,34 +110,6 @@ Accept pipeline input: False
126110
Accept wildcard characters: False
127111
```
128112
129-
### -PrivacyMode
130-
The PrivacyMode parameter enables or disables all of the available Viva Insights features in this cmdlet:
131-
132-
- Add-in
133-
- Digest email
134-
- Dashboard
135-
- Meeting effectiveness survey
136-
- Schedule send suggestions
137-
138-
Valid values for this parameter are:
139-
140-
- Opt-in: The features are enabled.
141-
- Opt-out: The features are disabled.
142-
143-
```yaml
144-
Type: String
145-
Parameter Sets: (All)
146-
Aliases:
147-
Accepted values: Opt-in, Opt-out
148-
Applicable: Exchange Online
149-
150-
Required: False
151-
Position: Named
152-
Default value: None
153-
Accept pipeline input: False
154-
Accept wildcard characters: False
155-
```
156-
157113
### -ResultSize
158114
This parameter is reserved for internal Microsoft use.
159115
@@ -197,8 +153,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
197153
198154
## NOTES
199155
200-
We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios.
201-
202156
## RELATED LINKS
203157
204158
[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide)

0 commit comments

Comments
 (0)