Skip to content

Commit 3ba1b90

Browse files
committed
Update exchange-online-powershell-v2.md
Issue #4720
1 parent c3e2f93 commit 3ba1b90

File tree

1 file changed

+32
-18
lines changed

1 file changed

+32
-18
lines changed

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

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ When you report an issue, be sure to include the log files in your email message
2828

2929
To generate the log files, replace \<Path to store log file\> with the output folder you want, and run the following command:
3030

31-
```PowerShell
32-
Connect-ExchangeOnline -EnableErrorReporting -LogDirectoryPath <Path to store log file> -LogLevel All
33-
```
31+
```PowerShell
32+
Connect-ExchangeOnline -EnableErrorReporting -LogDirectoryPath <Path to store log file> -LogLevel All
33+
```
3434

35-
## What's new in the EXO V2 module?
35+
## How the EXO V2 module works
3636

3737
The Exchange Online PowerShell V2 module contains a small set of new cmdlets that are optimized for bulk data retrieval scenarios (think: thousands and thousands of objects). It also contains the 700 or more older remote PowerShell cmdlets baked into the same module. Note that after you install the EXO V2 module from the PowerShell Gallery, you only see new cmdlets in the module. You'll see the older remote PowerShell cmdlets after you create a session to connect to your Exchange Online environment. All the cmdlets in the V2 module use Modern auth for authentication. You can't use Basic auth in the EXO V2 module.
3838

@@ -58,7 +58,7 @@ The new cmdlets in the EXO V2 module are listed in the following table:
5858
You can download the EXO V2 module from the PowerShell gallery [here](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/).
5959

6060
> [!NOTE]
61-
> The latest version of PowerShell that's currently supported for the EXO V2 module is PowerShell 5.0. Support for PowerShell 6.0 or later is currently a work in progress and will be released soon. This also implies that EXO PowerShell V2 module won't work in Linux or Mac as of now. Support for Linux/Mac is a work in progress and will be announced soon.
61+
> The latest version of PowerShell that's currently supported for the EXO V2 module is PowerShell 5.1. Support for PowerShell 6.0 or later is currently a work in progress and will be released soon. This also implies that EXO PowerShell V2 module won't work in Linux or Mac as of now. Support for Linux and Mac is a work in progress and will be announced soon.
6262
6363
### What do you need to know before you begin?
6464

@@ -82,7 +82,7 @@ You can download the EXO V2 module from the PowerShell gallery [here](https://ww
8282

8383
<sup>\*</sup> For older versions of Windows, you need to install the Microsoft.NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Installing the .NET Framework](https://go.microsoft.com/fwlink/p/?LinkId=257868), [Windows Management Framework 3.0](https://go.microsoft.com/fwlink/p/?LinkId=272757), [Windows Management Framework 4.0](https://go.microsoft.com/fwlink/p/?LinkId=391344), and [Windows Management Framework 5.1](https://aka.ms/wmf5download).
8484

85-
- Windows Remote Management (WinRM) on your computer needs to allow basic authentication (it's enabled by default). To verify that basic authentication is enabled, run this command **in a Command Prompt**:
85+
- Windows Remote Management (WinRM) on your computer needs to allow Basic authentication (it's enabled by default). To verify that Basic authentication is enabled, run this command **in a Command Prompt**:
8686

8787
```
8888
winrm get winrm/config/client/auth
@@ -94,19 +94,27 @@ You can download the EXO V2 module from the PowerShell gallery [here](https://ww
9494
winrm set winrm/config/client/auth @{Basic="true"}
9595
```
9696

97-
If basic authentication is disabled, you'll get this error when you try to connect:
97+
If Basic authentication is disabled, you'll get this error when you try to connect:
9898

99-
`The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again.`
99+
> The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again.
100100
101101
### Install the EXO V2 module
102102

103103
To install the EXO V2 module for the first time, run the following commands:
104104

105-
1. On your local computer, run the following command from an elevated Windows PowerShell session (a Windows PowerShell window you open by selecting **Run as administrator**):
105+
1. On your local computer, run the **one** of the following commands from an elevated Windows PowerShell session (a Windows PowerShell window you open by selecting **Run as administrator**):
106106

107-
```PowerShell
108-
Install-Module PowershellGet -Force
109-
```
107+
- Install the PowerShellGet module for the first time *or* run your current version of the PowerShellGet module side-by-side with the latest version:
108+
109+
```PowerShell
110+
Install-Module PowershellGet -Force
111+
```
112+
113+
- Update your existing version of the PowerShellGet module to the latest version:
114+
115+
```PowerShell
116+
Update-Module PowershellGet
117+
```
110118
111119
2. Windows PowerShell needs to be configured to run scripts, and by default, it isn't. To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated Windows PowerShell window:
112120
@@ -116,13 +124,15 @@ To install the EXO V2 module for the first time, run the following commands:
116124

117125
**Notes**:
118126

119-
- You need to configure this setting only once on your computer. Read more about execution policies [here](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_execution_policies)
127+
- You need to configure this setting only once on your computer. Read more about execution policies [here](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_execution_policies).
120128

121129
- If you don't do this step, you'll receive the following error when you try to connect:
122130

123131
> Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files.
124132
125-
3. From an elevated Windows PowerShell session and run the following command:
133+
3. Close and re-open the elevated Windows PowerShell window to get the changes from the previous steps.
134+
135+
4. Run the following command from an elevated Windows PowerShell window:
126136

127137
```PowerShell
128138
Install-Module -Name ExchangeOnlineManagement
@@ -132,7 +142,7 @@ To install the EXO V2 module for the first time, run the following commands:
132142

133143
### Update the EXO V2 module
134144

135-
If the EXO V2 module is already installed on your computer, you can run the following commands to see the version that's currently installed and update it if necessary.
145+
If the EXO V2 module is already installed on your computer, you can run the following commands to see the version that's currently installed and update it to the latest version.
136146

137147
1. To see the version of the EXO V2 module that's currently installed, run the following commands:
138148

@@ -148,6 +158,12 @@ If the EXO V2 module is already installed on your computer, you can run the foll
148158

149159
Enter **Y** to accept the license agreement.
150160

161+
**Note**: If you receive the following error related to the PowerShellGet module, see Step 1 in the previous [Install the EXO V2 module](#install-the-exo-v2-module) section to update the PowerShellGet module to the latest version.
162+
163+
> The specified module 'ExchangeOnlineManagement' with PowerShellGetFormatVersion '\<version\>' is not supported by the current version of PowerShellGet. Get the latest version of the PowerShellGet module to install this module, 'ExchangeOnlineManagement'.
164+
165+
If you need to update the PowerShellGet module, be sure to close and re-open the Windows PowerShell window before you attempt to update the ExchangeOnlineManagement module.
166+
151167
3. To confirm that the update was successful, run the following commands:
152168

153169
```PowerShell
@@ -194,9 +210,7 @@ Uninstall-Module -Name ExchangeOnlineManagement
194210
195211
For detailed syntax and parameter information, see [Connect-ExchangeOnline](https://docs.microsoft.com/powershell/module/exchange/powershell-v2-module/connect-exchangeonline).
196212
197-
## What's new in the EXO V2 module?
198-
199-
### Properties and property sets
213+
## Properties and property sets in the EXO V2 module
200214
201215
The output of traditional Exchange Online cmdlets returns all possible object properties, including many properties that are often blank, or aren't even required in many scenarios. Returning a large number of blank and unnecessary properties causes degraded performance (more server computation and added network load). The full complement of properties are rarely required in the cmdlet output.
202216

0 commit comments

Comments
 (0)