Skip to content

Commit fd45668

Browse files
authored
Merge branch 'master' into tools
2 parents 4fccd3f + 66bf6a3 commit fd45668

26 files changed

+99
-93
lines changed

exchange/exchange-ps/exchange/policy-and-compliance/New-TransportRule.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4484,7 +4484,9 @@ In on-premises Exchange, this action is only available on Mailbox servers.
44844484
44854485
The RejectMessageEnhancedStatusCode parameter specifies the enhanced status code that's used when the rule rejects messages. Valid values are 5.7.1 or between 5.7.900 and 5.7.999.
44864486
4487-
You can use this parameter with the NotifySender and RejectMessageReasonText parameters to specify the custom enhanced status code that's used. If you don't use this parameter, the default value 5.7.1 is used.
4487+
You can use this parameter with the NotifySender parameter for a custom non-delivery report (also known as an NDR or bounce message).
4488+
4489+
If you use this parameter with the RejectMessageReasonText parameter, the enhanced status code value is set to 5.7.1.
44884490
44894491
To further customize the NDR (for example, multiple languages), you need to create a custom message by using the New-SystemMessage cmdlet.
44904492
@@ -4507,7 +4509,9 @@ In on-premises Exchange, this action is only available on Mailbox servers.
45074509
45084510
The RejectMessageReasonText parameter specifies the explanation text that's used when the rule rejects messages. If the value contains spaces, enclose the value in quotation marks (").
45094511
4510-
You can use this parameter with the NotifySender and RejectMessageEnhancedStatusCode parameters to specify the custom explanation text that's used. If you don't use this parameter, the default value Delivery not authorized, message refused is used.
4512+
You can use this parameter with the NotifySender parameter for a custom non-delivery report (also known as an NDR or bounce message).
4513+
4514+
If you use this parameter with the RejectMessageEnhancedStatusCode parameter, the custom explanation text value is set to "Delivery not authorized, message refused".
45114515
45124516
To further customize the NDR (for example, multiple languages), you need to create a custom message by using the New-SystemMessage cmdlet.
45134517

exchange/exchange-ps/exchange/policy-and-compliance/Set-TransportRule.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4479,7 +4479,9 @@ In on-premises Exchange, this action is only available on Mailbox servers.
44794479
44804480
The RejectMessageEnhancedStatusCode parameter specifies the enhanced status code that's used when the rule rejects messages. Valid values are 5.7.1 or between 5.7.900 and 5.7.999.
44814481
4482-
You can use this parameter with the NotifySender and RejectMessageReasonText parameters to specify the custom enhanced status code that's used. If you don't use this parameter, the default value 5.7.1 is used.
4482+
You can use this parameter with the NotifySender parameter for a custom non-delivery report (also known as an NDR or bounce message).
4483+
4484+
If you use this parameter with the RejectMessageReasonText parameter, the enhanced status code value is set to 5.7.1.
44834485
44844486
To further customize the NDR (for example, multiple languages), you need to create a custom message by using the New-SystemMessage cmdlet.
44854487
@@ -4502,7 +4504,9 @@ In on-premises Exchange, this action is only available on Mailbox servers.
45024504
45034505
The RejectMessageReasonText parameter specifies the explanation text that's used when the rule rejects messages. If the value contains spaces, enclose the value in quotation marks (").
45044506
4505-
You can use this parameter with the NotifySender and RejectMessageEnhancedStatusCode parameters to specify the custom explanation text that's used. If you don't use this parameter, the default value Delivery not authorized, message refused is used.
4507+
You can use this parameter with the NotifySender parameter for a custom non-delivery report (also known as an NDR or bounce message).
4508+
4509+
If you use this parameter with the RejectMessageEnhancedStatusCode parameter, the custom explanation text value is set to "Delivery not authorized, message refused".
45064510
45074511
To further customize the NDR (for example, multiple languages), you need to create a custom message by using the New-SystemMessage cmdlet.
45084512

