Skip to content

Add QUERY method support for Invoke-WebRequest #28110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
soroshsabz wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add QUERY method support for Invoke-WebRequest #28110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9b24bd
Add QUERY method
soroshsabz Sep 25, 2026
ce30294
Merge branch 'master' into features/1-query-method
soroshsabz Sep 29, 2026
504641f
Merge branch 'master' into features/1-query-method
soroshsabz Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ...owerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2107,6 +2107,7 @@ 304 or (>= 400 and <= 599) => true,
WebRequestMethod.Put => HttpMethod.Put,
WebRequestMethod.Options => HttpMethod.Options,
WebRequestMethod.Trace => HttpMethod.Trace,
WebRequestMethod.Query => HttpMethod.Query,
_ => new HttpMethod(method.ToString().ToUpperInvariant())
};

Expand Down
5 changes: 5 additions & 0 deletions src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/WebRequestMethod.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,10 @@ public enum WebRequestMethod
/// PATCH method.
/// </summary>
Patch,

/// <summary>
/// QUERY method.
/// </summary>
Query,
}
}
71 changes: 71 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -873,6 +873,47 @@ Describe "Invoke-WebRequest tests" -Tags "Feature", "RequireAdminOnWindows" {
($result.Output.Content | ConvertFrom-Json).query | Should -Be "?testparam=testvalue"
}

It "Validate Invoke-WebRequest -Method Query is used and body is sent as request content" {
$uri = Get-WebListenerUrl -Test 'Query'
$command = "Invoke-WebRequest -Uri '$uri' -Method Query -Body @{'testparam'='testvalue'} -ContentType 'application/x-www-form-urlencoded'"
$result = ExecuteWebCommand -command $command
$result.Error | Should -BeNullOrEmpty
$jsonResult = $result.Output.Content | ConvertFrom-Json
$jsonResult.method | Should -Be "QUERY"
$jsonResult.form.testparam | Should -Be "testvalue"
# A hashtable body must be sent as the request content, not converted to URI query parameters
$jsonResult.args.testparam | Should -BeNullOrEmpty
}

It "Validate Invoke-WebRequest -Method Query with a string body" {
$uri = Get-WebListenerUrl -Test 'Query'
$command = "Invoke-WebRequest -Uri '$uri' -Method Query -Body '{`"testparam`":`"testvalue`"}' -ContentType 'application/json'"
$result = ExecuteWebCommand -command $command
$result.Error | Should -BeNullOrEmpty
$jsonResult = $result.Output.Content | ConvertFrom-Json
$jsonResult.method | Should -Be "QUERY"
$jsonResult.headers.'Content-Type' | Should -Match "application/json"
$jsonResult.data | Should -Be '{"testparam":"testvalue"}'
}

It "Validate Invoke-WebRequest -CustomMethod QUERY behaves like -Method Query" {
$uri = Get-WebListenerUrl -Test 'Query'
$command = "Invoke-WebRequest -Uri '$uri' -CustomMethod QUERY -Body @{'testparam'='testvalue'} -ContentType 'application/x-www-form-urlencoded'"
$result = ExecuteWebCommand -command $command
$result.Error | Should -BeNullOrEmpty
$jsonResult = $result.Output.Content | ConvertFrom-Json
$jsonResult.method | Should -Be "QUERY"
$jsonResult.form.testparam | Should -Be "testvalue"
}

It 'Validate Invoke-WebRequest empty body -Method Query' {
$uri = Get-WebListenerUrl -Test 'Query'
$command = "Invoke-WebRequest -Uri '$uri' -Method Query"
$result = ExecuteWebCommand -command $command
$result.Error | Should -BeNullOrEmpty
($result.Output.Content | ConvertFrom-Json).method | Should -Be "QUERY"
}

It "Validate Invoke-WebRequest returns HTTP errors in exception" {
$query = @{
body = "I am a teapot!!!"
Expand Down Expand Up @@ -2994,6 +3035,36 @@ Describe "Invoke-RestMethod tests" -Tags "Feature", "RequireAdminOnWindows" {
$result.Output.Query | Should -Be "?testparam=testvalue"
}

It "Validate Invoke-RestMethod -Method Query is used and body is sent as request content" {
$uri = Get-WebListenerUrl -Test 'Query'
$command = "Invoke-RestMethod -Uri '$uri' -Method Query -Body @{'testparam'='testvalue'} -ContentType 'application/x-www-form-urlencoded'"
$result = ExecuteWebCommand -command $command
$result.Error | Should -BeNullOrEmpty
$result.Output.method | Should -Be "QUERY"
$result.Output.form.testparam | Should -Be "testvalue"
# A hashtable body must be sent as the request content, not converted to URI query parameters
$result.Output.args.testparam | Should -BeNullOrEmpty
}

It "Validate Invoke-RestMethod -Method Query with a string body" {
$uri = Get-WebListenerUrl -Test 'Query'
$command = "Invoke-RestMethod -Uri '$uri' -Method Query -Body '{`"testparam`":`"testvalue`"}' -ContentType 'application/json'"
$result = ExecuteWebCommand -command $command
$result.Error | Should -BeNullOrEmpty
$result.Output.method | Should -Be "QUERY"
$result.Output.Headers.'Content-Type' | Should -Match "application/json"
$result.Output.data | Should -Be '{"testparam":"testvalue"}'
}

It "Validate Invoke-RestMethod -CustomMethod QUERY behaves like -Method Query" {
$uri = Get-WebListenerUrl -Test 'Query'
$command = "Invoke-RestMethod -Uri '$uri' -CustomMethod QUERY -Body @{'testparam'='testvalue'} -ContentType 'application/x-www-form-urlencoded'"
$result = ExecuteWebCommand -command $command
$result.Error | Should -BeNullOrEmpty
$result.Output.method | Should -Be "QUERY"
$result.Output.form.testparam | Should -Be "testvalue"
}

It "Validate Invoke-RestMethod returns HTTP errors in exception" {
$query = @{
body = "I am a teapot!!!"
Expand Down
5 changes: 5 additions & 0 deletions test/tools/WebListener/Startup.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,11 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
template: "Delete",
defaults: new { controller = "Get", action = "Index" },
constraints: new RouteValueDictionary(new { httpMethod = new HttpMethodRouteConstraint("DELETE") }));
routes.MapRoute(
name: "query",
template: "Query",
defaults: new { controller = "Get", action = "Index" },
constraints: new RouteValueDictionary(new { httpMethod = new HttpMethodRouteConstraint("QUERY") }));
routes.MapRoute(
name: "retry",
template: "Retry/{sessionId?}/{failureCode?}/{failureCount?}",
Expand Down