Skip to content

Commit 2fcbe52

Browse files
committed
Update parameter description
1 parent ac5b9db commit 2fcbe52

2 files changed

Lines changed: 80 additions & 71 deletions

File tree

reference/7.6/Microsoft.PowerShell.Utility/Invoke-RestMethod.md

Lines changed: 46 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ Invoke-RestMethod [-FollowRelLink] [-MaximumFollowRelLink <Int32>]
3232
[-SkipHeaderValidation] [-AllowInsecureRedirect] [-MaximumRedirection <Int32>]
3333
[-MaximumRetryCount <Int32>] [-PreserveAuthorizationOnRedirect] [-RetryIntervalSec <Int32>]
3434
[-Method <WebRequestMethod>] [-PreserveHttpMethodOnRedirect]
35-
[-UnixSocket <UnixDomainSocketEndPoint>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>]
36-
[-ProxyUseDefaultCredentials] [-Body <Object>] [-Form <IDictionary>] [-ContentType <String>]
37-
[-TransferEncoding <String>] [-InFile <String>] [-OutFile <String>] [-PassThru] [-Resume]
38-
[-SkipHttpErrorCheck] [<CommonParameters>]
35+
[-UnixSocket <UnixDomainSocketEndPoint>] [-Pipename <String>] [-Proxy <Uri>]
36+
[-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-Body <Object>]
37+
[-Form <IDictionary>] [-ContentType <String>] [-TransferEncoding <String>] [-InFile <String>]
38+
[-OutFile <String>] [-PassThru] [-Resume] [-SkipHttpErrorCheck] [<CommonParameters>]
3939
```
4040

4141
### StandardMethodNoProxy
@@ -52,9 +52,9 @@ Invoke-RestMethod [-FollowRelLink] [-MaximumFollowRelLink <Int32>]
5252
[-SkipHeaderValidation] [-AllowInsecureRedirect] [-MaximumRedirection <Int32>]
5353
[-MaximumRetryCount <Int32>] [-PreserveAuthorizationOnRedirect] [-RetryIntervalSec <Int32>]
5454
[-Method <WebRequestMethod>] [-PreserveHttpMethodOnRedirect]
55-
[-UnixSocket <UnixDomainSocketEndPoint>] [-NoProxy] [-Body <Object>] [-Form <IDictionary>]
56-
[-ContentType <String>] [-TransferEncoding <String>] [-InFile <String>] [-OutFile <String>]
57-
[-PassThru] [-Resume] [-SkipHttpErrorCheck] [<CommonParameters>]
55+
[-UnixSocket <UnixDomainSocketEndPoint>] [-Pipename <String>] [-NoProxy] [-Body <Object>]
56+
[-Form <IDictionary>] [-ContentType <String>] [-TransferEncoding <String>] [-InFile <String>]
57+
[-OutFile <String>] [-PassThru] [-Resume] [-SkipHttpErrorCheck] [<CommonParameters>]
5858
```
5959

