`HttpClient.GetStreamAsync` raising `HttpRequestException`

[roy-cohen273]

Issue description

The docs for HttpClient.GetStreamAsync state that an HttpRequestException will be raised if:

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation (or timeout for .NET Framework only).

However, an HttpRequestException is also raised when the request completes with a non-success status code.

Target framework

• .NET Core (3.1, 5, 6, 7)
• .NET Framework
• .NET Standard

dotnet --info output or About VS info

<replace>

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Issue description

The docs for HttpClient.GetStreamAsync state that an HttpRequestException will be raised if:

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation (or timeout for .NET Framework only).

However, an HttpRequestException is also raised when the request completes with a non-success status code.

Target framework

• .NET Core (3.1, 5, 6, 7)
• .NET Framework
• .NET Standard

dotnet --info output or About VS info

<replace>

Author:	roy-cohen273
Assignees:	-
Labels:	area-System.Net, untriaged, Pri3, :watch: Not Triaged
Milestone:	-

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/ncl

[MihaZupan]

Copying from dotnet/runtime#113177 (comment)

We do see value in improving our documentation to:

• Call out where we are using these checks ourselves and you can't control it, i.e. all HttpClient.Get{String/ByteArray/Stream/FromJson}Async helpers - HttpClient.GetStreamAsync raising HttpRequestException #9148.
• Include a note along the lines of "consider checking that HttpResponseMessage.StatusCode exactly matches the expected value instead".
• Consider improving indicates if the HTTP response was successful to include its definition of "successful". it already does in Returns: section.