HttpClient.GetAsync Method

Definition

Namespace:: System.Net.Http

Assembly:: System.Net.Http.dll

Assembly:: netstandard.dll

Send a GET request to the specified Uri as an asynchronous operation.

Overloads

GetAsync(String)	Send a GET request to the specified Uri as an asynchronous operation.
GetAsync(Uri)	Send a GET request to the specified Uri as an asynchronous operation.
GetAsync(String, HttpCompletionOption)	Send a GET request to the specified Uri with an HTTP completion option as an asynchronous operation.
GetAsync(String, CancellationToken)	Send a GET request to the specified Uri with a cancellation token as an asynchronous operation.
GetAsync(Uri, HttpCompletionOption)	Send a GET request to the specified Uri with an HTTP completion option as an asynchronous operation.
GetAsync(Uri, CancellationToken)	Send a GET request to the specified Uri with a cancellation token as an asynchronous operation.
GetAsync(String, HttpCompletionOption, CancellationToken)	Send a GET request to the specified Uri with an HTTP completion option and a cancellation token as an asynchronous operation.
GetAsync(Uri, HttpCompletionOption, CancellationToken)	Send a GET request to the specified Uri with an HTTP completion option and a cancellation token as an asynchronous operation.

Remarks

The operation will not block.

GetAsync(String)

Send a GET request to the specified Uri as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(System::String ^ requestUri);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (string requestUri);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (string? requestUri);

member this.GetAsync : string -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As String) As Task(Of HttpResponseMessage)

Parameters

requestUri: String

The Uri the request is sent to.

Returns

Task<HttpResponseMessage>

The task object representing the asynchronous operation.

Exceptions

InvalidOperationException

The requestUri must be an absolute URI or BaseAddress must be set.

HttpRequestException

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.

TaskCanceledException

.NET Core and .NET 5.0 and later only: The request failed due to timeout.

Remarks

This operation will not block. The returned Task<TResult> object will complete after the whole response (including content) is read.

Note

In case of timeout, different exceptions are thrown on different .NET implementations.

HttpRequestException is thrown on all applicable .NET Framework versions.
TaskCanceledException without any inner exception is thrown on all applicable .NET Core versions.
TaskCanceledException that nests a TimeoutException is thrown on .NET 5.0 and later versions.

Applies to

GetAsync(Uri)

Send a GET request to the specified Uri as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(Uri ^ requestUri);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (Uri requestUri);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (Uri? requestUri);

member this.GetAsync : Uri -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As Uri) As Task(Of HttpResponseMessage)

Parameters

requestUri: Uri

The Uri the request is sent to.

Returns

Task<HttpResponseMessage>

The task object representing the asynchronous operation.

Exceptions

InvalidOperationException

The requestUri must be an absolute URI or BaseAddress must be set.

HttpRequestException

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.

TaskCanceledException

.NET Core and .NET 5.0 and later only: The request failed due to timeout.

Remarks

This operation will not block. The returned Task<TResult> object will complete after the whole response (including content) is read.

Note

In case of timeout, different exceptions are thrown on different .NET implementations.

HttpRequestException is thrown on all applicable .NET Framework versions.
TaskCanceledException without any inner exception is thrown on all applicable .NET Core versions.
TaskCanceledException that nests a TimeoutException is thrown on .NET 5.0 and later versions.

Applies to

GetAsync(String, HttpCompletionOption)

Send a GET request to the specified Uri with an HTTP completion option as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(System::String ^ requestUri, System::Net::Http::HttpCompletionOption completionOption);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (string requestUri, System.Net.Http.HttpCompletionOption completionOption);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (string? requestUri, System.Net.Http.HttpCompletionOption completionOption);

member this.GetAsync : string * System.Net.Http.HttpCompletionOption -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As String, completionOption As HttpCompletionOption) As Task(Of HttpResponseMessage)

Parameters

requestUri: String

The Uri the request is sent to.

completionOption: HttpCompletionOption

An HTTP completion option value that indicates when the operation should be considered completed.

Returns

Task<HttpResponseMessage>

The task object representing the asynchronous operation.

Exceptions

InvalidOperationException

The requestUri must be an absolute URI or BaseAddress must be set.

HttpRequestException

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.

TaskCanceledException

