Skip to content

Commit 916a846

Browse files
committed
Merge remote-tracking branch 'MicrosoftDocs/master' into tools
2 parents acc2502 + 7331002 commit 916a846

File tree

1,983 files changed

+41293
-35000
lines changed

Some content is hidden

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

1,983 files changed

+41293
-35000
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@ _site/
44
.optemp/
55
_themes*/
66
.vs/
7+
.local/
78

89
.openpublishing.buildcore.ps1

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
11
# 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 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.
55
![Contribution and Consumption model for Office PowerShell reference content](images/contrib-consumption-model.png)
66

77
# Learn How To Contribute
88
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

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.
1212
1313
# Quick Start
1414

1515
## Contribute using the GitHub website
1616

1717
[![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)
1818

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.
2121
3. Click the Edit icon which looks like a pencil in the upper right corner.
2222
![Image of Edit button on Github](images/edit_icon.png)
2323

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.
2525
![Image of Edit button on Github](images/add_related_link.png)
2626

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).
2828
![Image of Automatic Fork message on Github](images/auto_fork.png)
2929

3030
5. You can click the Preview changes link to see what the changes will look like.
3131

3232
**IMPORTANT** The layout of headings and subheadings must follow a very specific schema that is required for PowerShell Get-Help.
3333
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
3434

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**.
3636
![Image of Propose file change on Github](images/propose_file_change.png)
3737

3838
7. On the next screen, click **Create pull request**.
@@ -46,7 +46,7 @@ Looking for more in-depth content? Check out the following:
4646

4747
## Contributing
4848

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
5050
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
5151
the rights to use your contribution. For details, visit https://cla.microsoft.com.
5252

exchange/docs-conceptual/exchange-server/exchange-management-shell.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: "Learn about Exchange Server PowerShell, also known as the Exchange
1313
---
1414

1515
# 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.
1717

1818
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.
1919

exchange/docs-conceptual/office-365-scc/office-365-scc-powershell.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ Security & Compliance Center PowerShell is the administrative interface that ena
1717

1818
- 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).
1919

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.
2121

2222

exchange/exchange-ps/exchange/active-directory/Add-ADPermission.md

Lines changed: 60 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml
3-
applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
3+
applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
44
title: Add-ADPermission
55
schema: 2.0.0
6-
monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016"
6+
monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019"
77
---
88

99
# Add-ADPermission
@@ -17,31 +17,44 @@ For information about the parameter sets in the Syntax section below, see Exchan
1717

1818
## SYNTAX
1919

20-
### Set1
20+
### AccessRights
2121
```
2222
Add-ADPermission [-Identity] <ADRawEntryIdParameter> -User <SecurityPrincipalIdParameter>
23-
[-AccessRights <ActiveDirectoryRights[]>] [-ChildObjectTypes <ADSchemaObjectIdParameter[]>] [-Confirm] [-Deny]
24-
[-DomainController <Fqdn>] [-ExtendedRights <ExtendedRightIdParameter[]>]
23+
[-AccessRights <ActiveDirectoryRights[]>]
24+
[-ChildObjectTypes <ADSchemaObjectIdParameter[]>]
25+
[-Confirm]
26+
[-Deny]
27+
[-DomainController <Fqdn>]
28+
[-ExtendedRights <ExtendedRightIdParameter[]>]
2529
[-InheritanceType <None | All | Descendents | SelfAndChildren | Children>]
26-
[-InheritedObjectType <ADSchemaObjectIdParameter>] [-Properties <ADSchemaObjectIdParameter[]>] [-WhatIf]
27-
[<CommonParameters>]
30+
[-InheritedObjectType <ADSchemaObjectIdParameter>]
31+
[-Properties <ADSchemaObjectIdParameter[]>]
32+
[-WhatIf] [<CommonParameters>]
2833
```
2934

30-
### Set2
35+
### Owner
3136
```
32-
Add-ADPermission [-Identity] <ADRawEntryIdParameter> -Owner <SecurityPrincipalIdParameter> [-Confirm]
33-
[-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>]
37+
Add-ADPermission [-Identity] <ADRawEntryIdParameter> -Owner <SecurityPrincipalIdParameter>
38+
[-Confirm]
39+
[-DomainController <Fqdn>]
40+
[-WhatIf] [<CommonParameters>]
3441
```
3542

36-
### Set3
43+
### Instance
3744
```
38-
Add-ADPermission [[-Identity] <ADRawEntryIdParameter>] -Instance <ADAcePresentationObject>
39-
[-User <SecurityPrincipalIdParameter>] [-AccessRights <ActiveDirectoryRights[]>]
40-
[-ChildObjectTypes <ADSchemaObjectIdParameter[]>] [-Confirm] [-Deny] [-DomainController <Fqdn>]
45+
Add-ADPermission -Instance <ADAcePresentationObject>
46+
[-AccessRights <ActiveDirectoryRights[]>]
47+
[-ChildObjectTypes <ADSchemaObjectIdParameter[]>]
48+
[-Confirm]
49+
[-Deny]
50+
[-DomainController <Fqdn>]
4151
[-ExtendedRights <ExtendedRightIdParameter[]>]
52+
[[-Identity] <ADRawEntryIdParameter>]
4253
[-InheritanceType <None | All | Descendents | SelfAndChildren | Children>]
43-
[-InheritedObjectType <ADSchemaObjectIdParameter>] [-Properties <ADSchemaObjectIdParameter[]>] [-WhatIf]
44-
[<CommonParameters>]
54+
[-InheritedObjectType <ADSchemaObjectIdParameter>]
55+
[-Properties <ADSchemaObjectIdParameter[]>]
56+
[-User <SecurityPrincipalIdParameter>]
57+
[-WhatIf] [<CommonParameters>]
4558
```
4659

