Skip to content

Commit 4ec4cdb

Browse files
committed
Merge branch 'master' into ATPDocs
2 parents 43b2187 + 9fa49bf commit 4ec4cdb

File tree

355 files changed

+6874
-2500
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

355 files changed

+6874
-2500
lines changed

.gitattributes

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Set the default behavior, in case people don't have core.autocrlf set.
2+
* text=auto
3+
4+
# Explicitly declare text files you want to always be normalized and converted
5+
# to native line endings on checkout.
6+
*.c text
7+
*.h text
8+
9+
# Declare files that will always have CRLF line endings on checkout.
10+
*.sln text eol=crlf
11+
12+
# Denote all files that are truly binary and should not be modified.
13+
*.png binary
14+
*.jpg binary

.openpublishing.publish.config.json

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,35 @@
174174
"mapping/monikerMapping.json"
175175
]
176176
},
177+
{
178+
"docset_name": "spmt-ps",
179+
"build_source_folder": "spmt",
180+
"build_output_subfolder": "spmt-ps",
181+
"locale": "en-us",
182+
"monikers": [],
183+
"moniker_ranges": [],
184+
"open_to_public_contributors": true,
185+
"type_mapping": {
186+
"Conceptual": "Content",
187+
"ManagedReference": "Content",
188+
"RestApi": "Content",
189+
"AzurePsModulePage": "Content"
190+
},
191+
"build_entry_point": "docs",
192+
"template_folder": "_themes",
193+
"version": 0,
194+
"customized_template_paths": [
195+
"_dependentPackages/azurecli.plugins/azurecli"
196+
],
197+
"customized_tasks": {
198+
"docset_prebuild": [
199+
"_dependentPackages/CommonPlugins/tools/PowerShellReference.ps1"
200+
]
201+
},
202+
"monikerPath": [
203+
"mapping/monikerMapping.json"
204+
]
205+
},
177206
{
178207
"docset_name": "whiteboard-ps",
179208
"build_source_folder": "whiteboard",

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A repository to hold the help reference content for Office PowerShell cmdlets. T
55
![Contribution and Consumption model for Office PowerShell reference content](images/contrib-consumption-model.png)
66

77
# Learn How To Contribute
8-
Anyone who is interested can contribute to the Microsoft Office PowerShell reference topics.
8+
Anyone who is interested can contribute to the Microsoft Office PowerShell reference topics.
99
When you contribute your work will go directly into the Microsoft Office products and show up in Get-Help for the given Office cmdlet.
1010

1111
> Notice that if you are looking into contributing for the **PnP PowerShell cmdlets**, their documentation is automatically generated from the code and you should be submitting your change towards the original code at https://github.com/SharePoint/PnP-powershell. See for example how the attributes are used in the code for the [Get-PnPList](https://github.com/SharePoint/PnP-PowerShell/blob/master/Commands/Lists/GetList.cs) cmdlet.
@@ -73,4 +73,4 @@ Microsoft's general trademark guidelines can be found at http://go.microsoft.com
7373
Privacy information can be found at https://privacy.microsoft.com/en-us/
7474

7575
Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents,
76-
or trademarks, whether by implication, estoppel or otherwise.
76+
or trademarks, whether by implication, estoppel or otherwise.

exchange/docs-conceptual/exchange-eop/connect-to-exchange-online-protection-powershell.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -15,66 +15,66 @@ description: "Use remote PowerShell to connect to an Exchange Online Protection
1515
# Connect to Exchange Online Protection PowerShell
1616

1717
Exchange Online Protection PowerShell allows you to manage your Exchange Online Protection settings from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to Exchange Online Protection. It's a simple three-step process where you enter your Office 365 credentials, provide the required connection settings, and then import the Exchange Online Protection cmdlets into your local Windows PowerShell session so that you can use them.
18-
18+
1919
## What do you need to know before you begin?
2020

2121
- Estimated time to complete: 5 minutes
22-
22+
2323
- You can use the following versions of Windows:
24-
24+
2525
- Windows 10
26-
26+
2727
- Windows 8.1
28-
28+
2929
- Windows Server 2016
30-
30+
3131
- Windows Server 2012 or Windows Server 2012 R2
32-
33-
- Windows 7 Service Pack 1 (SP1)\*
34-
35-
- Windows Server 2008 R2 SP1\*
36-
37-
\* You need to install the Microsoft.NET Framework 4.5 or later and then either the Windows Management Framework 3.0 or the Windows Management Framework 4.0. For more information, see [Installing the .NET Framework](https://go.microsoft.com/fwlink/p/?LinkId=257868) and [Windows Management Framework 3.0](https://go.microsoft.com/fwlink/p/?LinkId=272757) or [Windows Management Framework 4.0](https://go.microsoft.com/fwlink/p/?LinkId=391344).
38-
39-
- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You get the following error when you try to connect:
40-
41-
`Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files.`
42-
32+
33+
- Windows 7 Service Pack 1 (SP1)<sup>*</sup>
34+
35+
- Windows Server 2008 R2 SP1<sup>*</sup>
36+
37+
<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).
38+
39+
- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect:
40+
41+
`Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files.`
42+
4343
To enable Windows PowerShell to run signed scripts, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**):
44-
45-
```
46-
Set-ExecutionPolicy RemoteSigned
47-
```
44+
45+
```
46+
Set-ExecutionPolicy RemoteSigned
47+
```
4848
4949
You need to configure this setting only once on your computer, not every time you connect.
50-
50+
5151
> [!TIP]
52-
> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612), [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351).
53-
52+
> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612), [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351).
53+
5454
## Connect to Exchange Online Protection
5555
5656
1. On your local computer, open Windows PowerShell and run the following command:
57-
58-
```
59-
$UserCredential = Get-Credential
60-
```
57+
58+
```
59+
$UserCredential = Get-Credential
60+
```
6161
6262
In the **Windows PowerShell Credential Request** dialog box, type your work or school account and password, and then click **OK**.
63-
63+
6464
2. Run the following command:
65-
65+
6666
```
6767
$Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection
6868
```
6969
70-
**Notes**:
71-
72-
- For Office 365 Germany, use the _ConnectionUri_ value: `https://ps.protection.outlook.de/powershell-liveid/`
73-
74-
- For Exchange Online Protection subscriptions that are Exchange Enterprise CAL with Services (includes data loss prevention (DLP) and reporting using web services), use the _ConnectionUri_ value: `https://outlook.office365.com/powershell-liveid/`
75-
70+
**Notes**:
71+
72+
- For Office 365 Germany, use the _ConnectionUri_ value: `https://ps.protection.outlook.de/powershell-liveid/`
73+
74+
- For Exchange Online Protection subscriptions that are Exchange Enterprise CAL with Services (includes data loss prevention (DLP) and reporting using web services), use the _ConnectionUri_ value: `https://outlook.office365.com/powershell-liveid/`
75+
7676
3. Run the following command:
77-
77+
7878
```
7979
Import-PSSession $Session
8080
```
@@ -93,27 +93,27 @@ After Step 3, the Exchange Online Protection cmdlets are imported into your loca
9393
If you receive errors, check the following requirements:
9494
9595
- A common problem is an incorrect password. Run the three steps again and pay close attention to the user name and password you enter in Step 1.
96-
96+
9797
- To help prevent denial-of-service (DoS) attacks, you're limited to three open remote PowerShell connections to your Exchange Online Protection organization.
98-
98+
9999
- TCP port 80 traffic needs to be open between your local computer and Office 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy.
100100
101101
- The **New-PSSession** command (Step 2) might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this:
102102
103-
`The request for the Windows Remote Shell with ShellId <ID> failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation.`
103+
`The request for the Windows Remote Shell with ShellId <ID> failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation.`
104104
105-
To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Exchange Online Protection PowerShell endpoint.
105+
To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Exchange Online Protection PowerShell endpoint.
106106
107107
## See also
108108
109109
The cmdlets that you use in this topic are Windows PowerShell cmdlets. For more information about these cmdlets, see the following topics.
110110
111111
- [Get-Credential](https://go.microsoft.com/fwlink/p/?LinkId=389618)
112-
112+
113113
- [New-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389621)
114-
114+
115115
- [Import-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389619)
116-
116+
117117
- [Remove-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389620)
118-
118+
119119
- [Set-ExecutionPolicy](https://go.microsoft.com/fwlink/p/?LinkId=389623)

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

Lines changed: 49 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -16,106 +16,105 @@ description: "Learn how to use remote PowerShell to connect to Exchange Online."
1616

1717
# Connect to Exchange Online PowerShell
1818
Exchange Online PowerShell allows you to manage your Exchange Online settings from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to Exchange Online. It's a simple three-step process where you enter your Office 365 credentials, provide the required connection settings, and then import the Exchange Online cmdlets into your local Windows PowerShell session so that you can use them.
19-
19+
2020
> [!IMPORTANT]
2121
> If you want to use multi-factor authentication (MFA) to connect to Exchange Online PowerShell, you need to download and use the Exchange Online Remote PowerShell Module. For more information, see [Connect to Exchange Online PowerShell using multi-factor authentication](mfa-connect-to-exchange-online-powershell.md). If you're an Exchange Online Protection (EOP) standalone customer, and you're using the service to protect on-premises mailboxes, use the connection instructions in the topic [Connect to Exchange Online Protection PowerShell](../../exchange-eop/connect-to-exchange-online-protection-powershell.md). If your EOP subscription is Exchange Enterprise CAL with Services (includes data loss prevention (DLP) and reporting using web services), the connection instructions in this topic will work for you.
22-
22+
2323
## What do you need to know before you begin?
2424

2525
- Estimated time to complete: 5 minutes
26-
26+
2727
- You can use the following versions of Windows:
28-
28+
2929
- Windows 10
30-
30+
3131
- Windows 8.1
32-
32+
3333
- Windows Server 2016
34-
34+
3535
- Windows Server 2012 or Windows Server 2012 R2
36-
37-
- Windows 7 Service Pack 1 (SP1)\*
38-
39-
- Windows Server 2008 R2 SP1\*
40-
41-
\* You need to install the Microsoft.NET Framework 4.5 or later and then either the Windows Management Framework 3.0 or the Windows Management Framework 4.0. For more information, see [Installing the .NET Framework](https://go.microsoft.com/fwlink/p/?LinkId=257868) and[Windows Management Framework 3.0](https://go.microsoft.com/fwlink/p/?LinkId=272757) or[Windows Management Framework 4.0](https://go.microsoft.com/fwlink/p/?LinkId=391344).
42-
43-
- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You get the following error when you try to connect:
44-
45-
`Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files.`
46-
47-
To enable Windows PowerShell to run signed scripts, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**):
48-
36+
37+
- Windows 7 Service Pack 1 (SP1)<sup>*</sup>
38+
39+
- Windows Server 2008 R2 SP1<sup>*</sup>
40+
41+
<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).
42+
43+
- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect:
44+
45+
`Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files.`
46+
47+
To enable Windows PowerShell to run signed scripts, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**):
48+
4949
```
5050
Set-ExecutionPolicy RemoteSigned
5151
```
5252