exchange/exchange-ps/exchange/reporting/Set-UserAnalyticsConfig.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,11 @@ Accept wildcard characters: False
7979
### -PrivacyMode
8080
The PrivacyMode parameter specifies the MyAnalytics privacy setting for the user. Valid values are:
8181
82-
- Exclude
82+
- Excluded
8383
84-
- OptIn
84+
- Opt-In
8585
86-
- OptOut
86+
- Opt-Out
8787
8888
```yaml
8989
Type: String

officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ New-OfficeWebAppsExcelUserDefinedFunction -Assembly c:\myudf.dll -AssemblyLocati
3030

3131
### ------------------EXAMPLE 2---------------------
3232
```
33-
New-OfficeWebAppsExcelUserDefinedFunction -Assembly "CompanyName.Hierarchichal.MyUdfNamespace.MyUdfClassName.dll, Version=1.1.0.0, Culture=en, PublicKeyToken=e8123117d7ba9ae38" -AssemblyLocation GAC -Enable:$true -Description "My GAC Server UDFs"
33+
New-OfficeWebAppsExcelUserDefinedFunction -Assembly "CompanyName.Hierarchical.MyUdfNamespace.MyUdfClassName.dll, Version=1.1.0.0, Culture=en, PublicKeyToken=e8123117d7ba9ae38" -AssemblyLocation GAC -Enable:$true -Description "My GAC Server UDFs"
3434
```
3535

3636
## PARAMETERS

officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ Accept wildcard characters: False
368368
```
369369
370370
### -ExcelExternalDataCacheLifetime
371-
Specifes the duration, in seconds, of the external data cache lifetime in Excel Online.
371+
Specifies the duration, in seconds, of the external data cache lifetime in Excel Online.
372372
The default is 300 seconds.
373373
374374
```yaml
@@ -760,7 +760,7 @@ Accept wildcard characters: False
760760
Turns on or off the ability to use Online Viewers to view Office files from a URL or UNC path.
761761
The default is False.
762762
763-
You must set this paramater to True when you use ClipartEnabled.
763+
You must set this parameter to True when you use ClipartEnabled.
764764
765765
```yaml
766766
Type: SwitchParameter

repo_docs/UPDATE_CMDLETS.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ Manually adding new parameters to a cmdlet reference topic is doable, but there
33

44
- **Add the paramter and Type value to the SYNTAX block(s)**: Easy to do if there's only one, but what if there are multiple SYNTAX blocks (also known as parameter sets)? Does the new parameter go in one, some, or all of them? And what about the parameter Type value (String? `$true | $ false`? A finite list of values?)
55

6-
- **Create a new section for each parameter**: It's easy to create the section and write the descrition, but again, what about the parameter Type value? And which parameter sets does it belong to?
6+
- **Create a new section for each parameter**: It's easy to create the section and write the description, but again, what about the parameter Type value? And which parameter sets does it belong to?
77

88
The reality is: you almost always need the open-source [platyPS](https://github.com/PowerShell/platyPS) tool to automatically answer the unknowns about new parameters.
99

10-
Currently, the best method with platyPS is to simply create a new version of the topic using the **New-MarkdownHelp** cmdlet, and copy whatever you need out of it. Theoretically, platyPS has an **Update-MarkdownHelp** cmdlet that automatically updates an existing local copy of the topic for you, which you can then upload in its entirety to the GitHub website to replace the exisitng topic. This approach currently has some issues in our enviornment:
10+
Currently, the best method with platyPS is to simply create a new version of the topic using the **New-MarkdownHelp** cmdlet, and copy whatever you need out of it. Theoretically, platyPS has an **Update-MarkdownHelp** cmdlet that automatically updates an existing local copy of the topic for you, which you can then upload in its entirety to the GitHub website to replace the existing topic. This approach currently has some issues in our environment:
1111

1212
- It's difficult to get a local copy of an existing cmdlet topic from the GitHub website (unless you're interested in forking the repo and having a local cloned copy on your computer). You have to copy/paste everything from the Raw view of the topic on the web site, and the local copy text file you manually create needs to be UTF-8 formatted (instead of the Notepad default of ANSI).
1313

1414
- The updated topic will have missing or incorrect _unrelated_ parameter and other topic metadata information that you'll need to change by copy/pasting those values _back from_ the existing topic on GitHub into your local topic before you can even think about uploading the updated topic to GitHub (more than double the work required).
1515

