az_kusto_database: Kusto/Azure Data Explorer database resource class

Description Methods Initialization Principals Super class Methods See Also Examples

Description

Class representing a Kusto database, 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 database, or create a new database on the server. Generally, the best way to initialize an object is via the get_database, list_databases() and create_database methods of the az_kusto class, which handle the details automatically.

Principals

This class provides methods for managing the principals of a database.

add_principal takes the following arguments. It returns a data frame with one row per principal, containing the details for each principal.

remove_principal removes a principal. It takes the same arguments as add_principal; if the supplied details do not match the actual details for the principal, it is not removed.

Super class

AzureRMR::az_resource -> az_kusto_database

Methods

Public methods

Inherited methods

Method new()

Usage
az_kusto_database$new(..., kusto_cluster = self$cluster)

Method delete()

Usage
az_kusto_database$delete(..., confirm = TRUE)

Method add_principals()

Usage
az_kusto_database$add_principals(
  name,
  role = "User",
  type = "User",
  fqn = "",
  email = "",
  app_id = ""
)

Method remove_principals()

Usage
az_kusto_database$remove_principals(
  name,
  role = "User",
  type = "User",
  fqn = "",
  email = "",
  app_id = ""
)

Method list_principals()

Usage
az_kusto_database$list_principals()

Method get_database_endpoint()

Usage
az_kusto_database$get_database_endpoint(
  tenant = NULL,
  user = NULL,
  pwd = NULL,
  ...
)

Method clone()

The objects of this class are cloneable with this method.

Usage
az_kusto_database$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

az_kusto, kusto_database_endpoint, create_database, get_database, delete_database

Kusto/Azure Data Explorer documentation,

Examples

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

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

# list principals
db$list_principals()

# add a new principal
db$add_principal("New User", role="User", fqn="aaduser=username@mydomain")

# get the endpoint
db$get_database_endpoint(use_integer64=FALSE)


## End(Not run)

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