.NET Core and .NET 5.0 and later only: The request failed due to timeout.

Remarks

This operation will not block. The returned Task<TResult> object will complete based on the completionOption parameter after the part or all of the response (including content) is read.

Note

In case of timeout, different exceptions are thrown on different .NET implementations.

HttpRequestException is thrown on all applicable .NET Framework versions.
TaskCanceledException without any inner exception is thrown on all applicable .NET Core versions.
TaskCanceledException that nests a TimeoutException is thrown on .NET 5.0 and later versions.

Applies to

GetAsync(String, CancellationToken)

Send a GET request to the specified Uri with a cancellation token as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(System::String ^ requestUri, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (string requestUri, System.Threading.CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (string? requestUri, System.Threading.CancellationToken cancellationToken);

member this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As String, cancellationToken As CancellationToken) As Task(Of HttpResponseMessage)

Parameters

requestUri: String

The Uri the request is sent to.

cancellationToken: CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<HttpResponseMessage>

The task object representing the asynchronous operation.

Exceptions

InvalidOperationException

The requestUri must be an absolute URI or BaseAddress must be set.

HttpRequestException

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.

TaskCanceledException

.NET Core and .NET 5.0 and later only: The request failed due to timeout.

Remarks

This operation will not block. The returned Task<TResult> object will complete after the whole response (including content) is read.

Note

In case of timeout, different exceptions are thrown on different .NET implementations.

HttpRequestException is thrown on all applicable .NET Framework versions.
TaskCanceledException without any inner exception is thrown on all applicable .NET Core versions.
TaskCanceledException that nests a TimeoutException is thrown on .NET 5.0 and later versions.

Applies to

GetAsync(Uri, HttpCompletionOption)

Send a GET request to the specified Uri with an HTTP completion option as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(Uri ^ requestUri, System::Net::Http::HttpCompletionOption completionOption);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (Uri requestUri, System.Net.Http.HttpCompletionOption completionOption);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (Uri? requestUri, System.Net.Http.HttpCompletionOption completionOption);

member this.GetAsync : Uri * System.Net.Http.HttpCompletionOption -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As Uri, completionOption As HttpCompletionOption) As Task(Of HttpResponseMessage)

Parameters

requestUri: Uri

The Uri the request is sent to.

completionOption: HttpCompletionOption

An HTTP completion option value that indicates when the operation should be considered completed.

Returns

Task<HttpResponseMessage>

The task object representing the asynchronous operation.

Exceptions

InvalidOperationException

The requestUri must be an absolute URI or BaseAddress must be set.

HttpRequestException

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.

TaskCanceledException

.NET Core and .NET 5.0 and later only: The request failed due to timeout.

Remarks

This operation will not block. The returned Task<TResult> object will complete based on the completionOption parameter after the part or all of the response (including content) is read.

Note

In case of timeout, different exceptions are thrown on different .NET implementations.

HttpRequestException is thrown on all applicable .NET Framework versions.
TaskCanceledException without any inner exception is thrown on all applicable .NET Core versions.
TaskCanceledException that nests a TimeoutException is thrown on .NET 5.0 and later versions.

Applies to

GetAsync(Uri, CancellationToken)