1616
In short, it's simply easier and faster to generate a new local copy of the cmdlet topic, and copy/paste only what you need into the existing topic on GitHub.
1717

18-
Removing parameters from topics is a manual excercise, but we'll explain the process fully.
18+
Removing parameters from topics is a manual exercise, but we'll explain the process fully.
1919

2020
## Use platyPS to add new cmdlets to existing topics
2121

@@ -28,7 +28,7 @@ You probably know how to do this already, but the available workloads and connec
2828
### Step 3: Load platyPS in the PowerShell environment
2929
After you've connected in PowerShell to the server or service (either in a regular Windows PowerShell window or from a specific PowerShell console shortcut), run the following command to make the platyPS cmdlets available in your session:
3030

31-
```
31+
```powershell
3232
Import-Module platyPS
3333
```
3434

@@ -39,37 +39,37 @@ To recap: this step is required in Exchange, Skype for Business Online and other
3939

4040
If you're using SharePoint, SharePoint Online or another product that doesn't use remote PowerShell to connect, you can skip this step.
4141

42-
### Step 5: Use New-MarkdownHelp to dump the latest verion of the cmdlet to a file
42+
### Step 5: Use New-MarkdownHelp to dump the latest version of the cmdlet to a file
4343
These instructions are the same (up to a point) as in [Create new cmdlet topics](NEW_CMDLETS.md):
4444

4545
The basic syntax is:
4646

47-
```
47+
```powershell
4848
New-MarkdownHelp -Command <Cmdlet> -OutputFolder "<Path"> [-Session <PSSessionVariableName>]
4949
```
5050

5151
or
5252

53-
```
53+
```powershell
5454
$x = "<Cmdlet1>","<Cmdlet2>",..."<CmdletN>"
5555
New-MarkdownHelp -Command $x -OutputFolder "<Path"> [-Session <PSSessionVariableName>]
5656
```
5757

5858
This example create a topic file for the updated cmdlet named Get-CoolFeature in the Exchange Online PowerShell session where the session variable is `$Session` in the folder "C:\My Docs\ExO".
5959

60-
```
60+
```powershell
6161
New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO" -Session $Session
6262
```
6363

6464
This example creates topic files for the updated cmdlets Get-CoolFeature, New-CoolFeature, Remove-CoolFeature, and Set-CoolFeature from the Exchange Online session where the session variable is `$Session` in the folder C:\My Docs\ExO.
6565

6666
The first command stores the cmdlet names in a variable. The second command uses that variable to identify the cmdlets and write the output files.
6767

68-
```
68+
```powershell
6969
$Delta = "Get-CoolFeature","New-CoolFeature","Remove-CoolFeature","Set-CoolFeature"
7070
```
7171

72-
```
72+
```powershell
7373
New-MarkdownHelp -Command $Delta -OutputFolder "C:\My Docs\ExO" -Session $Session
7474
```
7575