6060
### CustomMethod
@@ -71,9 +71,10 @@ Invoke-RestMethod [-FollowRelLink] [-MaximumFollowRelLink <Int32>]
7171
[-SkipHeaderValidation] [-AllowInsecureRedirect] [-MaximumRedirection <Int32>]
7272
[-MaximumRetryCount <Int32>] [-PreserveAuthorizationOnRedirect] [-RetryIntervalSec <Int32>]
7373
-CustomMethod <String> [-PreserveHttpMethodOnRedirect] [-UnixSocket <UnixDomainSocketEndPoint>]
74-
[-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-Body <Object>]
75-
[-Form <IDictionary>] [-ContentType <String>] [-TransferEncoding <String>] [-InFile <String>]
76-
[-OutFile <String>] [-PassThru] [-Resume] [-SkipHttpErrorCheck] [<CommonParameters>]
74+
[-Pipename <String>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials]
75+
[-Body <Object>] [-Form <IDictionary>] [-ContentType <String>] [-TransferEncoding <String>]
76+
[-InFile <String>] [-OutFile <String>] [-PassThru] [-Resume] [-SkipHttpErrorCheck]
77+
[<CommonParameters>]
7778
```
7879

7980
### CustomMethodNoProxy
@@ -90,7 +91,7 @@ Invoke-RestMethod [-FollowRelLink] [-MaximumFollowRelLink <Int32>]
9091
[-SkipHeaderValidation] [-AllowInsecureRedirect] [-MaximumRedirection <Int32>]
9192
[-MaximumRetryCount <Int32>] [-PreserveAuthorizationOnRedirect] [-RetryIntervalSec <Int32>]
9293
-CustomMethod <String> [-PreserveHttpMethodOnRedirect] [-UnixSocket <UnixDomainSocketEndPoint>]
93-
[-NoProxy] [-Body <Object>] [-Form <IDictionary>] [-ContentType <String>]
94+
[-Pipename <String>] [-NoProxy] [-Body <Object>] [-Form <IDictionary>] [-ContentType <String>]
9495
[-TransferEncoding <String>] [-InFile <String>] [-OutFile <String>] [-PassThru] [-Resume]
9596
[-SkipHttpErrorCheck] [<CommonParameters>]
9697
```
@@ -950,6 +951,40 @@ Accept pipeline input: False
950951
Accept wildcard characters: False
951952
```
952953

954+
### -PipeName
955+
956+
Specifies the name of a local Windows named pipe to use instead of a TCP socket when sending the
957+
HTTP request. This lets you communicate with services that expose an HTTP-compatible protocol over
958+
a named pipe without opening a TCP port.
959+
960+
Only the local machine is supported. Remote UNC pipe names aren't supported. Supplying a value that
961+
doesn't correspond to a listening named pipe endpoint results in a connection failure.
962+
963+
When you specify **PipeName**, the hostname portion of the **Uri** is ignored for network routing.
964+
The **Uri** still determines the request path, query, and scheme used to build the HTTP request. The
965+
named pipe transport is always local, but the hostname still appears in HTTP headers.
966+
967+
The server that creates the pipe governs security and access control for the pipe. This cmdlet,
968+
acting as the client, doesn't modify pipe ACLs.
969+
970+
The **PipeName** parameter is supported only on Windows operating systems. The values for
971+
**UnixSocket** and **PipeName** are mutually exclusive. If you specify both parameters, the cmdlet
972+
only uses the value of **UnixSocket**.
973+
974+
This parameter was added in PowerShell 7.6.
975+
976+
```yaml
977+
Type: System.String
978+
Parameter Sets: (All)
979+
Aliases:
980+
981+
Required: False
982+
Position: Named
983+
Default value: None
984+
Accept pipeline input: False
985+
Accept wildcard characters: False
986+
```
987+
953988
### -PreserveAuthorizationOnRedirect
954989

955990
Indicates the cmdlet should preserve the `Authorization` header, when present, across redirections.
@@ -1363,36 +1398,6 @@ Accept pipeline input: False
13631398
Accept wildcard characters: False
13641399
```
13651400

1366-
### -PipeName
1367-
1368-
Specifies the name of a local Windows named pipe to use instead of a TCP socket when sending the
1369-
HTTP request. This lets you communicate with services that expose an HTTP-compatible protocol over
1370-
a named pipe without opening a TCP port.
1371-
1372-
Only the local machine is supported. Remote UNC pipe names aren't supported. Supplying a value that
1373-
doesn't correspond to a listening named pipe endpoint results in a connection failure.
1374-
1375-
When you specify **PipeName**, the hostname portion of the **Uri** is ignored for network routing.
1376-
The **Uri** still determines the request path, query, and scheme used to build the HTTP request. The
1377-
named pipe transport is always local, but the hostname still appears in HTTP headers.
1378-
1379-
The server that creates the pipe governs security and access control for the pipe. This cmdlet,
1380-
acting as the client, doesn't modify pipe ACLs.
1381-
1382-
This parameter was added in PowerShell 7.6.
1383-
1384-
```yaml
1385-
Type: System.String
1386-
Parameter Sets: (All)
1387-
Aliases:
1388-
1389-
Required: False
1390-
Position: Named
1391-
Default value: None
1392-
Accept pipeline input: False
1393-
Accept wildcard characters: False
1394-
```
1395-
13961401
### -Uri
13971402