Send a GET request to the specified Uri with a cancellation token as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(Uri ^ requestUri, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (Uri requestUri, System.Threading.CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (Uri? requestUri, System.Threading.CancellationToken cancellationToken);

member this.GetAsync : Uri * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As Uri, cancellationToken As CancellationToken) As Task(Of HttpResponseMessage)

Parameters

requestUri: Uri

The Uri the request is sent to.

cancellationToken: CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<HttpResponseMessage>

The task object representing the asynchronous operation.

Exceptions

InvalidOperationException

The requestUri must be an absolute URI or BaseAddress must be set.

HttpRequestException

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.

TaskCanceledException

.NET Core and .NET 5.0 and later only: The request failed due to timeout.

Remarks

This operation will not block. The returned Task<TResult> object will complete after the whole response (including content) is read.

Note

In case of timeout, different exceptions are thrown on different .NET implementations.

HttpRequestException is thrown on all applicable .NET Framework versions.
TaskCanceledException without any inner exception is thrown on all applicable .NET Core versions.
TaskCanceledException that nests a TimeoutException is thrown on .NET 5.0 and later versions.

Applies to

GetAsync(String, HttpCompletionOption, CancellationToken)

Send a GET request to the specified Uri with an HTTP completion option and a cancellation token as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(System::String ^ requestUri, System::Net::Http::HttpCompletionOption completionOption, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (string requestUri, System.Net.Http.HttpCompletionOption completionOption, System.Threading.CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (string? requestUri, System.Net.Http.HttpCompletionOption completionOption, System.Threading.CancellationToken cancellationToken);

member this.GetAsync : string * System.Net.Http.HttpCompletionOption * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As String, completionOption As HttpCompletionOption, cancellationToken As CancellationToken) As Task(Of HttpResponseMessage)

Parameters

requestUri: String

The Uri the request is sent to.

completionOption: HttpCompletionOption

An HTTP completion option value that indicates when the operation should be considered completed.

cancellationToken: CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<HttpResponseMessage>

The task object representing the asynchronous operation.

Exceptions

InvalidOperationException

The requestUri must be an absolute URI or BaseAddress must be set.

HttpRequestException

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.

TaskCanceledException

.NET Core and .NET 5.0 and later only: The request failed due to timeout.

Remarks

This operation will not block. The returned Task<TResult> object will complete based on the completionOption parameter after the part or all of the response (including content) is read.

Note

In case of timeout, different exceptions are thrown on different .NET implementations.

HttpRequestException is thrown on all applicable .NET Framework versions.
TaskCanceledException without any inner exception is thrown on all applicable .NET Core versions.
TaskCanceledException that nests a TimeoutException is thrown on .NET 5.0 and later versions.

Applies to

GetAsync(Uri, HttpCompletionOption, CancellationToken)

Send a GET request to the specified Uri with an HTTP completion option and a cancellation token as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(Uri ^ requestUri, System::Net::Http::HttpCompletionOption completionOption, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (Uri requestUri, System.Net.Http.HttpCompletionOption completionOption, System.Threading.CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync (Uri? requestUri, System.Net.Http.HttpCompletionOption completionOption, System.Threading.CancellationToken cancellationToken);

member this.GetAsync : Uri * System.Net.Http.HttpCompletionOption * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As Uri, completionOption As HttpCompletionOption, cancellationToken As CancellationToken) As Task(Of HttpResponseMessage)

Parameters

requestUri: Uri

The Uri the request is sent to.

completionOption: HttpCompletionOption

An HTTP completion option value that indicates when the operation should be considered completed.

cancellationToken: CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<HttpResponseMessage>

The task object representing the asynchronous operation.

Exceptions

InvalidOperationException

The requestUri must be an absolute URI or BaseAddress must be set.

HttpRequestException

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.

TaskCanceledException

.NET Core and .NET 5.0 and later only: The request failed due to timeout.

Remarks

This operation will not block. The returned Task<TResult> object will complete based on the completionOption parameter after the part or all of the response (including content) is read.

Note

In case of timeout, different exceptions are thrown on different .NET implementations.

HttpRequestException is thrown on all applicable .NET Framework versions.
TaskCanceledException without any inner exception is thrown on all applicable .NET Core versions.
TaskCanceledException that nests a TimeoutException is thrown on .NET 5.0 and later versions.

Applies to

HttpClient.GetAsync Method

Definition

Overloads

Remarks

GetAsync(String)

Parameters

Returns

Exceptions

Remarks

Applies to

GetAsync(Uri)

Parameters

Returns

Exceptions

Remarks

Applies to

GetAsync(String, HttpCompletionOption)

Parameters

Returns

Exceptions

Remarks

Applies to

GetAsync(String, CancellationToken)

Parameters

Returns

Exceptions

Remarks

Applies to

GetAsync(Uri, HttpCompletionOption)

Parameters

Returns

Exceptions

Remarks

Applies to

GetAsync(Uri, CancellationToken)

Parameters

Returns

Exceptions

Remarks

Applies to

GetAsync(String, HttpCompletionOption, CancellationToken)

Parameters

Returns

Exceptions

Remarks

Applies to

GetAsync(Uri, HttpCompletionOption, CancellationToken)

Parameters

Returns

Exceptions

Remarks

Applies to

Is this page helpful?

Is this page helpful?