OperationalInsightsDataClient.QueryWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.OperationalInsights

Assembly:

Microsoft.Azure.OperationalInsights.dll

Package:

Microsoft.Azure.OperationalInsights v1.1.0

Source:

OperationalInsightsDataClient.cs

Execute an Analytics query

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.OperationalInsights.Models.QueryResults>> QueryWithHttpMessagesAsync (string query, TimeSpan? timespan = default, System.Collections.Generic.IList<string> workspaces = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member QueryWithHttpMessagesAsync : string * Nullable<TimeSpan> * System.Collections.Generic.IList<string> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.OperationalInsights.Models.QueryResults>>
override this.QueryWithHttpMessagesAsync : string * Nullable<TimeSpan> * System.Collections.Generic.IList<string> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.OperationalInsights.Models.QueryResults>>

Public Function QueryWithHttpMessagesAsync (query As String, Optional timespan As Nullable(Of TimeSpan) = Nothing, Optional workspaces As IList(Of String) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of QueryResults))

Parameters

query

String

The query to execute.

timespan

Nullable<TimeSpan>

Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.

workspaces

IList<String>

A list of workspaces that are included in the query.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<HttpOperationResponse<QueryResults>>

Implements

QueryWithHttpMessagesAsync(String, Nullable<TimeSpan>, IList<String>, Dictionary<String,List<String>>, CancellationToken)

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null

Remarks

Executes an Analytics query for data.

Here is an example for using POST with an Analytics query.