Skip to content

Commit 9ef94a6

Browse files
authored
Merge pull request #2 from MicrosoftDocs/master
merge master
2 parents 5c938b4 + c8609ff commit 9ef94a6

File tree

3,964 files changed

+64182
-44048
lines changed

Some content is hidden

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

3,964 files changed

+64182
-44048
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,6 @@ _themes*/
77
.local/
88

99
.openpublishing.buildcore.ps1
10+
**/node_modules
11+
12+
\.idea/

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,36 @@
1-
# Short URL: aka.ms/office-powershell
1+
**Short URL: aka.ms/office-powershell**
22

33
# Overview
4-
A repository to hold the help reference content for Office PowerShell cmdlets. The expert knowledge around Office PowerShell is distributed among customers, MVPs, partners, product teams, support, and other community members. Consumers also have various preferences when consuming knowledge such as a website, PowerShell Get-Help, Windows app, iOS app, Android app, and others. The following diagram illustrates the point.
4+
This repository holds reference content of Office PowerShell cmdlets for help purpose. The expert knowledge around Office PowerShell is distributed among customers, MVPs, partners, product teams, support, and other community members. Consumers have various preferences when consuming knowledge such as a website, PowerShell Get-Help, Windows app, iOS app, Android app, and others. The following diagram illustrates the point.
5+
56
![Contribution and Consumption model for Office PowerShell reference content](images/contrib-consumption-model.png)
67

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

1112
> 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.
1213
13-
# Quick Start
14+
## Quick Start
1415

15-
## Contribute using the GitHub website
16+
### Contribute using the GitHub website
1617

1718
[![Image of Quick Start video](images/edit_video_capture.jpg)](https://support.office.com/en-us/article/edit-powershell-cmdlet-in-github-dcd20227-3764-48ce-ad6e-763af8b48daf?ui=en-US&rs=en-US&ad=US)
1819

19-
1. Open your browser, log in to GitHub, and then navigate to https://github.com/microsoftdocs/office-docs-powershell
20+
1. Open your browser, log in to GitHub, and navigate to https://github.com/microsoftdocs/office-docs-powershell
2021
2. Browse to the file you want to edit. In this example, we will edit https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/teams/teams-ps/teams/New-Team.md and add a link in the Related Links section.
2122
3. Click the Edit icon which looks like a pencil in the upper right corner.
2223
![Image of Edit button on Github](images/edit_icon.png)
2324

24-
4. Your browser will then open the file in an edit window. We want to add a link. So we scroll down to the Related Links section and add the link in the correct format.
25+
4. Your browser will open the file in an edit window. To add a link, we scroll down to the Related Links section and add the link in the correct format.
2526
![Image of Edit button on Github](images/add_related_link.png)
2627

27-
**Note** Since you are likely not a maintainer of the Git repository, GitHub will automatically 'Fork' the project into your personal GitHub account. A fork is just an exact copy of the repository in your own account so that you have total access to make edits. You are now 'editing' a copy of the project in your own GitHub account. You can always find it again by looking at your GitHub Repositories in your GitHub Profile (drop-down from your name in the top right).
28+
**Note** Since you are likely not a maintainer of the Git repository, GitHub will automatically 'Fork' the project into your personal GitHub account. A fork is a copy of the repository in your git account. By forking, you can freely make edits without affecting the original repository. You can always find it again by looking at your GitHub Repositories in your GitHub Profile (drop-down from your name in the top right).
2829
![Image of Automatic Fork message on Github](images/auto_fork.png)
2930

3031
5. You can click the Preview changes link to see what the changes will look like.
3132

32-
**IMPORTANT** The layout of headings and subheadings must follow a very specific schema that is required for PowerShell Get-Help.
33+
**IMPORTANT** The layout of headings and subheadings must follow a schema required for PowerShell Get-Help.
3334
Any deviation will throw errors in the Pull Request. The schema can be found here: https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md
3435

3536
6. Once you are satisfied with your work, go to the **Propose file change** area at the bottom of the topic. Enter a title and other description information, and then click **Propose file change**.
@@ -42,9 +43,9 @@ Looking for more in-depth content? Check out the following:
4243
* [Using more advanced tools with the PowerShell GitHub repo](repo_docs/ADVANCED.md)
4344
* [Creating content for brand new cmdlets](repo_docs/NEW_CMDLETS.md)
4445

45-
# Microsoft Open Source Code of Conduct
46+
## Microsoft Open Source Code of Conduct
4647

47-
## Contributing
48+
### Contributing
4849

4950
This project welcomes contributions and suggestions. Most contributions require you to agree to a
5051
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us

exchange/docfx.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
},
6868
"fileMetadata": {
6969
"apiPlatform":{
70-
"exchange-ps/exchange" : [ "PowerShell" ]
70+
"exchange-ps/exchange/**/*.md" : [ "powershell" ]
7171
}
7272
},
7373
"template": [],

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

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ localization_priority: Priority
1111
ms.collection: Strat_EX_Admin
1212
ms.custom:
1313
ms.assetid: c8bea338-6c1a-4bdf-8de0-7895d427ee5b
14+
search.appverid: MET150
1415
description: "Learn how to use remote PowerShell to connect to Exchange Online."
1516
---
1617

