Add PipeName parameter to Invoke-RestMethod and Invoke-WebRequest docs - #12345
Open
mdaneri wants to merge 3 commits into
Open
Add PipeName parameter to Invoke-RestMethod and Invoke-WebRequest docs#12345mdaneri wants to merge 3 commits into
mdaneri wants to merge 3 commits into
Conversation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document -PipeName parameter for Invoke-RestMethod / Invoke-WebRequest (PowerShell 7.6)
PR Summary
Documents the new
-PipeNameparameter for bothInvoke-RestMethodandInvoke-WebRequestin PowerShell 7.6.This parameter enables sending HTTP requests over a local Windows named pipe transport.
It supports scenarios where an HTTP-speaking service is exposed only via a named pipe rather than a TCP port.
Key points:
-PipeNamein both cmdlet help files.Example 10for Invoke-RestMethod,Example 12for Invoke-WebRequest).-PipeNameis Windows-only, local-only, and mutually exclusive with-UnixSocket.-UnixSocketparameter documentation.Related feature implementation PR:
(No functional engine changes are included in this PR—documentation only.)
Additional Details / Rationale
Some self-hosted or system components expose lightweight HTTP endpoints over named pipes instead of binding to a TCP socket (for isolation or reduced surface).
Documenting
-PipeNameimproves discoverability and provides parity with the previously documented-UnixSocketparameter.Changes Included
Invoke-RestMethod.md– new-PipeNameparameter section + example.Invoke-WebRequest.md– new-PipeNameparameter section + example.-UnixSocket, version note.Usage Snippets
Compatibility / Limitations
-UnixSocket.Related Work / Follow Ups (Optional)
PR Checklist