From fa3f0cafd4f0eaa8635f772ec25083d8332fbc86 Mon Sep 17 00:00:00 2001 From: davidsmatlak Date: Fri, 1 Nov 2019 10:20:06 -0700 Subject: [PATCH] parameters added 6.0 --- .../Get-ChildItem.md | 2 ++ .../Microsoft.PowerShell.Management/Split-Path.md | 4 ++++ .../Invoke-RestMethod.md | 10 ++++++---- .../Invoke-WebRequest.md | 2 ++ .../6/Microsoft.PowerShell.Utility/Out-String.md | 6 +++++- .../6/Microsoft.PowerShell.Utility/Sort-Object.md | 4 ++++ .../Get-ChildItem.md | 2 ++ .../Microsoft.PowerShell.Management/Split-Path.md | 4 ++++ .../Invoke-RestMethod.md | 14 ++++++++------ .../Invoke-WebRequest.md | 4 +++- .../7/Microsoft.PowerShell.Utility/Out-String.md | 6 +++++- .../7/Microsoft.PowerShell.Utility/Sort-Object.md | 4 ++++ 12 files changed, 49 insertions(+), 13 deletions(-) diff --git a/reference/6/Microsoft.PowerShell.Management/Get-ChildItem.md b/reference/6/Microsoft.PowerShell.Management/Get-ChildItem.md index e0ee95ce39be..aefd746692de 100644 --- a/reference/6/Microsoft.PowerShell.Management/Get-ChildItem.md +++ b/reference/6/Microsoft.PowerShell.Management/Get-ChildItem.md @@ -525,6 +525,8 @@ recursion, but does not recurse into them. Use the **FollowSymlink** parameter t directories that target those symbolic links. The **FollowSymlink** is a dynamic parameter and is supported only in the **FileSystem** provider. +This parameter was introduced in PowerShell 6.0. + ```yaml Type: SwitchParameter Parameter Sets: (All) diff --git a/reference/6/Microsoft.PowerShell.Management/Split-Path.md b/reference/6/Microsoft.PowerShell.Management/Split-Path.md index 6c98822c76a4..d639eeb4683b 100644 --- a/reference/6/Microsoft.PowerShell.Management/Split-Path.md +++ b/reference/6/Microsoft.PowerShell.Management/Split-Path.md @@ -170,6 +170,8 @@ Accept wildcard characters: False Indicates that this cmdlet returns only the extension of the leaf. For example, in the path `C:\Test\Logs\Pass1.log`, it returns only `.log`. +This parameter was introduced in PowerShell 6.0. + ```yaml Type: SwitchParameter Parameter Sets: ExtensionSet @@ -221,6 +223,8 @@ Accept wildcard characters: False Indicates that this cmdlet returns only base name of the leaf. For example, in the path `C:\Test\Logs\Pass1.log`, it returns only `Pass1`. +This parameter was introduced in PowerShell 6.0. + ```yaml Type: SwitchParameter Parameter Sets: LeafBaseSet diff --git a/reference/6/Microsoft.PowerShell.Utility/Invoke-RestMethod.md b/reference/6/Microsoft.PowerShell.Utility/Invoke-RestMethod.md index 538e5448267f..c1028ad21f07 100644 --- a/reference/6/Microsoft.PowerShell.Utility/Invoke-RestMethod.md +++ b/reference/6/Microsoft.PowerShell.Utility/Invoke-RestMethod.md @@ -326,7 +326,7 @@ Specifies the content type of the web request. If this parameter is omitted and the request method is POST, `Invoke-RestMethod` sets the content type to `application/x-www-form-urlencoded`. Otherwise, the content type is not specified in the call. -**-ContentType** will be overridden when a `MultipartFormDataContent` object is supplied for **-Body**. +**ContentType** will be overridden when a `MultipartFormDataContent` object is supplied for **Body**. ```yaml Type: String @@ -373,12 +373,10 @@ Accept wildcard characters: False ### -CustomMethod -Specifies custom method used for the web request. This can be used with the Request Method required by the endpoint is not an available option on the **-Method**. **-Method** and **-CustomMethod** cannot be used together. +Specifies custom method used for the web request. This can be used with the Request Method required by the endpoint is not an available option on the **Method**. **Method** and **CustomMethod** cannot be used together. Example: - - Invoke-WebRequest -uri 'https://api.contoso.com/widget/' -CustomMethod 'TEST' This makes a `TEST` HTTP request to the API. @@ -627,6 +625,8 @@ Indicates that the cmdlet will not use a proxy to reach the destination. When you need to bypass the proxy configured in Internet Explorer, or a proxy specified in the environment, use this switch. +This parameter was introduced in PowerShell 6.0. + ```yaml Type: SwitchParameter Parameter Sets: StandardMethodNoProxy, CustomMethodNoProxy @@ -962,6 +962,8 @@ The OAuth or Bearer token to include in the request. **-Token** is required by c `Invoke-RestMethod -Uri $uri -Authentication OAuth -Token (Read-Host -AsSecureString)` +This parameter was introduced in PowerShell 6.0. + ```yaml Type: SecureString Parameter Sets: (All) diff --git a/reference/6/Microsoft.PowerShell.Utility/Invoke-WebRequest.md b/reference/6/Microsoft.PowerShell.Utility/Invoke-WebRequest.md index b5e0e1f6dbff..fa9d8a887d54 100644 --- a/reference/6/Microsoft.PowerShell.Utility/Invoke-WebRequest.md +++ b/reference/6/Microsoft.PowerShell.Utility/Invoke-WebRequest.md @@ -983,6 +983,8 @@ following: `Invoke-WebRequest -Uri $uri -Authentication OAuth -Token (Read-Host -AsSecureString)` +This parameter was introduced in PowerShell 6.0. + ```yaml Type: SecureString Parameter Sets: (All) diff --git a/reference/6/Microsoft.PowerShell.Utility/Out-String.md b/reference/6/Microsoft.PowerShell.Utility/Out-String.md index 7f93e6c86c55..4b6f5fc6fd42 100644 --- a/reference/6/Microsoft.PowerShell.Utility/Out-String.md +++ b/reference/6/Microsoft.PowerShell.Utility/Out-String.md @@ -119,7 +119,11 @@ Accept wildcard characters: False ``` ### -NoNewline -Removes all newlines from formatter generated output. Note that newlines present as part of string objects are preserved + +Removes all newlines from formatter generated output. Note that newlines present as part of string +objects are preserved. + +This parameter was introduced in PowerShell 6.0. ```yaml Type: SwitchParameter diff --git a/reference/6/Microsoft.PowerShell.Utility/Sort-Object.md b/reference/6/Microsoft.PowerShell.Utility/Sort-Object.md index 5c27df7626c0..d2c5bb9c7b3d 100644 --- a/reference/6/Microsoft.PowerShell.Utility/Sort-Object.md +++ b/reference/6/Microsoft.PowerShell.Utility/Sort-Object.md @@ -383,6 +383,8 @@ stable sort. Specifies the number of objects to get from the end of a sorted object array. This results in a stable sort. +This parameter was introduced in PowerShell 6.0. + ```yaml Type: Int32 Parameter Sets: Bottom @@ -504,6 +506,8 @@ Accept wildcard characters: True Specifies the number of objects to get from the start of a sorted object array. This results in a stable sort. +This parameter was introduced in PowerShell 6.0. + ```yaml Type: Int32 Parameter Sets: Top diff --git a/reference/7/Microsoft.PowerShell.Management/Get-ChildItem.md b/reference/7/Microsoft.PowerShell.Management/Get-ChildItem.md index 6e66426fde33..d2e5b9599833 100644 --- a/reference/7/Microsoft.PowerShell.Management/Get-ChildItem.md +++ b/reference/7/Microsoft.PowerShell.Management/Get-ChildItem.md @@ -525,6 +525,8 @@ recursion, but does not recurse into them. Use the **FollowSymlink** parameter t directories that target those symbolic links. The **FollowSymlink** is a dynamic parameter and is supported only in the **FileSystem** provider. +This parameter was introduced in PowerShell 6.0. + ```yaml Type: SwitchParameter Parameter Sets: (All) diff --git a/reference/7/Microsoft.PowerShell.Management/Split-Path.md b/reference/7/Microsoft.PowerShell.Management/Split-Path.md index f265446cbae6..853214bee1aa 100644 --- a/reference/7/Microsoft.PowerShell.Management/Split-Path.md +++ b/reference/7/Microsoft.PowerShell.Management/Split-Path.md @@ -170,6 +170,8 @@ Accept wildcard characters: False Indicates that this cmdlet returns only the extension of the leaf. For example, in the path `C:\Test\Logs\Pass1.log`, it returns only `.log`. +This parameter was introduced in PowerShell 6.0. + ```yaml Type: SwitchParameter Parameter Sets: ExtensionSet @@ -221,6 +223,8 @@ Accept wildcard characters: False Indicates that this cmdlet returns only base name of the leaf. For example, in the path `C:\Test\Logs\Pass1.log`, it returns only `Pass1`. +This parameter was introduced in PowerShell 6.0. + ```yaml Type: SwitchParameter Parameter Sets: LeafBaseSet diff --git a/reference/7/Microsoft.PowerShell.Utility/Invoke-RestMethod.md b/reference/7/Microsoft.PowerShell.Utility/Invoke-RestMethod.md index ed8c6b91f79c..ed8e944691d5 100644 --- a/reference/7/Microsoft.PowerShell.Utility/Invoke-RestMethod.md +++ b/reference/7/Microsoft.PowerShell.Utility/Invoke-RestMethod.md @@ -326,7 +326,7 @@ Specifies the content type of the web request. If this parameter is omitted and the request method is POST, `Invoke-RestMethod` sets the content type to `application/x-www-form-urlencoded`. Otherwise, the content type is not specified in the call. -**-ContentType** will be overridden when a `MultipartFormDataContent` object is supplied for **-Body**. +**ContentType** will be overridden when a `MultipartFormDataContent` object is supplied for **Body**. ```yaml Type: String @@ -373,12 +373,10 @@ Accept wildcard characters: False ### -CustomMethod -Specifies custom method used for the web request. This can be used with the Request Method required by the endpoint is not an available option on the **-Method**. **-Method** and **-CustomMethod** cannot be used together. +Specifies custom method used for the web request. This can be used with the Request Method required by the endpoint is not an available option on the **Method**. **Method** and **CustomMethod** cannot be used together. Example: - - Invoke-WebRequest -uri 'https://api.contoso.com/widget/' -CustomMethod 'TEST' This makes a `TEST` HTTP request to the API. @@ -417,10 +415,10 @@ Accept wildcard characters: False ### -FollowRelLink -Indicates the cmdlet should follow relation links. +Indicates the cmdlet should follow relation links. Some REST APIs support pagination via Relation Links per [RFC5988](https://tools.ietf.org/html/rfc5988#page-6). -Instead of parsing the header to get the URL for the next page, you can have the cmdlet do this for you. +Instead of parsing the header to get the URL for the next page, you can have the cmdlet do this for you. To set how many times to follow relation links, use the **MaximumFollowRelLink** parameter. When using this switch, the cmdlet returns a collection of pages of results. @@ -627,6 +625,8 @@ Indicates that the cmdlet will not use a proxy to reach the destination. When you need to bypass the proxy configured in Internet Explorer, or a proxy specified in the environment, use this switch. +This parameter was introduced in PowerShell 6.0. + ```yaml Type: SwitchParameter Parameter Sets: StandardMethodNoProxy, CustomMethodNoProxy @@ -962,6 +962,8 @@ The OAuth or Bearer token to include in the request. **-Token** is required by c `Invoke-RestMethod -Uri $uri -Authentication OAuth -Token (Read-Host -AsSecureString)` +This parameter was introduced in PowerShell 6.0. + ```yaml Type: SecureString Parameter Sets: (All) diff --git a/reference/7/Microsoft.PowerShell.Utility/Invoke-WebRequest.md b/reference/7/Microsoft.PowerShell.Utility/Invoke-WebRequest.md index dd743cd12e57..9baa98eba091 100644 --- a/reference/7/Microsoft.PowerShell.Utility/Invoke-WebRequest.md +++ b/reference/7/Microsoft.PowerShell.Utility/Invoke-WebRequest.md @@ -983,6 +983,8 @@ following: `Invoke-WebRequest -Uri $uri -Authentication OAuth -Token (Read-Host -AsSecureString)` +This parameter was introduced in PowerShell 6.0. + ```yaml Type: SecureString Parameter Sets: (All) @@ -1088,7 +1090,7 @@ such as Chrome, FireFox, InternetExplorer, Opera, and Safari. For example, the following command uses the user agent string for Internet Explorer ```powershell -Invoke-WebRequest -Uri http://website.com/ -UserAgent ([Microsoft.PowerShell.Commands.PSUserAgent]::InternetExplorer) +Invoke-WebRequest -Uri https://website.com/ -UserAgent ([Microsoft.PowerShell.Commands.PSUserAgent]::InternetExplorer) ``` ```yaml diff --git a/reference/7/Microsoft.PowerShell.Utility/Out-String.md b/reference/7/Microsoft.PowerShell.Utility/Out-String.md index 1f45f5c0fedf..0c1dd6e30da3 100644 --- a/reference/7/Microsoft.PowerShell.Utility/Out-String.md +++ b/reference/7/Microsoft.PowerShell.Utility/Out-String.md @@ -119,7 +119,11 @@ Accept wildcard characters: False ``` ### -NoNewline -Removes all newlines from formatter generated output. Note that newlines present as part of string objects are preserved + +Removes all newlines from formatter generated output. Note that newlines present as part of string +objects are preserved. + +This parameter was introduced in PowerShell 6.0. ```yaml Type: SwitchParameter diff --git a/reference/7/Microsoft.PowerShell.Utility/Sort-Object.md b/reference/7/Microsoft.PowerShell.Utility/Sort-Object.md index f76070ed529c..cdab47a95fe8 100644 --- a/reference/7/Microsoft.PowerShell.Utility/Sort-Object.md +++ b/reference/7/Microsoft.PowerShell.Utility/Sort-Object.md @@ -383,6 +383,8 @@ stable sort. Specifies the number of objects to get from the end of a sorted object array. This results in a stable sort. +This parameter was introduced in PowerShell 6.0. + ```yaml Type: Int32 Parameter Sets: Bottom @@ -504,6 +506,8 @@ Accept wildcard characters: True Specifies the number of objects to get from the start of a sorted object array. This results in a stable sort. +This parameter was introduced in PowerShell 6.0. + ```yaml Type: Int32 Parameter Sets: Top