4760
## DESCRIPTION
@@ -74,9 +87,9 @@ The Identity parameter specifies the identity of the object that's getting permi
7487

7588
```yaml
7689
Type: ADRawEntryIdParameter
77-
Parameter Sets: Set1, Set2
90+
Parameter Sets: AccessRights, Owner
7891
Aliases:
79-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
92+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
8093
Required: True
8194
Position: 1
8295
Default value: None
@@ -86,9 +99,9 @@ Accept wildcard characters: False
8699
87100
```yaml
88101
Type: ADRawEntryIdParameter
89-
Parameter Sets: Set3
102+
Parameter Sets: Instance
90103
Aliases:
91-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
104+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
92105
Required: False
93106
Position: 1
94107
Default value: None
@@ -101,9 +114,9 @@ The Instance parameter enables you to pass an entire object to the command to be
101114
102115
```yaml
103116
Type: ADAcePresentationObject
104-
Parameter Sets: Set3
117+
Parameter Sets: Instance
105118
Aliases:
106-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
119+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
107120
Required: True
108121
Position: Named
109122
Default value: None
@@ -118,9 +131,9 @@ The Owner parameter can only be used with the Identity parameter and no other pa
118131
119132
```yaml
120133
Type: SecurityPrincipalIdParameter
121-
Parameter Sets: Set2
134+
Parameter Sets: Owner
122135
Aliases:
123-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
136+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
124137
Required: True
125138
Position: Named
126139
Default value: None
@@ -133,9 +146,9 @@ The User parameter specifies the user that the permissions are being granted to
133146
134147
```yaml
135148
Type: SecurityPrincipalIdParameter
136-
Parameter Sets: Set1
149+
Parameter Sets: AccessRights
137150
Aliases:
138-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
151+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
139152
Required: True
140153
Position: Named
141154
Default value: None
@@ -145,9 +158,9 @@ Accept wildcard characters: False
145158
146159
```yaml
147160
Type: SecurityPrincipalIdParameter
148-
Parameter Sets: Set3
161+
Parameter Sets: Instance
149162
Aliases:
150-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
163+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
151164
Required: False
152165
Position: Named
153166
Default value: None
@@ -198,9 +211,9 @@ The AccessRights parameter specifies the rights needed to perform the operation.
198211
199212
```yaml
200213
Type: ActiveDirectoryRights[]
201-
Parameter Sets: Set1, Set3
214+
Parameter Sets: AccessRights, Instance
202215
Aliases:
203-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
216+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
204217
Required: False
205218
Position: Named
206219
Default value: None
@@ -215,9 +228,9 @@ The ChildObjectTypes parameter can only be used if the AccessRights parameter is
215228
216229
```yaml
217230
Type: ADSchemaObjectIdParameter[]
218-
Parameter Sets: Set1, Set3
231+
Parameter Sets: AccessRights, Instance
219232
Aliases:
220-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
233+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
221234
Required: False
222235
Position: Named
223236
Default value: None
@@ -228,15 +241,15 @@ Accept wildcard characters: False
228241
### -Confirm
229242
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.
230243
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.
232245
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.
234247
235248
```yaml
236249
Type: SwitchParameter
237250
Parameter Sets: (All)
238251
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
240253
Required: False
241254
Position: Named
242255
Default value: None
@@ -249,9 +262,9 @@ The Deny switch specifies whether to deny permissions to the user on the Active
249262
250263
```yaml
251264
Type: SwitchParameter
252-
Parameter Sets: Set1, Set3
265+
Parameter Sets: AccessRights, Instance
253266
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
255268
Required: False
256269
Position: Named
257270
Default value: None
@@ -268,7 +281,7 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg
268281
Type: Fqdn
269282
Parameter Sets: (All)
270283
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
272285
Required: False
273286
Position: Named
274287
Default value: None
@@ -281,9 +294,9 @@ The ExtendedRights parameter specifies the extended rights needed to perform the
281294
282295
```yaml
283296
Type: ExtendedRightIdParameter[]
284-
Parameter Sets: Set1, Set3
297+
Parameter Sets: AccessRights, Instance
285298
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
287300
Required: False
288301
Position: Named
289302
Default value: None
@@ -296,9 +309,9 @@ The InheritanceType parameter specifies whether permissions are inherited.
296309
297310
```yaml
298311
Type: None | All | Descendents | SelfAndChildren | Children
299-
Parameter Sets: Set1, Set3
312+
Parameter Sets: AccessRights, Instance
300313
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
302315
Required: False
303316
Position: Named
304317
Default value: None
@@ -311,9 +324,9 @@ The InheritedObjectType parameter specifies what kind of object inherits this ac
311324
312325
```yaml
313326
Type: ADSchemaObjectIdParameter
314-
Parameter Sets: Set1, Set3
327+
Parameter Sets: AccessRights, Instance
315328
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
317330
Required: False
318331
Position: Named
319332
Default value: None
@@ -328,9 +341,9 @@ The Properties parameter can only be used if the AccessRights parameter is set t
328341
329342
```yaml
330343
Type: ADSchemaObjectIdParameter[]
331-
Parameter Sets: Set1, Set3
344+
Parameter Sets: AccessRights, Instance
332345
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
334347
Required: False
335348
Position: Named
336349
Default value: None
@@ -345,7 +358,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch
345358
Type: SwitchParameter
346359
Parameter Sets: (All)
347360
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
349362
Required: False
350363
Position: Named
351364
Default value: None

0 commit comments

Comments
 (0)