Skip to content

Commit b5d6e79

Browse files
committed
Merge branch 'main' into FlowID-chrisda
2 parents e225d93 + 0b3ebd6 commit b5d6e79

File tree

10 files changed

+743
-82
lines changed

10 files changed

+743
-82
lines changed

README.md

Lines changed: 20 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,46 @@
11
# Overview
22

3-
**Short URL**: <https://aka.ms/office-powershell>
3+
## Learn how to contribute
44

5-
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.
6-
7-
![Contribution and Consumption model for Office PowerShell reference content.](images/contrib-consumption-model.png)
8-
9-
## Learn How To Contribute
10-
11-
Anyone who is interested can contribute to the Microsoft Office PowerShell reference topics. Your contributions will go directly into the Microsoft Office products and show up in Get-Help for the given Office cmdlet.
12-
13-
> [!NOTE]
14-
> If you're interested in contributing to the **PnP PowerShell** cmdlets, their documentation is automatically generated from 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 code for the [Get-PnPList](https://github.com/SharePoint/PnP-PowerShell/blob/master/Commands/Lists/GetList.cs) cmdlet.
15-
16-
## Quick Start
17-
18-
Contributors who only make infrequent or small updates can edit the file directly on GitHub.com without having to install any additional software. This article shows you how.
19-
20-
This brief video also covers how to contribute:
21-
22-
[![Image of Quick Start video.](images/edit_video_capture.jpg)](https://support.office.com/article/edit-powershell-cmdlet-in-github-dcd20227-3764-48ce-ad6e-763af8b48daf)
5+
Anyone who is interested can contribute to the topics. When you contribute, your work will go directly into the content set after being merged. It will then be published to [Microsoft Learn](https://learn.microsoft.com/) and you will be listed as a contributor at: <https://github.com/MicrosoftDocs/office-docs-powershell/graphs/contributors>.
236

247
### Quickly update an article using GitHub.com
258

9+
Contributors who only make infrequent or small updates can edit the file directly on GitHub.com without having to install any additional software. This article shows you how. [This two-minute video](https://www.microsoft.com/videoplayer/embed/RE1XQTG) also covers how to contribute.
10+
2611
1. Make sure you're signed in to GitHub.com with your GitHub account.
27-
2. Go to the page you want to edit on learn.microsoft.com.
12+
2. Browse to the page you want to edit on Microsoft Learn.
2813
3. On the right-hand side of the page, click **Edit** (pencil icon).
2914

30-
![Edit button on learn.microsoft.com.](images/quick-update-edit.png)
15+
![Edit button on Microsoft Learn.](https://learn.microsoft.com/compliance/media/quick-update-edit.png)
3116

3217
4. The corresponding topic file on GitHub opens, where you need to click the **Edit this file** pencil icon.
3318

34-
![Edit button on github.com.](images/quick-update-github.png)
19+
![Edit button on github.com.](https://learn.microsoft.com/compliance/media/quick-update-github.png)
3520

36-
5. The topic opens in a line-numbered editing page where you can make changes to the file.
21+
5. The topic opens in a line-numbered editing page where you can make changes to the file. Files in GitHub are written and edited using Markdown language. For help on using Markdown, see [Mastering Markdown](https://guides.github.com/features/mastering-markdown/). Select the **Preview changes** tab to view your changes as you go.
3722

38-
In this example, we'll add a link to the **Related Links** section of a topic. To add the link, scroll down to the **Related Links** section and add the link in the correct format.
39-
40-
**Notes**:
41-
42-
- Files in GitHub are written and edited using Markdown language. For help on using Markdown, see [Mastering Markdown](https://guides.github.com/features/mastering-markdown/).
43-
44-
- In cmdlet reference topics, the layout of headings and subheadings must follow a required schema for PowerShell Get-Help. Any deviation will throw errors in the Pull Request. For more information, see <https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md>.
45-
46-
- 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).
47-
48-
![Image of Automatic Fork message on Github.](images/auto_fork.png)
49-
50-
6. You can click the **Preview changes** tab to see what the changes will look like.
51-
52-
7. When you're finished making changes, go to the **Propose file change** section at the bottom of the page:
23+
6. When you're finished making changes, go to the **Propose file change** section at the bottom of the page:
5324

5425
- A brief title is required. By default, the title is the name of the file, but you can change it.
5526
- Optionally, you can enter more details in the **Add an optional extended description** box.
5627

5728
When you're ready, click the green **Propose file change** button.
5829

59-
![Propose file change section.](images/propose-file-change.png)
30+
![Propose file change section.](https://learn.microsoft.com/compliance/media/propose-file-change.png)
6031

61-
8. On the **Comparing changes** page that appears, click the green **Create pull request** button.
32+
7. On the **Comparing changes** page that appears, click the green **Create pull request** button.
6233

63-
![Comparing changes page.](images/comparing-changes-page.png)
34+
![Comparing changes page.](https://learn.microsoft.com/compliance/media/comparing-changes-page.png)
6435

65-
9. On the **Open a pull request** page that appears, click the green **Create pull request** button.
36+
8. On the **Open a pull request** page that appears, click the green **Create pull request** button.
6637

67-
![Open a pull request page.](images/open-a-pull-request-page.png)
38+
![Open a pull request page.](https://learn.microsoft.com/compliance/media/open-a-pull-request-page.png)
6839

6940
> [!NOTE]
7041
> Your permissions in the repo determine what you see in the last several steps. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages.<br/><br/>The point is: click any green buttons that are presented to you until there are no more.
7142
72-
Looking for more in-depth content? Check out the following topics:
73-
74-
- [Frequently Asked Questions (FAQ)](repo_docs/FAQ.md)
75-
- [Using more advanced tools with the PowerShell GitHub repo](repo_docs/ADVANCED.md)
76-
- [Creating content for brand new cmdlets](repo_docs/NEW_CMDLETS.md)
43+
The writer identified in the metadata of the topic will be notified and will eventually review and approve your changes so the topic will be updated on Microsoft Learn. If there are questions or issues with the updates, the writer will contact you.
7744

7845
## Microsoft Open Source Code of Conduct
7946

@@ -83,15 +50,17 @@ For more information see the [Code of Conduct FAQ](https://opensource.microsoft.
8350

8451
### Contributing
8552

86-
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit <https://cla.microsoft.com>.
53+
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit <https://cla.microsoft.com>.
8754

8855
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
8956

90-
## Legal Notices
57+
### Legal Notices
9158

9259
Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode), see the [LICENSE](LICENSE) file, and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the [LICENSE-CODE](LICENSE-CODE) file.
9360

94-
Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at <https://go.microsoft.com/fwlink/p/?LinkID=254653>.
61+
Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries.
62+
63+
The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at <https://go.microsoft.com/fwlink/?LinkID=254653>.
9564

9665
Privacy information can be found at <https://privacy.microsoft.com/>
9766

exchange/docs-conceptual/app-only-auth-powershell-v2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The Exchange Online PowerShell module uses the Active Directory Authentication L
5959
The following examples show how to use the Exchange Online PowerShell module with app-only authentication:
6060

6161
> [!IMPORTANT]
62-
> In the following connection commands, you must use an `.onmicrosoft.com` domain for the _Organization_ parameter value.
62+
> In the following connection commands, use the primary `.onmicrosoft.com` domain for your organization as the value of the _Organization_ parameter.
6363
>
6464
> The following connection commands have many of the same options available as described in [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) and [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). For example:
6565
>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ For more information about execution policies, see [About Execution Policies](/p
277277
#### Turn on Basic authentication in WinRM
278278

279279
> [!NOTE]
280-
> As described [earlier in this article](#updates-for-version-300-the-exo-v3-module), the EXO V3 module does not require Basic authentication in WinRM for REST-based connections.
280+
> As described [earlier in this article](#updates-for-version-300-the-exo-v3-module), the EXO V3 module does not require Basic authentication in WinRM for REST-based connections to Exchange Online PowerShell.
281281
282282
For remote PowerShell connections, WinRM needs to allow Basic authentication. **We do not send the username and password combination**. The Basic authentication **header** is required to send the session's OAuth token, because the client-side implementation of WinRM does not support OAuth.
283283

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ The DelegatedOrganization parameter specifies the customer organization that you
215215

216216
After you successfully authenticate, the cmdlets in this session are mapped to the customer organization, and all operations in this session are done on the customer organization.
217217

218-
**Note**: Use an .onmicrosoft.com domain for the value of this parameter. Otherwise, you might encounter permission-related issues when you run commands in the app context.
218+
**Note**: Use the primary .onmicrosoft.com domain of the delegated organization for the value of this parameter.
219219

220220
```yaml
221221
Type: String
@@ -591,7 +591,7 @@ Accept wildcard characters: False
591591
```
592592

593593
### -Organization
594-
The Organization parameter specifies the organization when you connect using CBA or managed identity. You must use an .onmicrosoft.com domain for the value of this parameter.
594+
The Organization parameter specifies the organization when you connect using CBA or managed identity. You must use the primary .onmicrosoft.com domain of the organization for the value of this parameter.
595595

596596
For more information about connecting with CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba).
597597

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

Lines changed: 7 additions & 3 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 or standalone Exchange Online Protection PowerShell using modern authentication. The cmdlet works for MFA or non-MFA enabled accounts.
1919

20-
**Note**: If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for Exchange Online Protection (EOP), use the [Connect-ExchangeOnline](https://learn.microsoft.com/powershell/module/exchange/connect-exchangeonline) cmdlet in the [Exchange Online PowerShell connection instructions](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) to connect to your EOP PowerShell environment.
20+
**Note**: Currently, this cmdlet still requires Basic authentication to be enabled in WinRM on the local computer. 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

@@ -47,6 +47,10 @@ Connect-IPPSSession
4747
## DESCRIPTION
4848
This cmdlet allows you to create a remote PowerShell session to Exchange-related PowerShell environments other than Exchange Online PowerShell. For example, Security & Compliance PowerShell or standalone Exchange Online Protection PowerShell (for organizations without Exchange Online mailboxes).
4949

50+
If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for Exchange Online Protection (EOP), use the [Connect-ExchangeOnline](https://learn.microsoft.com/powershell/module/exchange/connect-exchangeonline) cmdlet in the [Exchange Online PowerShell connection instructions](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) to connect to your EOP PowerShell environment.
51+
52+
For detailed connection instructions, including prerequisites, see [Connect to Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-scc-powershell).
53+
5054
## EXAMPLES
5155

5256
### Example 1
@@ -144,7 +148,7 @@ After you successfully authenticate, the cmdlets in this session are mapped to t
144148

145149
**Notes**:
146150

147-
- Use an .onmicrosoft.com domain for the value of this parameter. Otherwise, you might encounter permission-related issues when you run commands in the app context.
151+
- Use the primary .onmicrosoft.com domain of the delegated organization for the value of this parameter.
148152
- You must use the AzureADAuthorizationEndpointUri parameter with this parameter.
149153

150154
```yaml
@@ -370,7 +374,7 @@ Accept wildcard characters: False
370374
```
371375

372376
### -Organization
373-
The Organization parameter specifies the organization that's used in CBA. You must use an .onmicrosoft.com domain for the value of this parameter.
377+
The Organization parameter specifies the organization when you connect using CBA. You must use the primary .onmicrosoft.com domain of the organization for the value of this parameter.
374378

375379
For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba).
376380

0 commit comments

Comments
 (0)