@@ -46,9 +47,9 @@ Exchange Online PowerShell allows you to manage your Exchange Online settings fr
4647

4748
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 (a Windows PowerShell window you open by selecting **Run as administrator**):
4849

49-
```
50-
Set-ExecutionPolicy RemoteSigned
51-
```
50+
```
51+
Set-ExecutionPolicy RemoteSigned
52+
```
5253

5354
You need to configure this setting only once on your computer, not every time you connect.
5455

@@ -59,9 +60,10 @@ Exchange Online PowerShell allows you to manage your Exchange Online settings fr
5960

6061
1. On your local computer, open Windows PowerShell and run the following command.
6162

62-
```
63-
$UserCredential = Get-Credential
64-
```
63+
```
64+
$UserCredential = Get-Credential
65+
```
66+
6567
In the **Windows PowerShell Credential Request** dialog box, type your work or school account and password, and then click **OK**.
6668

6769
2. Run the following command.
@@ -70,23 +72,25 @@ Exchange Online PowerShell allows you to manage your Exchange Online settings fr
7072
$Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection
7173
```
7274

73-
**Notes**:
75+
**Notes**:
7476

75-
- For Office 365 operated by 21Vianet, use the _ConnectionUri_ value: `https://partner.outlook.cn/PowerShell`
77+
- For Office 365 operated by 21Vianet, use the _ConnectionUri_ value: `https://partner.outlook.cn/PowerShell`
7678

77-
- For Office 365 Germany, use the _ConnectionUri_ value: `https://outlook.office.de/powershell-liveid/`
79+
- For Office 365 Germany, use the _ConnectionUri_ value: `https://outlook.office.de/powershell-liveid/`
7880

79-
- If you're behind a proxy server, run this command first: `$ProxyOptions = New-PSSessionOption -ProxyAccessType `, where the _ProxyAccessType_ value is `IEConfig`, `WinHttpConfig`, or `AutoDetect`.
81+
- For Office 365 Government Community Cloud High (GCC High), use the _ConnectionUri_ value: `https://outlook.office365.us/powershell-liveid/`
82+
83+
- If you're behind a proxy server, run this command first: `$ProxyOptions = New-PSSessionOption -ProxyAccessType `, where the _ProxyAccessType_ value is `IEConfig`, `WinHttpConfig`, or `AutoDetect`.
8084

81-
Then, add the following parameter and value to the end of the $Session = ... command: `-SessionOption $ProxyOptions`.
85+
Then, add the following parameter and value to the end of the $Session = ... command: `-SessionOption $ProxyOptions`.
8286

83-
For more information, see [New-PSSessionOption](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/new-pssessionoption).
87+
For more information, see [New-PSSessionOption](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/new-pssessionoption).
8488

8589
3. Run the following command.
8690

87-
```
88-
Import-PSSession $Session -DisableNameChecking
89-
```
91+
```
92+
Import-PSSession $Session -DisableNameChecking
93+
```
9094

9195
> [!NOTE]
9296
> 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.
@@ -107,7 +111,7 @@ If you receive errors, check the following requirements:
107111

108112
- 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).
109113

110-
- 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.
114+
- 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.
111115

112116
## See also
113117

@@ -123,4 +127,4 @@ The cmdlets that you use in this topic are Windows PowerShell cmdlets. For more
123127