13981403
Specifies the Uniform Resource Identifier (URI) of the internet resource to which the web request is

reference/7.6/Microsoft.PowerShell.Utility/Invoke-WebRequest.md

Lines changed: 34 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -982,6 +982,40 @@ Accept pipeline input: False
982982
Accept wildcard characters: False
983983
```
984984

985+
### -PipeName
986+
987+
Specifies the name of a local Windows named pipe to use instead of a TCP socket when sending the
988+
HTTP request. This lets you communicate with services that expose an HTTP-compatible protocol over
989+
a named pipe without opening a TCP port.
990+
991+
Only the local machine is supported. Remote UNC pipe names aren't supported. Supplying a value that
992+
doesn't correspond to a listening named pipe endpoint results in a connection failure.
993+
994+
When you specify **PipeName**, the hostname portion of the **Uri** is ignored for network routing.
995+
The **Uri** still determines the request path, query, and scheme used to build the HTTP request. The
996+
named pipe transport is always local, but the hostname still appears in HTTP headers.
997+
998+
The server that creates the pipe governs security and access control for the pipe. This cmdlet,
999+
acting as the client, doesn't modify pipe ACLs.
1000+
1001+
The **PipeName** parameter is supported only on Windows operating systems. The values for
1002+
**UnixSocket** and **PipeName** are mutually exclusive. If you specify both parameters, the cmdlet
1003+
only uses the value of **UnixSocket**.
1004+
1005+
This parameter was added in PowerShell 7.6.
1006+
1007+
```yaml
1008+
Type: System.String
1009+
Parameter Sets: (All)
1010+
Aliases:
1011+
1012+
Required: False
1013+
Position: Named
1014+
Default value: None
1015+
Accept pipeline input: False
1016+
Accept wildcard characters: False
1017+
```
1018+
9851019
### -PreserveAuthorizationOnRedirect
9861020

9871021
Indicates the cmdlet should preserve the `Authorization` header, when present, across redirections.
@@ -1354,36 +1388,6 @@ Accept pipeline input: False
13541388
Accept wildcard characters: False
13551389
```
13561390

1357-
### -PipeName
1358-
1359-
Specifies the name of a local Windows named pipe to use instead of a TCP socket when sending the
1360-
HTTP request. This lets you communicate with services that expose an HTTP-compatible protocol over
1361-
a named pipe without opening a TCP port.
1362-
1363-
Only the local machine is supported. Remote UNC pipe names aren't supported. Supplying a value that
1364-
doesn't correspond to a listening named pipe endpoint results in a connection failure.
1365-
1366-
When you specify **PipeName**, the hostname portion of the **Uri** is ignored for network routing.
1367-
The **Uri** still determines the request path, query, and scheme used to build the HTTP request. The
1368-
named pipe transport is always local, but the hostname still appears in HTTP headers.
1369-
1370-
The server that creates the pipe governs security and access control for the pipe. This cmdlet,
1371-
acting as the client, doesn't modify pipe ACLs.
1372-
1373-
This parameter was added in PowerShell 7.6.
1374-
1375-
```yaml
1376-
Type: System.String
1377-
Parameter Sets: (All)
1378-
Aliases:
1379-
1380-
Required: False
1381-
Position: Named
1382-
Default value: None
1383-
Accept pipeline input: False
1384-
Accept wildcard characters: False
1385-
```
1386-
13871391
### -Uri
13881392

13891393
Specifies the Uniform Resource Identifier (URI) of the internet resource to which the web request is

0 commit comments

Comments
 (0)