az_kusto: Kusto/Azure Data Explorer cluster resource class

Description Methods Initialization Databases Super class Methods See Also Examples

Description

Class representing a Kusto cluster, exposing methods for working with it.

Methods

The following methods are available, in addition to those provided by the AzureRMR::az_resource class:

Initialization

Initializing a new object of this class can either retrieve an existing Kusto cluster, or create a new cluster on the host. Generally, the best way to initialize an object is via the get_kusto_cluster and create_kusto_cluster methods of the az_resource_group class, which handle the details automatically.

Databases

A Kusto cluster can have several databases, which are represented in AzureKusto via az_kusto_database R6 objects. The az_kusto class provides the create_database, get_database, delete_database and list_databases methods for creating, deleting and retrieving databases. It's recommended to use these methods rather than calling az_kusto_database$new() directly.

create_database takes the following arguments. It returns an object of class az_kusto_database

get_database takes a single argument database, the name of the database to retrieve, and returns an object of class az_kusto_database. delete_database takes the name of the database to delete and returns NULL on a successful deletion. list_databases takes no arguments and returns a list of az_kusto_database objects, one for each database in the cluster.

Super class

AzureRMR::az_resource -> az_kusto

Methods

Public methods

Inherited methods

Method start()

Usage
az_kusto$start()

Method stop()

Usage
az_kusto$stop()

Method create_database()

Usage
az_kusto$create_database(database, retention_period = 3650, cache_period = 31)

Method get_database()

Usage
az_kusto$get_database(database)

Method delete_database()

Usage
az_kusto$delete_database(database, confirm = TRUE)

Method list_databases()

Usage
az_kusto$list_databases()

Method get_default_tenant()

Usage
az_kusto$get_default_tenant()

Method get_query_token()

Usage
az_kusto$get_query_token(tenant = self$get_default_tenant(), ...)

Method get_ingestion_token()

Usage
az_kusto$get_ingestion_token(tenant = self$get_default_tenant(), ...)

Method clone()

The objects of this class are cloneable with this method.

Usage
az_kusto$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

az_kusto_database, kusto_database_endpoint, create_kusto_cluster, get_kusto_cluster, delete_kusto_cluster, get_kusto_token

Kusto/Azure Data Explorer documentation,

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
## Not run: 

# recommended way of retrieving a resource: via a resource group object
kus <- resgroup$get_kusto_cluster("mykusto")

# list databases
kust$list_databases()

# create a new database with a retention period of 6 months
kust$create_database("newdb", retention_period=180)

# get the default authentication tenant
kus$get_default_tenant()

# generate an authentication token
kust$get_aad_token()


## End(Not run)

AzureKusto documentation built on April 28, 2020, 1:06 a.m.