53-
You need to configure this setting only once on your computer, not every time you connect.
54-
55-
53+
You need to configure this setting only once on your computer, not every time you connect.
54+
5655
> [!TIP]
5756
> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351).
58-
57+
5958
## Connect to Exchange Online PowerShell
6059

6160
1. On your local computer, open Windows PowerShell and run the following command.
62-
61+
6362
```
6463
$UserCredential = Get-Credential
6564
```
6665
In the **Windows PowerShell Credential Request** dialog box, type your work or school account and password, and then click **OK**.
67-
66+
6867
2. Run the following command.
69-
68+
7069
```
71-
$Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection
70+
$Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection
7271
```
7372
7473
**Notes**:
75-
76-
- For Office 365 operated by 21Vianet, use the _ConnectionUri_ value: `https://partner.outlook.cn/PowerShell`
77-
78-
- For Office 365 Germany, use the _ConnectionUri_ value: `https://outlook.office.de/powershell-liveid/`
79-
74+
75+
- For Office 365 operated by 21Vianet, use the _ConnectionUri_ value: `https://partner.outlook.cn/PowerShell`
76+
77+
- For Office 365 Germany, use the _ConnectionUri_ value: `https://outlook.office.de/powershell-liveid/`
78+
8079
3. Run the following command.
81-
80+
8281
```
8382
Import-PSSession $Session
8483
```
8584
8685
> [!NOTE]
8786
> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command.
88-
89-
```
90-
Remove-PSSession $Session
91-
```
87+
88+
```
89+
Remove-PSSession $Session
90+
```
9291
9392
## How do you know this worked?
9493
9594
After Step 3, the Exchange Online cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online cmdlet, for example, **Get-Mailbox**, and see the results.
96-
95+
9796
If you receive errors, check the following requirements:
98-
97+
9998
- A common problem is an incorrect password. Run the three steps again and pay close attention to the user name and password you enter in Step 1.
100-
99+
101100
- To help prevent denial-of-service (DoS) attacks, you're limited to three open remote PowerShell connections to your Exchange Online organization.
102-
101+
103102
- The account you use to connect to Exchange Online must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](../disable-access-to-exchange-online-powershell.md).
104-
103+
105104
- TCP port 80 traffic needs to be open between your local computer and Office 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy.
106-
105+
107106
## See also
108107
109108
The cmdlets that you use in this topic are Windows PowerShell cmdlets. For more information about these cmdlets, see the following topics.
110-
109+
111110
- [Get-Credential](https://go.microsoft.com/fwlink/p/?LinkId=389618)
112-
111+
113112
- [New-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389621)
114-
113+
115114
- [Import-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389619)
116-
115+
117116
- [Remove-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389620)
118-
117+
119118
- [Set-ExecutionPolicy](https://go.microsoft.com/fwlink/p/?LinkId=389623)
120-
119+
121120

0 commit comments

Comments
 (0)