@@ -78,25 +78,25 @@ The resulting topics are plain text UTF-8 files that are formatted using [markdo
7878

7979
1. Find the new parameter(s) in the SYNTAX block and the parameter sections.
8080

81-
2. Add a parameter description. We highly enourage you to plagerize existing content and formatting from other cmdlet topics. Many parameters are common across a wide variety of cmdlets.
81+
2. Add a parameter description. We highly encourage you to plagiarize existing content and formatting from other cmdlet topics. Many parameters are common across a wide variety of cmdlets.
8282

8383
3. Create/fill out the parameter metadata like other existing parameters in the topic.
8484

8585
Here's an example of the parameter metadata that's present in every parameter section:
8686

87-
```
88-
Type: String
89-
Parameter Sets: (All)
90-
Aliases:
91-
Applicable: Microsoft StaffHub
92-
Required: False
93-
Position: 1
94-
Default value: None
95-
Accept pipeline input: False
96-
Accept wildcard characters: False
87+
```yaml
88+
Type: String
89+
Parameter Sets: (All)
90+
Aliases:
91+
Applicable: Microsoft StaffHub
92+
Required: False
93+
Position: 1
94+
Default value: None
95+
Accept pipeline input: False
96+
Accept wildcard characters: False
9797
```
9898
99-
Most of the atrributes and values are generated automatically by platyPS. The ones that require manual intervention are:
99+
Most of the attributes and values are generated automatically by platyPS. The ones that require manual intervention are:
100100
101101
- **Applicable**: You need to add this attribute and value yourself. Notice the capital 'A'. See other topics for available values (same available values as the **applicable** attribute at the top of the topic). Don't invent new values here. The value **must** come from the list of predefined values.
102102
@@ -109,7 +109,7 @@ At this point, the steps are basically identical to [Short URL: aka.ms/office-po
109109
110110
- Exchange: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/exchange/exchange-ps/exchange](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/exchange/exchange-ps/exchange)
111111
112-
For Exchage, you also need to go one level deepter into an appropriate subfolder.
112+
For Exchange, you also need to go one level deeper into an appropriate subfolder.
113113
114114
- Office Web Apps: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/officewebapps/officewebapps-ps/officewebapps](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/officewebapps/officewebapps-ps/officewebapps)
115115
@@ -141,9 +141,9 @@ At this point, the steps are basically identical to [Short URL: aka.ms/office-po
141141
7. On the next screen, click **Create pull request**.
142142
143143
## Remove existing parameters from existing topics
144-
Removing parameters is a search and destroy mission in the existing topics on GitHub, using the basic [Editing Instrucstions](../README.md).
144+
Removing parameters is a search and destroy mission in the existing topics on GitHub, using the basic [Editing Instructions](../README.md).
145145
146-
The most important thing to remember: a parameter isn't gone until it's truly not available to customers. If a parameter is still available, but it's going away "in the future", it doesn't work correctly anymore, or isn't supposed to be available, it needs to remain in the topic until the product code is actually changed to remove the parameter. Until then, you can use this type of languague for the parameter description:
146+
The most important thing to remember: a parameter isn't gone until it's truly not available to customers. If a parameter is still available, but it's going away "in the future", it doesn't work correctly anymore, or isn't supposed to be available, it needs to remain in the topic until the product code is actually changed to remove the parameter. Until then, you can use this type of language for the parameter description:
147147
148148
- This parameter is reserved for internal Microsoft use.
149149

sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationEncryptedPackage.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# ConvertTo-SPOMigrationEncryptedPackage
99

1010
## SYNOPSIS
11-
Use this Cmdlet to convert your XML files into a new encryted migration package.
11+
Use this Cmdlet to convert your XML files into a new encrypted migration package.
1212

1313
## SYNTAX
1414

@@ -27,7 +27,7 @@ ConvertTo-SPOMigrationEncryptedPackage -EncryptionParameters <EncryptionParamete
2727
```
2828

2929
## DESCRIPTION
30-
This command convert the XML file on your temprary XML folder files into a new set of targeted migration encrypted metadata files to the target directory.
30+
This command convert the XML file on your temporary XML folder files into a new set of targeted migration encrypted metadata files to the target directory.
3131

3232
## EXAMPLES
3333

@@ -47,12 +47,12 @@ PS C:\> ConvertTo-SPOMigrationEncryptedPackage -EncryptionParameters SHA384
4747
-TargetPackagePath $TargetPackagePath
4848
```
4949

50-
Same as example1 but without log file and using an encription type SHA384
50+
Same as example1 but without log file and using an encryption type SHA384
5151

5252
## PARAMETERS
5353

5454
### -EncryptionParameters
55-
Parameters of the encription, it doesn't accept wildcard caracters.
55+
Parameters of the encryption, it doesn't accept wildcard characters.
5656
It accepts parameters like SHA384, SHA256, etc.
5757

5858
```yaml
@@ -69,7 +69,7 @@ Accept wildcard characters: False
6969
```
7070
7171
### -MigrationSourceLocations
72-
Posible Source locations to migrate
72+
Possible Source locations to migrate
7373
7474
```yaml
7575
Type: MigrationPackageLocation

sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-SPOGeoAdministrator
99

1010
## SYNOPSIS
11-
This cmdlet returns the SharePoint Online user or security group accounts with global administrative privilegies in the current Multi-Geographics tenant
11+
This cmdlet returns the SharePoint Online user or security group accounts with global administrative privileges in the current Multi-Geographics tenant
1212

1313
## SYNTAX
1414

sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserAndContentMoveState.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Obtain the move state by OneDrive Move Job ID
5151
### Example 2
5252

5353
```Powershell
54-
Get-SPOUserAndContentMoveState -movestate NotStarted
54+
Get-SPOUserAndContentMoveState -MoveState NotStarted
5555
```
5656
Getting which moves are being done in a particular state
5757
###Example 3

sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOGeoAdministrator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This cmdlet contains a single parameter set.
2222
You may only use parameters from one parameter set and you may not combine parameters from different parameter sets.
2323
For more information about how to use parameter sets, see Cmdlet Parameter Sets (http://go.microsoft.com/fwlink/?LinkID=187810).
2424

25-
The `Remove-SPOGeoAdministrator` cmdlet matches a user or a security group and remove the GeoAdministrator privilegies in the SharePoint Organization.
25+
The `Remove-SPOGeoAdministrator` cmdlet matches a user or a security group and remove the GeoAdministrator privileges in the SharePoint Organization.
2626

2727
You must be a SharePoint Online global administrator and you must have a Multi-Geo Tenant to run the `Get-SPOGeoAdministrator` cmdlet.
2828

@@ -37,7 +37,7 @@ For permissions and the most current information about Windows PowerShell for Sh
3737
```powershell
3838
Remove-SPOGeoAdministrator contosoadmin [-LoginName] <String>
3939
```
40-
Remove the GeoAdministrator privilegies to the user contosoadmin of the SharePoint Online multi-geo tenant.
40+
Remove the GeoAdministrator privileges to the user contosoadmin of the SharePoint Online multi-geo tenant.
4141

4242
### Example 2
4343
```powershell

sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOPublicCdnOrigin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Accept wildcard characters: False
5858
```
5959
6060
### -Identity
61-
It's the unique identificator of the Public CDN path, it can be queried using the Cmdlet Get-SpoPublicCdnOrigins
61+
It's the unique identifier of the Public CDN path, it can be queried using the Cmdlet Get-SpoPublicCdnOrigins
6262
6363
```yaml
6464
Type: String

sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantCdnOrigin.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ Removes a new origin from the Public or Private content delivery network (CDN).
2525
## EXAMPLES
2626

2727
### -----------------------EXAMPLE 1-----------------------------
28-
```
28+
```powershell
2929
Remove-SPOTenantCdnOrigin -CdnType Public -OriginUrl sites/pubsite/siteassets/subfolder
3030
```
3131

3232
The example removes a CDN from a tenant level.
3333

3434
### -----------------------EXAMPLE 2-----------------------------
35-
```
35+
```powershell
3636
Remove-SPOTenantCdnOrigin -CdnType Public -OriginScope Site -Site https://contoso.sharepoint.com/sites/pubsite -OriginUrl siteassets/subfolder
3737
```
3838

@@ -42,7 +42,7 @@ The example removes a CDN from a site level.
4242
## PARAMETERS
4343

4444
### -CdnType
45-
Specifies the CDN type. The valuid values are: Public or Private.
45+
Specifies the CDN type. The valid values are: Public or Private.
4646

4747

4848
```yaml
@@ -82,7 +82,7 @@ Relative-Relative path depends on the OriginScope. If the originScope is Tenant,
8282
8383
Any asset stored under the path provided (in the container itself or any of its subfolders) will be exposed via CDN
8484
85-
Mask - Mask allows to configure a partial URL match. It must start with */, and must not include * anywhere else. I.e. an origin “*/masterpates” will expose all the assets under all the masterpages libraries, either under the tenant root (means, anywhere in the tenancy) or in the given site collection, depends on the OriginScope parameter. Equally, */masterpages/subfolder will enable items in “subfolder” and below.
85+
Mask - Mask allows to configure a partial URL match. It must start with */, and must not include * anywhere else. I.e. an origin “*/masterpages” will expose all the assets under all the masterpages libraries, either under the tenant root (means, anywhere in the tenancy) or in the given site collection, depends on the OriginScope parameter. Equally, */masterpages/subfolder will enable items in “subfolder” and below.
8686
8787
8888
```yaml

0 commit comments

Comments
 (0)