124128
- [Set-ExecutionPolicy](https://go.microsoft.com/fwlink/p/?LinkId=389623)
125129

126-
130+
For more information about managing Office 365, see [Manage Office 365](https://docs.microsoft.com/Office365/).

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,15 @@ ms.topic: article
88
ms.service: exchange-online
99
localization_priority: Normal
1010
ms.assetid: 04dae4ce-34a7-49c5-bf75-11e72452e04a
11+
search.appverid: MET150
1112
description: "Learn how to connect to Exchange Online PowerShell by using multi-factor authentication (MFA)."
1213
---
1314

1415
# Connect to Exchange Online PowerShell using multi-factor authentication
1516
If you want to use multi-factor authentication (MFA) to connect to Exchange Online PowerShell, you can't use the instructions at [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) to use remote PowerShell to connect to Exchange Online. MFA requires you to install the Exchange Online Remote PowerShell Module, and use the **Connect-EXOPSSession** cmdlet to connect.
1617

1718
> [!NOTE]
18-
> You can't use the Exchange Online Remote PowerShell Module to connect to Exchange Online PowerShell and Security & Compliance Center PowerShell in the same session (window). You need to use separate sessions of the Exchange Online Remote PowerShell Module.
19+
> You can't use the Exchange Online Remote PowerShell Module to connect to Exchange Online PowerShell and Security & Compliance Center PowerShell in the same session (window). You need to use separate sessions of the Exchange Online Remote PowerShell Module. <br/>• Delegated Access Permission (DAP) partners can't use the procedures in this topic to connect to their customer tenant organizations in Exchange Online PowerShell. MFA and the Exchange Online Remote PowerShell Module don't work with delegated authentication.
1920
2021
## What do you need to know before you begin?
2122

@@ -39,7 +40,9 @@ If you want to use multi-factor authentication (MFA) to connect to Exchange Onli
3940

4041
- The Exchange Online Remote PowerShell Module needs to be installed on your computer:
4142

42-
1. In Internet Explorer or Edge, open the Exchange admin center (EAC) for your Exchange Online organization (Google Chrome or Mozilla Firefox won't work). For instructions, see [Exchange Admin Center in Exchange Online](http://technet.microsoft.com/library/ace44f6b-4084-4f9c-89b3-e0317962472b.aspx).
43+
1. In Internet Explorer or Edge, open the Exchange admin center (EAC) for your Exchange Online organization. For instructions, see [Exchange Admin Center in Exchange Online](http://technet.microsoft.com/library/ace44f6b-4084-4f9c-89b3-e0317962472b.aspx).
44+
45+
**Note**: A browser that uses ClickOnce to download (like Internet Explorer or Edge) is needed to complete the next step.
4346

4447
2. In the EAC, go to **Hybrid** > **Setup** and click the appropriate **Configure** button to download the Exchange Online Remote PowerShell Module for multi-factor authentication.
4548

exchange/docs-conceptual/exchange-online/disable-access-to-exchange-online-powershell.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@ title: "Enable or disable access to Exchange Online PowerShell"
33
ms.author: chrisda
44
author: chrisda
55
manager: serdars
6-
ms.date: 2/20/2018
6+
ms.date:
77
ms.audience: Admin
88
ms.topic: article
99
ms.service: exchange-online
1010
localization_priority: Normal
1111
ms.assetid: f969816a-2607-4655-9d47-9e8767fb5633
12+
search.appverid: MET150
1213
description: "Admins can learn how to enable or disable access to Exchange Online PowerShell for users in their organization"
1314
---
1415

@@ -58,7 +59,7 @@ $ = -ResultSize unlimited -Filter
5859
```
5960

6061
```
61-
$ | foreach {Set-User -RemotePowerShellEnabled $false}
62+
$ | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false}
6263
```
6364

6465
This example removes access to Exchange Online PowerShell for all users whose **Title** attribute contains the value "Sales Associate".
@@ -68,7 +69,7 @@ $DSA = Get-User -ResultSize unlimited -Filter {(RecipientType -eq 'UserMailbox')
6869
```
6970

7071
```
71-
$DSA | foreach {Set-User -RemotePowerShellEnabled $false}
72+
$DSA | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false}
7273
```
7374

7475
### Use a list of specific users
@@ -80,10 +81,10 @@ $ = Get-Content
8081
```
8182

8283
```
83-
$ | foreach {Set-User -RemotePowerShellEnabled $false}
84+
$ | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false}
8485
```
8586

86-
This example uses the text file C:\My Documents\NoPowerShell.txt to identify the users by their email addresses. The text file must contain one email address on each line as follows:
87+
This example uses the text file C:\My Documents\NoPowerShell.txt to identify the users by their accounts. The text file must contain one account on each line as follows:
8788

8889
```
8990
@@ -98,7 +99,7 @@ $NPS = Get-Content "C:\My Documents\NoPowerShell.txt"
9899
```
99100

100101
```
101-
$NPS | foreach {Set-User -RemotePowerShellEnabled $false}
102+
$NPS | foreach {Set-User -Identity $_.MicrosoftOnlineServicesID -RemotePowerShellEnabled $false}
102103
```
103104

104105
## View the Exchange Online PowerShell access for users

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ ms.topic: article
99
ms.service: exchange-online
1010
localization_priority: Normal
1111
ms.assetid: 1cb603b0-2961-4afe-b879-b048fe0f64a2
12+
search.appverid: MET150
1213
description: "Learn about using PowerShell in Exchange Online"
1314
---
1415

0 commit comments

Comments
 (0)