You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2.md
+32-18Lines changed: 32 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -28,11 +28,11 @@ When you report an issue, be sure to include the log files in your email message
28
28
29
29
To generate the log files, replace \<Path to store log file\> with the output folder you want, and run the following command:
30
30
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
+
```
34
34
35
-
## What's new in the EXO V2 module?
35
+
## How the EXO V2 module works
36
36
37
37
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.
38
38
@@ -58,7 +58,7 @@ The new cmdlets in the EXO V2 module are listed in the following table:
58
58
You can download the EXO V2 module from the PowerShell gallery [here](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/).
59
59
60
60
> [!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.
62
62
63
63
### What do you need to know before you begin?
64
64
@@ -82,7 +82,7 @@ You can download the EXO V2 module from the PowerShell gallery [here](https://ww
82
82
83
83
<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).
84
84
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**:
86
86
87
87
```
88
88
winrm get winrm/config/client/auth
@@ -94,19 +94,27 @@ You can download the EXO V2 module from the PowerShell gallery [here](https://ww
94
94
winrm set winrm/config/client/auth @{Basic="true"}
95
95
```
96
96
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:
98
98
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.
100
100
101
101
### Install the EXO V2 module
102
102
103
103
To install the EXO V2 module for the first time, run the following commands:
104
104
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**):
106
106
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
+
```
110
118
111
119
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:
112
120
@@ -116,13 +124,15 @@ To install the EXO V2 module for the first time, run the following commands:
116
124
117
125
**Notes**:
118
126
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).
120
128
121
129
- If you don't do this step, you'll receive the following error when you try to connect:
122
130
123
131
> Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files.
124
132
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:
126
136
127
137
```PowerShell
128
138
Install-Module -Name ExchangeOnlineManagement
@@ -132,7 +142,7 @@ To install the EXO V2 module for the first time, run the following commands:
132
142
133
143
### Update the EXO V2 module
134
144
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.
136
146
137
147
1. To see the version of the EXO V2 module that's currently installed, run the following commands:
138
148
@@ -148,6 +158,12 @@ If the EXO V2 module is already installed on your computer, you can run the foll
148
158
149
159
Enter **Y** to accept the license agreement.
150
160
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
+
151
167
3. To confirm that the update was successful, run the following commands:
For detailed syntax and parameter information, see [Connect-ExchangeOnline](https://docs.microsoft.com/powershell/module/exchange/powershell-v2-module/connect-exchangeonline).
196
212
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
200
214
201
215
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.
0 commit comments