TsiClient.server Reference

TsiClient.server is a set of utilities for querying the Azure Time Series Insights APIs directly from a browser or web client.

TsiClient.server consists in several Functions to abstract common operations made to the Azure Time Series Insights Query APIs.

Functions

TsiClient.server Functions are used for querying the Azure Time Series Insights APIs.

Functions are JSON in, JSON out by design; as specified in the Azure Time Series Insights API reference documentation.

Users can generate the necessary JSON for querying the APIs using classes in user interface such as .toTsx() for an AggregateExpression.

Alternatively, JSON can be generated programatically without using helper classes from TsiClient.ux.

getAggregates is used for querying the Get Environment Aggregates API.

The following code block demonstrates how to perform a query:

tsiClient.server.getAggregates(token, environmentFqdn, tsxArray)
    .then(function(result){
        console.log(result)
    })

Parameter name	Example value	Description
`token`	An Azure Active Directory (AAD) access token	A valid AAD access token
`environmentFqdn`	`10000000-0000-0000-0000-100000000108.env.timeseries.azure.com`	The environment FQDN
`tsxArray`	Array<Request Body>	The query in proper shape

getEvents is used for querying the Get Environment Events API.

The following code block demonstrates how to perform a query:

tsiClient.server.getEvents(token, environmentFqdn, tsxObject)
    .then(function(result){
        console.log(result)
    })

Parameter name	Example value	Description
`token`	An Azure Active Directory (AAD) access token	A valid AAD access token
`environmentFqdn`	`10000000-0000-0000-0000-100000000108.env.timeseries.azure.com`	The environment FQDN
`tsxObject`	Request Body	The query in proper shape

getTsqResults is used for querying the Azure TIme Series Insights Preview APIs.

The following code block demonstrates how to perform a query:

tsiClient.server.getTsqResults(token, environmentFqdn, tsqArray)
    .then(function(result){
        console.log(result)
    })

Parameter name	Example value	Description
`token`	An Azure Active Directory (AAD) access token	A valid AAD access token
`environmentFqdn`	`10000000-0000-0000-0000-100000000108.env.timeseries.azure.com`	The environment FQDN
`tsqArray`	Array<Request Body>	The query in proper shape