Microsoft.Kusto (preview:2017-09-07-privatepreview)

2025/09/26 • 27 new, 27 deleted methods

Clusters_Get (new)
Description :  Gets a Kusto cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_CreateOrUpdate (new)
Description :  Create or update a Kusto cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The Kusto cluster parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_Update (new)
Description :  Update a Kusto cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The Kusto cluster parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
etag:
{
Description: An ETag of the resource updated. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_Delete (new)
Description :  Deletes a Kusto cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_Stop (new)
Description :  Stops a Kusto cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/stop
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_Start (new)
Description :  Starts a Kusto cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/start
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_ListByResourceGroup (new)
Description :  Lists all Kusto clusters within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto clusters. ,
Required: False ,
}
[
{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_List (new)
Description :  Lists all Kusto clusters within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Kusto/clusters
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto clusters. ,
Required: False ,
}
[
{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_ListSkus (new)
Description :  Lists eligible SKUs for Kusto resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Kusto/skus
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of available SKUs for new resources. ,
Required: False ,
}
[
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_CheckNameAvailability (new)
Description :  Checks that the cluster name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Kusto/locations/{location}/checkNameAvailability
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Azure location. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
{
name:
{
Description: Cluster name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, Microsoft.Kusto/clusters. ,
Enum:
{
Microsoft.Kusto/clusters: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Specifies a Boolean value that indicates if the name is available. ,
Required: False ,
}
boolean ,
name:
{
Description: The name that was checked. ,
Required: False ,
}
string ,
message:
{
Description: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_CheckNameAvailability (new)
Description :  Checks that the database name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkNameAvailability
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
{
name:
{
Description: Database name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, Microsoft.Kusto/clusters/databases. ,
Enum:
{
Microsoft.Kusto/clusters/databases: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Specifies a Boolean value that indicates if the name is available. ,
Required: False ,
}
boolean ,
name:
{
Description: The name that was checked. ,
Required: False ,
}
string ,
message:
{
Description: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_ListSkusByResource (new)
Description :  Returns the SKUs available for the provided resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/skus
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of available SKUs for an existing resource. ,
Required: False ,
}
[
{
resourceType:
{
Description: Resource Namespace and Type. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU details. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
capacity:
{
Description: The SKU capacity. ,
Required: False ,
}
{
scaleType:
{
Description: Scale type. ,
Enum:
{
automatic: No description available. ,
manual: No description available. ,
none: No description available. ,
}
,
Required: True ,
}
enum ,
minimum:
{
Description: Minimum allowed capacity. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed capacity. ,
Required: True ,
}
integer ,
default:
{
Description: The default capacity that would be used. ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_ListByCluster (new)
Description :  Returns the list of databases of the given Kusto cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto databases. ,
Required: False ,
}
[
{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_Get (new)
Description :  Returns a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_CreateOrUpdate (new)
Description :  Creates or updates a database.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The database parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (201)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_Update (new)
Description :  Updates a database.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The database parameters supplied to the Update operation. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
etag:
{
Description: An ETag of the resource updated. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (201)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_Delete (new)
Description :  Deletes the database with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_ListPrincipals (new)
Description :  Returns a list of database principals of the given Kusto cluster and database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto database principals. ,
Required: False ,
}
[
{
role:
{
Description: Database principal role. ,
Enum:
{
Admin: No description available. ,
Ingestor: No description available. ,
Monitor: No description available. ,
User: No description available. ,
UnrestrictedViewers: No description available. ,
Viewer: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Database principal name. ,
Required: True ,
}
string ,
type:
{
Description: Database principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
fqn:
{
Description: Database principal fully qualified name. ,
Required: False ,
}
string ,
email:
{
Description: Database principal email if exists. ,
Required: False ,
}
string ,
appId:
{
Description: Application id - relevant only for application principal type. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_AddPrincipals (new)
Description :  Add Database principals permissions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/addPrincipals
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
databasePrincipalsToAdd:
{
Description: List of database principals to add. ,
Required: True ,
}
{
value:
{
Description: The list of Kusto database principals. ,
Required: False ,
}
[
{
role:
{
Description: Database principal role. ,
Enum:
{
Admin: No description available. ,
Ingestor: No description available. ,
Monitor: No description available. ,
User: No description available. ,
UnrestrictedViewers: No description available. ,
Viewer: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Database principal name. ,
Required: True ,
}
string ,
type:
{
Description: Database principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
fqn:
{
Description: Database principal fully qualified name. ,
Required: False ,
}
string ,
email:
{
Description: Database principal email if exists. ,
Required: False ,
}
string ,
appId:
{
Description: Application id - relevant only for application principal type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto database principals. ,
Required: False ,
}
[
{
role:
{
Description: Database principal role. ,
Enum:
{
Admin: No description available. ,
Ingestor: No description available. ,
Monitor: No description available. ,
User: No description available. ,
UnrestrictedViewers: No description available. ,
Viewer: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Database principal name. ,
Required: True ,
}
string ,
type:
{
Description: Database principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
fqn:
{
Description: Database principal fully qualified name. ,
Required: False ,
}
string ,
email:
{
Description: Database principal email if exists. ,
Required: False ,
}
string ,
appId:
{
Description: Application id - relevant only for application principal type. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_RemovePrincipals (new)
Description :  Remove Database principals permissions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/removePrincipals
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
databasePrincipalsToRemove:
{
Description: List of database principals to remove. ,
Required: True ,
}
{
value:
{
Description: The list of Kusto database principals. ,
Required: False ,
}
[
{
role:
{
Description: Database principal role. ,
Enum:
{
Admin: No description available. ,
Ingestor: No description available. ,
Monitor: No description available. ,
User: No description available. ,
UnrestrictedViewers: No description available. ,
Viewer: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Database principal name. ,
Required: True ,
}
string ,
type:
{
Description: Database principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
fqn:
{
Description: Database principal fully qualified name. ,
Required: False ,
}
string ,
email:
{
Description: Database principal email if exists. ,
Required: False ,
}
string ,
appId:
{
Description: Application id - relevant only for application principal type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto database principals. ,
Required: False ,
}
[
{
role:
{
Description: Database principal role. ,
Enum:
{
Admin: No description available. ,
Ingestor: No description available. ,
Monitor: No description available. ,
User: No description available. ,
UnrestrictedViewers: No description available. ,
Viewer: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Database principal name. ,
Required: True ,
}
string ,
type:
{
Description: Database principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
fqn:
{
Description: Database principal fully qualified name. ,
Required: False ,
}
string ,
email:
{
Description: Database principal email if exists. ,
Required: False ,
}
string ,
appId:
{
Description: Application id - relevant only for application principal type. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EventHubConnections_ListByDatabase (new)
Description :  Returns the list of Event Hub connections of the given Kusto database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto event hub connections. ,
Required: False ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EventHubConnections_eventhubConnectionValidation (new)
Description :  Checks that the Event Hub data connection parameters are valid.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubConnectionValidation
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
parameters:
{
Description: The Event Hub connection parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
eventhubConnectionName:
{
Description: The name of the event hub connection. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto event hub connection validation errors. ,
Required: False ,
}
[
{
errorMessage:
{
Description: A message which indicates a problem in event hub connection validation. ,
Required: False ,
}
string ,
}
,
]
,
}
EventHubConnections_Get (new)
Description :  Returns an Event Hub connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
eventHubConnectionName:
{
Description: The name of the event hub connection. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EventHubConnections_CreateOrUpdate (new)
Description :  Creates or updates a Event Hub connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
eventHubConnectionName:
{
Description: The name of the event hub connection. ,
Required: True ,
}
string ,
parameters:
{
Description: The Event Hub connection parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EventHubConnections_Update (new)
Description :  Updates a Event Hub connection.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
eventHubConnectionName:
{
Description: The name of the event hub connection. ,
Required: True ,
}
string ,
parameters:
{
Description: The Event Hub connection parameters supplied to the Update operation. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EventHubConnections_Delete (new)
Description :  Deletes the Event Hub connection with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
eventHubConnectionName:
{
Description: The name of the event hub connection. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (new)
Description :  Lists available operations for the Microsoft.Kusto provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Kusto/operations
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
name:
{
Description: This is of the format {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Required: False ,
}
{
provider:
{
Required: False ,
}
string ,
operation:
{
Description: For example: read, write, delete. ,
Required: False ,
}
string ,
resource:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
origin:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_Get (removed)
Description :  Gets a Kusto cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_CreateOrUpdate (removed)
Description :  Create or update a Kusto cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The Kusto cluster parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_Update (removed)
Description :  Update a Kusto cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The Kusto cluster parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
etag:
{
Description: An ETag of the resource updated. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_Delete (removed)
Description :  Deletes a Kusto cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_Stop (removed)
Description :  Stops a Kusto cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/stop
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_Start (removed)
Description :  Starts a Kusto cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/start
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_ListByResourceGroup (removed)
Description :  Lists all Kusto clusters within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto clusters. ,
Required: False ,
}
[
{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_List (removed)
Description :  Lists all Kusto clusters within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Kusto/clusters
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto clusters. ,
Required: False ,
}
[
{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Class representing the Kusto cluster properties. ,
Required: False ,
}
{
state:
{
Description: The state of the resource. ,
Enum:
{
Creating: No description available. ,
Unavailable: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_ListSkus (removed)
Description :  Lists eligible SKUs for Kusto resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Kusto/skus
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of available SKUs for new resources. ,
Required: False ,
}
[
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_CheckNameAvailability (removed)
Description :  Checks that the cluster name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Kusto/locations/{location}/checkNameAvailability
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Azure location. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
{
name:
{
Description: Cluster name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, Microsoft.Kusto/clusters. ,
Enum:
{
Microsoft.Kusto/clusters: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Specifies a Boolean value that indicates if the name is available. ,
Required: False ,
}
boolean ,
name:
{
Description: The name that was checked. ,
Required: False ,
}
string ,
message:
{
Description: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_CheckNameAvailability (removed)
Description :  Checks that the database name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkNameAvailability
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
{
name:
{
Description: Database name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, Microsoft.Kusto/clusters/databases. ,
Enum:
{
Microsoft.Kusto/clusters/databases: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Specifies a Boolean value that indicates if the name is available. ,
Required: False ,
}
boolean ,
name:
{
Description: The name that was checked. ,
Required: False ,
}
string ,
message:
{
Description: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Clusters_ListSkusByResource (removed)
Description :  Returns the SKUs available for the provided resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/skus
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of available SKUs for an existing resource. ,
Required: False ,
}
[
{
resourceType:
{
Description: Resource Namespace and Type. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU details. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
KC8: No description available. ,
KC16: No description available. ,
KS8: No description available. ,
KS16: No description available. ,
D13_v2: No description available. ,
D14_v2: No description available. ,
L8: No description available. ,
L16: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: SKU capacity. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
capacity:
{
Description: The SKU capacity. ,
Required: False ,
}
{
scaleType:
{
Description: Scale type. ,
Enum:
{
automatic: No description available. ,
manual: No description available. ,
none: No description available. ,
}
,
Required: True ,
}
enum ,
minimum:
{
Description: Minimum allowed capacity. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed capacity. ,
Required: True ,
}
integer ,
default:
{
Description: The default capacity that would be used. ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_ListByCluster (removed)
Description :  Returns the list of databases of the given Kusto cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto databases. ,
Required: False ,
}
[
{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_Get (removed)
Description :  Returns a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_CreateOrUpdate (removed)
Description :  Creates or updates a database.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The database parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (201)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_Update (removed)
Description :  Updates a database.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The database parameters supplied to the Update operation. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
etag:
{
Description: An ETag of the resource updated. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (201)

{
etag:
{
Description: An ETag of the resource created. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto database properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletePeriodInDays:
{
Description: The number of days data should be kept before it stops being accessible to queries. ,
Required: True ,
}
integer ,
hotCachePeriodInDays:
{
Description: The number of days of data that should be kept in cache for fast queries. ,
Required: False ,
}
integer ,
statistics:
{
Description: The statistics of the database. ,
Required: False ,
}
{
size:
{
Description: The database size - the total size of compressed data and index in bytes. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_Delete (removed)
Description :  Deletes the database with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_ListPrincipals (removed)
Description :  Returns a list of database principals of the given Kusto cluster and database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto database principals. ,
Required: False ,
}
[
{
role:
{
Description: Database principal role. ,
Enum:
{
Admin: No description available. ,
Ingestor: No description available. ,
Monitor: No description available. ,
User: No description available. ,
UnrestrictedViewers: No description available. ,
Viewer: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Database principal name. ,
Required: True ,
}
string ,
type:
{
Description: Database principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
fqn:
{
Description: Database principal fully qualified name. ,
Required: False ,
}
string ,
email:
{
Description: Database principal email if exists. ,
Required: False ,
}
string ,
appId:
{
Description: Application id - relevant only for application principal type. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_AddPrincipals (removed)
Description :  Add Database principals permissions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/addPrincipals
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
databasePrincipalsToAdd:
{
Description: List of database principals to add. ,
Required: True ,
}
{
value:
{
Description: The list of Kusto database principals. ,
Required: False ,
}
[
{
role:
{
Description: Database principal role. ,
Enum:
{
Admin: No description available. ,
Ingestor: No description available. ,
Monitor: No description available. ,
User: No description available. ,
UnrestrictedViewers: No description available. ,
Viewer: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Database principal name. ,
Required: True ,
}
string ,
type:
{
Description: Database principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
fqn:
{
Description: Database principal fully qualified name. ,
Required: False ,
}
string ,
email:
{
Description: Database principal email if exists. ,
Required: False ,
}
string ,
appId:
{
Description: Application id - relevant only for application principal type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto database principals. ,
Required: False ,
}
[
{
role:
{
Description: Database principal role. ,
Enum:
{
Admin: No description available. ,
Ingestor: No description available. ,
Monitor: No description available. ,
User: No description available. ,
UnrestrictedViewers: No description available. ,
Viewer: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Database principal name. ,
Required: True ,
}
string ,
type:
{
Description: Database principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
fqn:
{
Description: Database principal fully qualified name. ,
Required: False ,
}
string ,
email:
{
Description: Database principal email if exists. ,
Required: False ,
}
string ,
appId:
{
Description: Application id - relevant only for application principal type. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Databases_RemovePrincipals (removed)
Description :  Remove Database principals permissions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/removePrincipals
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
databasePrincipalsToRemove:
{
Description: List of database principals to remove. ,
Required: True ,
}
{
value:
{
Description: The list of Kusto database principals. ,
Required: False ,
}
[
{
role:
{
Description: Database principal role. ,
Enum:
{
Admin: No description available. ,
Ingestor: No description available. ,
Monitor: No description available. ,
User: No description available. ,
UnrestrictedViewers: No description available. ,
Viewer: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Database principal name. ,
Required: True ,
}
string ,
type:
{
Description: Database principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
fqn:
{
Description: Database principal fully qualified name. ,
Required: False ,
}
string ,
email:
{
Description: Database principal email if exists. ,
Required: False ,
}
string ,
appId:
{
Description: Application id - relevant only for application principal type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto database principals. ,
Required: False ,
}
[
{
role:
{
Description: Database principal role. ,
Enum:
{
Admin: No description available. ,
Ingestor: No description available. ,
Monitor: No description available. ,
User: No description available. ,
UnrestrictedViewers: No description available. ,
Viewer: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Database principal name. ,
Required: True ,
}
string ,
type:
{
Description: Database principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
fqn:
{
Description: Database principal fully qualified name. ,
Required: False ,
}
string ,
email:
{
Description: Database principal email if exists. ,
Required: False ,
}
string ,
appId:
{
Description: Application id - relevant only for application principal type. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EventHubConnections_ListByDatabase (removed)
Description :  Returns the list of Event Hub connections of the given Kusto database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto event hub connections. ,
Required: False ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EventHubConnections_eventhubConnectionValidation (removed)
Description :  Checks that the Event Hub data connection parameters are valid.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubConnectionValidation
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
parameters:
{
Description: The Event Hub connection parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
eventhubConnectionName:
{
Description: The name of the event hub connection. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto event hub connection validation errors. ,
Required: False ,
}
[
{
errorMessage:
{
Description: A message which indicates a problem in event hub connection validation. ,
Required: False ,
}
string ,
}
,
]
,
}
EventHubConnections_Get (removed)
Description :  Returns an Event Hub connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
eventHubConnectionName:
{
Description: The name of the event hub connection. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EventHubConnections_CreateOrUpdate (removed)
Description :  Creates or updates a Event Hub connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
eventHubConnectionName:
{
Description: The name of the event hub connection. ,
Required: True ,
}
string ,
parameters:
{
Description: The Event Hub connection parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EventHubConnections_Update (removed)
Description :  Updates a Event Hub connection.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
eventHubConnectionName:
{
Description: The name of the event hub connection. ,
Required: True ,
}
string ,
parameters:
{
Description: The Event Hub connection parameters supplied to the Update operation. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing the Kusto event hub connection properties. ,
Required: False ,
}
{
eventHubResourceId:
{
Description: The resource ID of the event hub to be used to create a data connection. ,
Required: True ,
}
string ,
consumerGroup:
{
Description: The event hub consumer group. ,
Required: True ,
}
string ,
tableName:
{
Description: The table where the data should be ingested. Optionally the table information can be added to each message. ,
Required: False ,
}
string ,
mappingRuleName:
{
Description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the message. Optionally the data format can be added to each message. ,
Enum:
{
MULTIJSON: No description available. ,
JSON: No description available. ,
CSV: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
EventHubConnections_Delete (removed)
Description :  Deletes the Event Hub connection with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Kusto cluster. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kusto cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database in the Kusto cluster. ,
Required: True ,
}
string ,
eventHubConnectionName:
{
Description: The name of the event hub connection. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (removed)
Description :  Lists available operations for the Microsoft.Kusto provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Kusto/operations
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
name:
{
Description: This is of the format {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Required: False ,
}
{
provider:
{
Required: False ,
}
string ,
operation:
{
Description: For example: read, write, delete. ,
Required: False ,
}
string ,
resource:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
origin:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Kusto. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}