Connectors Reference

Azure Kusto

Kusto is a log analytics cloud platform optimized for ad-hoc big data queries. Read more about it here: http://aka.ms/kdocs

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

listKustoResultsPost (QueryAndListSchema body)

Run query and list results

listKustoResultsSchemaPost (QueryAndListSchema body)

Query schema

runKustoQueryAndVisualizeResultsPost (QueryAndVisualizeSchema body)

Run query and visualize results

runKustoCommandAndVisualizeResultsPost (CommandAndVisualizeSchema body)

Run control command and visualize results

retrieveKustoAsyncResult (string operationId)

Retrieve Kusto async result

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

CommandAndVisualizeSchema

 

Object

 

QueryAndListSchema

 

QueryAndVisualizeSchema

 

Row

 

Table

 

VisualizeResults

 

 

Actions:

listKustoResultsPost

Summary: Run query and list results

Description: Runs the query and returns the result as a set of rows which can be iterated over in the following connectors.

 

Syntax:

AzureKusto.listKustoResultsPost (QueryAndListSchema body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

QueryAndListSchema

 

 

True

 

Returns:

          Type:Table

 

listKustoResultsSchemaPost

Summary: Query schema

Description: Gets the schema for a query

 

Syntax:

AzureKusto.listKustoResultsSchemaPost (QueryAndListSchema body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

QueryAndListSchema

 

 

True

 

Returns:

          Type:Object

 

runKustoQueryAndVisualizeResultsPost

Summary: Run query and visualize results

Description: Returns the Kusto query result as a chart of your choice.

 

Syntax:

AzureKusto.runKustoQueryAndVisualizeResultsPost (QueryAndVisualizeSchema body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

QueryAndVisualizeSchema

 

 

True

 

Returns:

          Type:VisualizeResults

 

runKustoCommandAndVisualizeResultsPost

Summary: Run control command and visualize results

Description: Returns the Kusto control command result as a chart of your choice.

 

Syntax:

AzureKusto.runKustoCommandAndVisualizeResultsPost (CommandAndVisualizeSchema body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CommandAndVisualizeSchema

 

 

True

 

Returns:

          Type:VisualizeResults

 

retrieveKustoAsyncResult

Summary: Retrieve Kusto async result

Description: Retrieve status and result of Kusto async operation

 

Syntax:

AzureKusto.retrieveKustoAsyncResult (string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

(Operation ID)

Unique identifier of the async operation

True

 

Returns:

          Type:Object

 


 

CommandAndVisualizeSchema

Summary:

Description:

 

          Properties:

Name

Type

Summary

cluster

string

Cluster Name

Specify the cluster name

db

string

Database Name

Specify the database name

csl

string

Control Command

Specify the control command you would like to run

chartType

string

Chart Type

Specify the resulting chart type  Values: [Html Table, Pie Chart, Time Chart, Bar Chart]


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

QueryAndListSchema

Summary:

Description:

 

          Properties:

Name

Type

Summary

cluster

string

Cluster Name

Specify the cluster name

db

string

Database Name

Specify the database name

csl

string

Query

Specify the query you would like to run


 

QueryAndVisualizeSchema

Summary:

Description:

 

          Properties:

Name

Type

Summary

cluster

string

Cluster Name

Specify the cluster name

db

string

Database Name

Specify the database name

csl

string

Query

Specify the query you would like to run

chartType

string

Chart Type

Specify the resulting chart type  Values: [Html Table, Pie Chart, Time Chart, Bar Chart]


 

Row

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Table

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (Row)

 

 


 

VisualizeResults

Summary:

Description:

 

          Properties:

Name

Type

Summary

body

string(byte)

Body

The body of the result.

attachmentContent

string(byte)

Attachment Content

The content of the attachment.

attachmentName

string

Attachment Name

The name of the attachment file.