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: README.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,38 +1,38 @@
1
1
# Short URL: aka.ms/office-powershell
2
2
3
3
# Overview
4
-
A repository to hold the help reference content for Office PowerShell cmdlets. The expert knowledge around Office PowerShell is distributed amongst 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 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.
5
5

6
6
7
7
# Learn How To Contribute
8
8
Anyone who is interested can contribute to the Microsoft Office PowerShell reference topics.
9
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
10
11
-
> 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.
11
+
> 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.
12
12
13
13
# Quick Start
14
14
15
15
## Contribute using the GitHub website
16
16
17
17
[](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)
18
18
19
-
1. Open your browser, login to GitHub, and then navigate to https://github.com/microsoftdocs/office-docs-powershell
20
-
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.
19
+
1. Open your browser, log in to GitHub, and then navigate to https://github.com/microsoftdocs/office-docs-powershell
20
+
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.
21
21
3. Click the Edit icon which looks like a pencil in the upper right corner.
22
22

23
23
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.
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
25

26
26
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 top right).
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
28

29
29
30
30
5. You can click the Preview changes link to see what the changes will look like.
31
31
32
32
**IMPORTANT** The layout of headings and subheadings must follow a very specific schema that is required for PowerShell Get-Help.
33
33
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
34
34
35
-
6. Once you are satisfied with your work, go to the **Propose file change** area at the bottom of the topic. Enter a title title and other description information and then click **Propose file change**.
35
+
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**.
36
36

37
37
38
38
7. On the next screen, click **Create pull request**.
@@ -46,7 +46,7 @@ Looking for more in-depth content? Check out the following:
46
46
47
47
## Contributing
48
48
49
-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
49
+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
50
50
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
51
51
the rights to use your contribution. For details, visit https://cla.microsoft.com.
Copy file name to clipboardExpand all lines: exchange/docs-conceptual/exchange-server/exchange-management-shell.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ description: "Learn about Exchange Server PowerShell, also known as the Exchange
13
13
---
14
14
15
15
# Exchange Server PowerShell (Exchange Management Shell)
16
-
The Exchange Management Shell is built on Windows PowerShell technology and provides a powerful command-line interface that enables the automation of Exchange administration tasks. You can use the Exchange Management Shell to manage every aspect of Exchange. For example, you can create email accounts, create Send connectors and Receive connectors, configure mailbox database properties, and manage distribution groups. You can use the Exchange Management Shell to perform every task that's available in the Exchange graphical management tools, plus things that you can't do there (for example, bulk operations). In fact, when you do something in the the Exchange admin center (EAC), the Exchange Control Panel (ECP), or the Exchange Management Console (EMC), it's the Exchange Management Shell that does the work behind the scenes.
16
+
The Exchange Management Shell is built on Windows PowerShell technology and provides a powerful command-line interface that enables the automation of Exchange administration tasks. You can use the Exchange Management Shell to manage every aspect of Exchange. For example, you can create email accounts, create Send connectors and Receive connectors, configure mailbox database properties, and manage distribution groups. You can use the Exchange Management Shell to perform every task that's available in the Exchange graphical management tools, plus things that you can't do there (for example, bulk operations). In fact, when you do something in the Exchange admin center (EAC), the Exchange Control Panel (ECP), or the Exchange Management Console (EMC), it's the Exchange Management Shell that does the work behind the scenes.
17
17
18
18
The Exchange Management Shell also provides a robust and flexible scripting platform. Visual Basic scripts that required many lines of code can be replaced by Exchange Management Shell commands that use as little as one line of code. The Exchange Management Shell provides this flexibility because it uses an object model that's based on the Microsoft .NET Framework. This object model enables Exchange cmdlets to apply the output from one command to subsequent commands.
Copy file name to clipboardExpand all lines: exchange/docs-conceptual/office-365-scc/office-365-scc-powershell.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,6 @@ Security & Compliance Center PowerShell is the administrative interface that ena
17
17
18
18
- To create a remote PowerShell session to the Security & Compliance Center, see [Connect to Office 365 Security & Compliance Center PowerShell](connect-to-scc-powershell/connect-to-scc-powershell.md). Note that the connection instructions are different from Exchange Online or Exchange Online Protection (the _ConnectionUri_ value is different).
19
19
20
-
- Note that some cmdlets are available only in the Security & Compliance Center. Other cmdlets have the same names and functionality as those in Exchange Online, but they are also available in the Security & Compliance Center.
20
+
-A cmdlet is a lightweight command that is imported into your local Windows PowerShell session. Note that some cmdlets are available only in the Security & Compliance Center. Other cmdlets have the same names and functionality as those in Exchange Online, but they are also available in the Security & Compliance Center.
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
230
243
231
-
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.
244
+
- Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.
232
245
233
-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
246
+
- Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
234
247
235
248
```yaml
236
249
Type: SwitchParameter
237
250
Parameter Sets: (All)
238
251
Aliases: cf
239
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
252
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
240
253
Required: False
241
254
Position: Named
242
255
Default value: None
@@ -249,9 +262,9 @@ The Deny switch specifies whether to deny permissions to the user on the Active
249
262
250
263
```yaml
251
264
Type: SwitchParameter
252
-
Parameter Sets: Set1, Set3
265
+
Parameter Sets: AccessRights, Instance
253
266
Aliases:
254
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
267
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
255
268
Required: False
256
269
Position: Named
257
270
Default value: None
@@ -268,7 +281,7 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg
268
281
Type: Fqdn
269
282
Parameter Sets: (All)
270
283
Aliases:
271
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
284
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
272
285
Required: False
273
286
Position: Named
274
287
Default value: None
@@ -281,9 +294,9 @@ The ExtendedRights parameter specifies the extended rights needed to perform the
281
294
282
295
```yaml
283
296
Type: ExtendedRightIdParameter[]
284
-
Parameter Sets: Set1, Set3
297
+
Parameter Sets: AccessRights, Instance
285
298
Aliases:
286
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
299
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
287
300
Required: False
288
301
Position: Named
289
302
Default value: None
@@ -296,9 +309,9 @@ The InheritanceType parameter specifies whether permissions are inherited.
296
309
297
310
```yaml
298
311
Type: None | All | Descendents | SelfAndChildren | Children
299
-
Parameter Sets: Set1, Set3
312
+
Parameter Sets: AccessRights, Instance
300
313
Aliases:
301
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
314
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
302
315
Required: False
303
316
Position: Named
304
317
Default value: None
@@ -311,9 +324,9 @@ The InheritedObjectType parameter specifies what kind of object inherits this ac
311
324
312
325
```yaml
313
326
Type: ADSchemaObjectIdParameter
314
-
Parameter Sets: Set1, Set3
327
+
Parameter Sets: AccessRights, Instance
315
328
Aliases:
316
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
329
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
317
330
Required: False
318
331
Position: Named
319
332
Default value: None
@@ -328,9 +341,9 @@ The Properties parameter can only be used if the AccessRights parameter is set t
328
341
329
342
```yaml
330
343
Type: ADSchemaObjectIdParameter[]
331
-
Parameter Sets: Set1, Set3
344
+
Parameter Sets: AccessRights, Instance
332
345
Aliases:
333
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
346
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
334
347
Required: False
335
348
Position: Named
336
349
Default value: None
@@ -345,7 +358,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch
345
358
Type: SwitchParameter
346
359
Parameter Sets: (All)
347
360
Aliases: wi
348
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
361
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
0 commit comments