Class AzureDataExplorerQueryParameter

Known structure that is passed between the Query object and Telemetry Loader object

Inheritance

System.Object

AzureDataExplorerQueryParameter

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: STAIExtensions.Data.AzureDataExplorer.Queries

Assembly: STAIExtensions.Data.AzureDataExplorer.dll

Syntax

public class AzureDataExplorerQueryParameter

Constructors

AzureDataExplorerQueryParameter(String, String, Nullable<Boolean>, Nullable<Int32>)

Declaration

public AzureDataExplorerQueryParameter(string tableName, string alias, bool? orderByTimestampDesc = null, int? topRows = null)

Parameters

Type	Name	Description
System.String	tableName
System.String	alias
System.Nullable<System.Boolean>	orderByTimestampDesc
System.Nullable<System.Int32>	topRows

Properties

AgoDateTime

Gets or sets a fixed UTC date time to search data from

Declaration

public DateTimeOffset? AgoDateTime { get; set; }

Property Value

Type	Description
System.Nullable<DateTimeOffset>

AgoInterval

Gets or sets the interval to search data from. This works with the Ago Period AgoPeriod

Declaration

public int? AgoInterval { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

AgoPeriod

Gets or sets the period to start looking for data

Declaration

public AgoPeriod AgoPeriod { get; set; }

Property Value

Type	Description
AgoPeriod

AgoTimeSpan

Gets or sets a timespan to start searching for data from

Declaration

public TimeSpan? AgoTimeSpan { get; set; }

Property Value

Type	Description
System.Nullable<TimeSpan>

Alias

Gets or sets the Kusto Query Alias

Declaration

public string Alias { get; set; }

Property Value

Type	Description
System.String

OrderByTimestampDesc

Gets or sets a value to indicate if the results should be ordered by Time Stamp Desc

Declaration

public bool? OrderByTimestampDesc { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

TableName

Gets or sets the Kusto Query table name

Declaration

public string TableName { get; set; }

Property Value

Type	Description
System.String

TopRows

The maximum number of rows to return from the query

Declaration

public int? TopRows { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Methods

BuildKustoQuery()

Takes all the options specified and builds a Kusto Query that can be used by the telemetry loader

Declaration

public string BuildKustoQuery()

Returns

Type	Description
System.String

SetupQueryForCustom(DateTimeOffset)

Helper method to setup the query by a specified date to start fetching data from

Declaration

public void SetupQueryForCustom(DateTimeOffset agoDateTime)

Parameters

Type	Name	Description
DateTimeOffset	agoDateTime	The UTC date

SetupQueryForInterval(Int32, AgoPeriod)

Helper method to setup the query by an interval

Declaration

public void SetupQueryForInterval(int agoInterval, AgoPeriod agoPeriod)

Parameters

Type	Name	Description
System.Int32	agoInterval	The interval
AgoPeriod	agoPeriod	The type of interval

SetupQueryForTimespan(TimeSpan)

Helper method to setup the query by a Timespan

Declaration

public void SetupQueryForTimespan(TimeSpan agoTimespan)

Parameters

Type	Name	Description
TimeSpan	agoTimespan	The timespan to start fetching data from