Microsoft.Kusto (stable:2020-02-15)

2025/09/26 • 48 new, 48 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)

{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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 ,
]
,
}
,
}
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 ,
}
{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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)

{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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 ,
]
,
}
,
}
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 ,
sku:
{
Description: The SKU of the cluster. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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)

{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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 ,
]
,
}
,
}
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 ,
]
,
}
,
}
ClusterPrincipalAssignments_CheckNameAvailability (new)
Description :  Checks that the principal assignment name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkPrincipalAssignmentNameAvailability
{
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 ,
principalAssignmentName:
{
Description: The name of the principal assignment. ,
Required: True ,
}
{
name:
{
Description: Principal Assignment resource name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, Microsoft.Kusto/clusters/principalAssignments. ,
Enum:
{
Microsoft.Kusto/clusters/principalAssignments: 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 ,
reason:
{
Description: Message providing the reason why the given name is invalid. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: 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 ,
]
,
}
,
}
ClusterPrincipalAssignments_Get (new)
Description :  Gets a Kusto cluster principalAssignment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments/{principalAssignmentName}
{
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 ,
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 ,
principalAssignmentName:
{
Description: The name of the Kusto principalAssignment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The cluster principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
role:
{
Description: Cluster principal role. ,
Enum:
{
AllDatabasesAdmin: No description available. ,
AllDatabasesViewer: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: 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 ,
]
,
}
,
}
ClusterPrincipalAssignments_CreateOrUpdate (new)
Description :  Create a Kusto cluster principalAssignment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments/{principalAssignmentName}
{
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 ,
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 ,
principalAssignmentName:
{
Description: The name of the Kusto principalAssignment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The Kusto cluster principalAssignment's parameters supplied for the operation. ,
Required: True ,
}
{
properties:
{
Description: The cluster principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
role:
{
Description: Cluster principal role. ,
Enum:
{
AllDatabasesAdmin: No description available. ,
AllDatabasesViewer: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cluster principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
role:
{
Description: Cluster principal role. ,
Enum:
{
AllDatabasesAdmin: No description available. ,
AllDatabasesViewer: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The cluster principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
role:
{
Description: Cluster principal role. ,
Enum:
{
AllDatabasesAdmin: No description available. ,
AllDatabasesViewer: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: 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 ,
]
,
}
,
}
ClusterPrincipalAssignments_Delete (new)
Description :  Deletes a Kusto cluster principalAssignment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments/{principalAssignmentName}
{
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 ,
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 ,
principalAssignmentName:
{
Description: The name of the Kusto principalAssignment. ,
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 ,
]
,
}
,
}
ClusterPrincipalAssignments_List (new)
Description :  Lists all Kusto cluster principalAssignments.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments
{
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 ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto cluster principal assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The cluster principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
role:
{
Description: Cluster principal role. ,
Enum:
{
AllDatabasesAdmin: No description available. ,
AllDatabasesViewer: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: 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 ,
]
,
}
,
}
Clusters_ListFollowerDatabases (new)
Description :  Returns a list of databases that are owned by this cluster and were followed by another cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/listFollowerDatabases
{
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 follower database result. ,
Required: False ,
}
[
{
clusterResourceId:
{
Description: Resource id of the cluster that follows a database owned by this cluster. ,
Required: True ,
}
string ,
attachedDatabaseConfigurationName:
{
Description: Resource name of the attached database configuration in the follower cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The database name owned by this cluster that was followed. * in case following all databases. ,
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_DetachFollowerDatabases (new)
Description :  Detaches all followers of a database owned by this cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/detachFollowerDatabases
{
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 ,
followerDatabaseToRemove:
{
Description: The follower databases properties to remove. ,
Required: True ,
}
{
clusterResourceId:
{
Description: Resource id of the cluster that follows a database owned by this cluster. ,
Required: True ,
}
string ,
attachedDatabaseConfigurationName:
{
Description: Resource name of the attached database configuration in the follower cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The database name owned by this cluster that was followed. * in case following all databases. ,
Required: False ,
}
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_DiagnoseVirtualNetwork (new)
Description :  Diagnoses network connectivity status for external resources on which the service is dependent on.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/diagnoseVirtualNetwork
{
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)

{
findings:
{
Description: The list of network connectivity diagnostic finding ,
Required: False ,
}
[
string ,
]
,
}

⚐ 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 ,
}
[
{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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 ,
]
,
}
,
}
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 ,
}
[
{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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 ,
]
,
}
,
}
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: SKU descriptions ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
locations:
{
Description: The set of locations that the SKU is available ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: Locations and zones ,
Required: False ,
}
[
{
location:
{
Description: The available location of the SKU. ,
Required: True ,
}
string ,
zones:
{
Description: The available zone of the SKU. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
restrictions:
{
Description: The restrictions because of which SKU cannot be used ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
}

⚐ 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 ,
reason:
{
Description: Message providing the reason why the given name is invalid. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: 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 ,
]
,
}
,
}
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 ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
{
name:
{
Description: Resource name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, for instance Microsoft.Kusto/clusters/databases. ,
Enum:
{
Microsoft.Kusto/clusters/databases: No description available. ,
Microsoft.Kusto/clusters/attachedDatabaseConfigurations: 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 ,
reason:
{
Description: Message providing the reason why the given name is invalid. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: 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 ,
]
,
}
,
}
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:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
capacity:
{
Description: The number of instances of the cluster. ,
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 ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: 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 ,
]
,
}
,
}
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)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: 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 ,
]
,
}
,
}
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 ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: No description available. ,
}
,
Required: True ,
}
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 ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: 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 ,
]
,
}
,
}
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 ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: No description available. ,
}
,
Required: True ,
}
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 ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: 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 ,
]
,
}
,
}
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 ,
]
,
}
,
}
DatabasePrincipalAssignments_CheckNameAvailability (new)
Description :  Checks that the database principal assignment is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/checkPrincipalAssignmentNameAvailability
{
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 ,
principalAssignmentName:
{
Description: The name of the resource. ,
Required: True ,
}
{
name:
{
Description: Principal Assignment resource name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, Microsoft.Kusto/clusters/databases/principalAssignments. ,
Enum:
{
Microsoft.Kusto/clusters/databases/principalAssignments: 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 ,
reason:
{
Description: Message providing the reason why the given name is invalid. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: 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 ,
]
,
}
,
}
DatabasePrincipalAssignments_Get (new)
Description :  Gets a Kusto cluster database principalAssignment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments/{principalAssignmentName}
{
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 ,
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 ,
principalAssignmentName:
{
Description: The name of the Kusto principalAssignment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The database principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
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 ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: 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 ,
]
,
}
,
}
DatabasePrincipalAssignments_CreateOrUpdate (new)
Description :  Creates a Kusto cluster database principalAssignment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments/{principalAssignmentName}
{
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 ,
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 ,
principalAssignmentName:
{
Description: The name of the Kusto principalAssignment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The Kusto principalAssignments parameters supplied for the operation. ,
Required: True ,
}
{
properties:
{
Description: The database principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
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 ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The database principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
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 ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The database principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
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 ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: 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 ,
]
,
}
,
}
DatabasePrincipalAssignments_Delete (new)
Description :  Deletes a Kusto principalAssignment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments/{principalAssignmentName}
{
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 ,
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 ,
principalAssignmentName:
{
Description: The name of the Kusto principalAssignment. ,
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 ,
]
,
}
,
}
DatabasePrincipalAssignments_List (new)
Description :  Lists all Kusto cluster database principalAssignments.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments
{
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 ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto database principal assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The database principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
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 ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: 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 ,
]
,
}
,
}
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 ,
tenantName:
{
Description: The tenant name of the principal ,
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 ,
tenantName:
{
Description: The tenant name of the principal ,
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 ,
tenantName:
{
Description: The tenant name of the principal ,
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 ,
]
,
}
,
}
AttachedDatabaseConfigurations_ListByCluster (new)
Description :  Returns the list of attached database configurations of the given Kusto cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations
{
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 attached database configurations. ,
Required: False ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the attached database configuration. ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
databaseName:
{
Description: The name of the database which you would like to attach, use * if you want to follow all current and future databases. ,
Required: True ,
}
string ,
clusterResourceId:
{
Description: The resource id of the cluster where the databases you would like to attach reside. ,
Required: True ,
}
string ,
attachedDatabaseNames:
{
Description: The list of databases from the clusterResourceId which are currently attached to the cluster. ,
Required: False ,
}
[
string ,
]
,
defaultPrincipalsModificationKind:
{
Description: The default principals modification kind ,
Enum:
{
Union: No description available. ,
Replace: No description available. ,
None: 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 ,
]
,
}
,
}
AttachedDatabaseConfigurations_Get (new)
Description :  Returns an attached database configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}
{
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 ,
attachedDatabaseConfigurationName:
{
Description: The name of the attached database configuration. ,
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: The properties of the attached database configuration. ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
databaseName:
{
Description: The name of the database which you would like to attach, use * if you want to follow all current and future databases. ,
Required: True ,
}
string ,
clusterResourceId:
{
Description: The resource id of the cluster where the databases you would like to attach reside. ,
Required: True ,
}
string ,
attachedDatabaseNames:
{
Description: The list of databases from the clusterResourceId which are currently attached to the cluster. ,
Required: False ,
}
[
string ,
]
,
defaultPrincipalsModificationKind:
{
Description: The default principals modification kind ,
Enum:
{
Union: No description available. ,
Replace: No description available. ,
None: 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 ,
]
,
}
,
}
AttachedDatabaseConfigurations_CreateOrUpdate (new)
Description :  Creates or updates an attached database configuration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}
{
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 ,
attachedDatabaseConfigurationName:
{
Description: The name of the attached database configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The database parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the attached database configuration. ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
databaseName:
{
Description: The name of the database which you would like to attach, use * if you want to follow all current and future databases. ,
Required: True ,
}
string ,
clusterResourceId:
{
Description: The resource id of the cluster where the databases you would like to attach reside. ,
Required: True ,
}
string ,
attachedDatabaseNames:
{
Description: The list of databases from the clusterResourceId which are currently attached to the cluster. ,
Required: False ,
}
[
string ,
]
,
defaultPrincipalsModificationKind:
{
Description: The default principals modification kind ,
Enum:
{
Union: No description available. ,
Replace: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
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: The properties of the attached database configuration. ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
databaseName:
{
Description: The name of the database which you would like to attach, use * if you want to follow all current and future databases. ,
Required: True ,
}
string ,
clusterResourceId:
{
Description: The resource id of the cluster where the databases you would like to attach reside. ,
Required: True ,
}
string ,
attachedDatabaseNames:
{
Description: The list of databases from the clusterResourceId which are currently attached to the cluster. ,
Required: False ,
}
[
string ,
]
,
defaultPrincipalsModificationKind:
{
Description: The default principals modification kind ,
Enum:
{
Union: No description available. ,
Replace: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the attached database configuration. ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
databaseName:
{
Description: The name of the database which you would like to attach, use * if you want to follow all current and future databases. ,
Required: True ,
}
string ,
clusterResourceId:
{
Description: The resource id of the cluster where the databases you would like to attach reside. ,
Required: True ,
}
string ,
attachedDatabaseNames:
{
Description: The list of databases from the clusterResourceId which are currently attached to the cluster. ,
Required: False ,
}
[
string ,
]
,
defaultPrincipalsModificationKind:
{
Description: The default principals modification kind ,
Enum:
{
Union: No description available. ,
Replace: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the attached database configuration. ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
databaseName:
{
Description: The name of the database which you would like to attach, use * if you want to follow all current and future databases. ,
Required: True ,
}
string ,
clusterResourceId:
{
Description: The resource id of the cluster where the databases you would like to attach reside. ,
Required: True ,
}
string ,
attachedDatabaseNames:
{
Description: The list of databases from the clusterResourceId which are currently attached to the cluster. ,
Required: False ,
}
[
string ,
]
,
defaultPrincipalsModificationKind:
{
Description: The default principals modification kind ,
Enum:
{
Union: No description available. ,
Replace: No description available. ,
None: 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 ,
]
,
}
,
}
AttachedDatabaseConfigurations_Delete (new)
Description :  Deletes the attached database configuration with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}
{
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 ,
attachedDatabaseConfigurationName:
{
Description: The name of the attached database configuration. ,
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_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 ,
tenantName:
{
Description: The tenant name of the principal ,
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 ,
tenantName:
{
Description: The tenant name of the principal ,
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 ,
]
,
}
,
}
DataConnections_ListByDatabase (new)
Description :  Returns the list of data connections of the given Kusto database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections
{
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 data connections. ,
Required: False ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: 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 ,
]
,
}
,
}
DataConnections_dataConnectionValidation (new)
Description :  Checks that the data connection parameters are valid.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnectionValidation
{
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 data connection parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
dataConnectionName:
{
Description: The name of the data connection. ,
Required: False ,
}
string ,
properties:
{
Description: The data connection properties to validate. ,
Required: False ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto data connection validation errors. ,
Required: False ,
}
[
{
errorMessage:
{
Description: A message which indicates a problem in data connection validation. ,
Required: False ,
}
string ,
}
,
]
,
}
DataConnections_CheckNameAvailability (new)
Description :  Checks that the data connection name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/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 ,
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 ,
dataConnectionName:
{
Description: The name of the data connection. ,
Required: True ,
}
{
name:
{
Description: Data Connection name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, Microsoft.Kusto/clusters/databases/dataConnections. ,
Enum:
{
Microsoft.Kusto/clusters/databases/dataConnections: 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 ,
reason:
{
Description: Message providing the reason why the given name is invalid. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: 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 ,
]
,
}
,
}
DataConnections_Get (new)
Description :  Returns a data connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}
{
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 ,
dataConnectionName:
{
Description: The name of the data 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 ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: 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 ,
]
,
}
,
}
DataConnections_CreateOrUpdate (new)
Description :  Creates or updates a data connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}
{
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 ,
dataConnectionName:
{
Description: The name of the data connection. ,
Required: True ,
}
string ,
parameters:
{
Description: The data connection parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
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 ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: 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 ,
]
,
}
,
}
DataConnections_Update (new)
Description :  Updates a data connection.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}
{
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 ,
dataConnectionName:
{
Description: The name of the data connection. ,
Required: True ,
}
string ,
parameters:
{
Description: The data connection parameters supplied to the Update operation. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
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 ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: 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 ,
]
,
}
,
}
DataConnections_Delete (new)
Description :  Deletes the data connection with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}
{
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 ,
dataConnectionName:
{
Description: The name of the data 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_ListLanguageExtensions (new)
Description :  Returns a list of language extensions that can run within KQL queries.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/listLanguageExtensions
{
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 ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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 ,
]
,
}
,
}
Clusters_AddLanguageExtensions (new)
Description :  Add a list of language extensions that can run within KQL queries.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/addLanguageExtensions
{
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 ,
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 ,
languageExtensionsToAdd:
{
Description: The language extensions to add. ,
Required: True ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ 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_RemoveLanguageExtensions (new)
Description :  Remove a list of language extensions that can run within KQL queries.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/removeLanguageExtensions
{
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 ,
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 ,
languageExtensionsToRemove:
{
Description: The language extensions to remove. ,
Required: True ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ 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_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)

{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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 ,
]
,
}
,
}
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 ,
}
{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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)

{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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 ,
]
,
}
,
}
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 ,
sku:
{
Description: The SKU of the cluster. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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)

{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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 ,
]
,
}
,
}
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 ,
]
,
}
,
}
ClusterPrincipalAssignments_CheckNameAvailability (removed)
Description :  Checks that the principal assignment name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkPrincipalAssignmentNameAvailability
{
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 ,
principalAssignmentName:
{
Description: The name of the principal assignment. ,
Required: True ,
}
{
name:
{
Description: Principal Assignment resource name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, Microsoft.Kusto/clusters/principalAssignments. ,
Enum:
{
Microsoft.Kusto/clusters/principalAssignments: 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 ,
reason:
{
Description: Message providing the reason why the given name is invalid. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: 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 ,
]
,
}
,
}
ClusterPrincipalAssignments_Get (removed)
Description :  Gets a Kusto cluster principalAssignment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments/{principalAssignmentName}
{
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 ,
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 ,
principalAssignmentName:
{
Description: The name of the Kusto principalAssignment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The cluster principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
role:
{
Description: Cluster principal role. ,
Enum:
{
AllDatabasesAdmin: No description available. ,
AllDatabasesViewer: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: 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 ,
]
,
}
,
}
ClusterPrincipalAssignments_CreateOrUpdate (removed)
Description :  Create a Kusto cluster principalAssignment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments/{principalAssignmentName}
{
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 ,
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 ,
principalAssignmentName:
{
Description: The name of the Kusto principalAssignment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The Kusto cluster principalAssignment's parameters supplied for the operation. ,
Required: True ,
}
{
properties:
{
Description: The cluster principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
role:
{
Description: Cluster principal role. ,
Enum:
{
AllDatabasesAdmin: No description available. ,
AllDatabasesViewer: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cluster principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
role:
{
Description: Cluster principal role. ,
Enum:
{
AllDatabasesAdmin: No description available. ,
AllDatabasesViewer: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The cluster principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
role:
{
Description: Cluster principal role. ,
Enum:
{
AllDatabasesAdmin: No description available. ,
AllDatabasesViewer: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: 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 ,
]
,
}
,
}
ClusterPrincipalAssignments_Delete (removed)
Description :  Deletes a Kusto cluster principalAssignment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments/{principalAssignmentName}
{
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 ,
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 ,
principalAssignmentName:
{
Description: The name of the Kusto principalAssignment. ,
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 ,
]
,
}
,
}
ClusterPrincipalAssignments_List (removed)
Description :  Lists all Kusto cluster principalAssignments.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments
{
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 ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto cluster principal assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The cluster principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
role:
{
Description: Cluster principal role. ,
Enum:
{
AllDatabasesAdmin: No description available. ,
AllDatabasesViewer: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: 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 ,
]
,
}
,
}
Clusters_ListFollowerDatabases (removed)
Description :  Returns a list of databases that are owned by this cluster and were followed by another cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/listFollowerDatabases
{
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 follower database result. ,
Required: False ,
}
[
{
clusterResourceId:
{
Description: Resource id of the cluster that follows a database owned by this cluster. ,
Required: True ,
}
string ,
attachedDatabaseConfigurationName:
{
Description: Resource name of the attached database configuration in the follower cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The database name owned by this cluster that was followed. * in case following all databases. ,
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_DetachFollowerDatabases (removed)
Description :  Detaches all followers of a database owned by this cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/detachFollowerDatabases
{
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 ,
followerDatabaseToRemove:
{
Description: The follower databases properties to remove. ,
Required: True ,
}
{
clusterResourceId:
{
Description: Resource id of the cluster that follows a database owned by this cluster. ,
Required: True ,
}
string ,
attachedDatabaseConfigurationName:
{
Description: Resource name of the attached database configuration in the follower cluster. ,
Required: True ,
}
string ,
databaseName:
{
Description: The database name owned by this cluster that was followed. * in case following all databases. ,
Required: False ,
}
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_DiagnoseVirtualNetwork (removed)
Description :  Diagnoses network connectivity status for external resources on which the service is dependent on.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/diagnoseVirtualNetwork
{
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)

{
findings:
{
Description: The list of network connectivity diagnostic finding ,
Required: False ,
}
[
string ,
]
,
}

⚐ 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 ,
}
[
{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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 ,
]
,
}
,
}
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 ,
}
[
{
sku:
{
Description: The SKU of the cluster. ,
Required: True ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones of the cluster. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The 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. ,
Updating: 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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The cluster URI. ,
Required: False ,
}
string ,
dataIngestionUri:
{
Description: The cluster data ingestion URI. ,
Required: False ,
}
string ,
stateReason:
{
Description: The reason for the cluster's current state. ,
Required: False ,
}
string ,
trustedExternalTenants:
{
Description: The cluster's external tenants. ,
Required: False ,
}
[
{
value:
{
Description: GUID representing an external tenant. ,
Required: False ,
}
string ,
}
,
]
,
optimizedAutoscale:
{
Description: Optimized auto scale definition. ,
Required: False ,
}
{
version:
{
Description: The version of the template defined, for instance 1. ,
Required: True ,
}
integer ,
isEnabled:
{
Description: A boolean value that indicate if the optimized autoscale feature is enabled or not. ,
Required: True ,
}
boolean ,
minimum:
{
Description: Minimum allowed instances count. ,
Required: True ,
}
integer ,
maximum:
{
Description: Maximum allowed instances count. ,
Required: True ,
}
integer ,
}
,
enableDiskEncryption:
{
Description: A boolean value that indicates if the cluster's disks are encrypted. ,
Required: False ,
}
boolean ,
enableStreamingIngest:
{
Description: A boolean value that indicates if the streaming ingest is enabled. ,
Required: False ,
}
boolean ,
virtualNetworkConfiguration:
{
Description: Virtual network definition. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource id. ,
Required: True ,
}
string ,
enginePublicIpId:
{
Description: Engine service's public IP address resource id. ,
Required: True ,
}
string ,
dataManagementPublicIpId:
{
Description: Data management's service public IP address resource id. ,
Required: True ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault properties for the cluster encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
}
,
enablePurge:
{
Description: A boolean value that indicates if the purge operations are enabled. ,
Required: False ,
}
boolean ,
languageExtensions:
{
Description: List of the cluster's language extensions. ,
Required: False ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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 ,
]
,
}
,
}
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: SKU descriptions ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
locations:
{
Description: The set of locations that the SKU is available ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: Locations and zones ,
Required: False ,
}
[
{
location:
{
Description: The available location of the SKU. ,
Required: True ,
}
string ,
zones:
{
Description: The available zone of the SKU. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
restrictions:
{
Description: The restrictions because of which SKU cannot be used ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
}

⚐ 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 ,
reason:
{
Description: Message providing the reason why the given name is invalid. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: 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 ,
]
,
}
,
}
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 ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
{
name:
{
Description: Resource name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, for instance Microsoft.Kusto/clusters/databases. ,
Enum:
{
Microsoft.Kusto/clusters/databases: No description available. ,
Microsoft.Kusto/clusters/attachedDatabaseConfigurations: 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 ,
reason:
{
Description: Message providing the reason why the given name is invalid. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: 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 ,
]
,
}
,
}
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:
{
Standard_DS13_v2+1TB_PS: No description available. ,
Standard_DS13_v2+2TB_PS: No description available. ,
Standard_DS14_v2+3TB_PS: No description available. ,
Standard_DS14_v2+4TB_PS: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_L4s: No description available. ,
Dev(No SLA)_Standard_D11_v2: No description available. ,
Standard_E2a_v4: No description available. ,
Standard_E4a_v4: No description available. ,
Standard_E8a_v4: No description available. ,
Standard_E16a_v4: No description available. ,
Standard_E8as_v4+1TB_PS: No description available. ,
Standard_E8as_v4+2TB_PS: No description available. ,
Standard_E16as_v4+3TB_PS: No description available. ,
Standard_E16as_v4+4TB_PS: No description available. ,
Dev(No SLA)_Standard_E2a_v4: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The number of instances of the cluster. ,
Required: False ,
}
integer ,
tier:
{
Description: SKU tier. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
capacity:
{
Description: The number of instances of the cluster. ,
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 ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: 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 ,
]
,
}
,
}
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)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: 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 ,
]
,
}
,
}
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 ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: No description available. ,
}
,
Required: True ,
}
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 ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: 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 ,
]
,
}
,
}
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 ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: No description available. ,
}
,
Required: True ,
}
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 ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the database ,
Enum:
{
ReadWrite: No description available. ,
ReadOnlyFollowing: 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 ,
]
,
}
,
}
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 ,
]
,
}
,
}
DatabasePrincipalAssignments_CheckNameAvailability (removed)
Description :  Checks that the database principal assignment is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/checkPrincipalAssignmentNameAvailability
{
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 ,
principalAssignmentName:
{
Description: The name of the resource. ,
Required: True ,
}
{
name:
{
Description: Principal Assignment resource name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, Microsoft.Kusto/clusters/databases/principalAssignments. ,
Enum:
{
Microsoft.Kusto/clusters/databases/principalAssignments: 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 ,
reason:
{
Description: Message providing the reason why the given name is invalid. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: 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 ,
]
,
}
,
}
DatabasePrincipalAssignments_Get (removed)
Description :  Gets a Kusto cluster database principalAssignment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments/{principalAssignmentName}
{
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 ,
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 ,
principalAssignmentName:
{
Description: The name of the Kusto principalAssignment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The database principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
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 ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: 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 ,
]
,
}
,
}
DatabasePrincipalAssignments_CreateOrUpdate (removed)
Description :  Creates a Kusto cluster database principalAssignment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments/{principalAssignmentName}
{
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 ,
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 ,
principalAssignmentName:
{
Description: The name of the Kusto principalAssignment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The Kusto principalAssignments parameters supplied for the operation. ,
Required: True ,
}
{
properties:
{
Description: The database principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
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 ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The database principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
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 ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The database principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
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 ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: 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 ,
]
,
}
,
}
DatabasePrincipalAssignments_Delete (removed)
Description :  Deletes a Kusto principalAssignment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments/{principalAssignmentName}
{
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 ,
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 ,
principalAssignmentName:
{
Description: The name of the Kusto principalAssignment. ,
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 ,
]
,
}
,
}
DatabasePrincipalAssignments_List (removed)
Description :  Lists all Kusto cluster database principalAssignments.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments
{
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 ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto database principal assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The database principal. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. ,
Required: True ,
}
string ,
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 ,
tenantId:
{
Description: The tenant id of the principal ,
Required: False ,
}
string ,
principalType:
{
Description: Principal type. ,
Enum:
{
App: No description available. ,
Group: No description available. ,
User: No description available. ,
}
,
Required: True ,
}
enum ,
tenantName:
{
Description: The tenant name of the principal ,
Required: False ,
}
string ,
principalName:
{
Description: The principal name ,
Required: False ,
}
string ,
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. ,
Moving: 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 ,
]
,
}
,
}
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 ,
tenantName:
{
Description: The tenant name of the principal ,
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 ,
tenantName:
{
Description: The tenant name of the principal ,
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 ,
tenantName:
{
Description: The tenant name of the principal ,
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 ,
]
,
}
,
}
AttachedDatabaseConfigurations_ListByCluster (removed)
Description :  Returns the list of attached database configurations of the given Kusto cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations
{
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 attached database configurations. ,
Required: False ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the attached database configuration. ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
databaseName:
{
Description: The name of the database which you would like to attach, use * if you want to follow all current and future databases. ,
Required: True ,
}
string ,
clusterResourceId:
{
Description: The resource id of the cluster where the databases you would like to attach reside. ,
Required: True ,
}
string ,
attachedDatabaseNames:
{
Description: The list of databases from the clusterResourceId which are currently attached to the cluster. ,
Required: False ,
}
[
string ,
]
,
defaultPrincipalsModificationKind:
{
Description: The default principals modification kind ,
Enum:
{
Union: No description available. ,
Replace: No description available. ,
None: 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 ,
]
,
}
,
}
AttachedDatabaseConfigurations_Get (removed)
Description :  Returns an attached database configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}
{
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 ,
attachedDatabaseConfigurationName:
{
Description: The name of the attached database configuration. ,
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: The properties of the attached database configuration. ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
databaseName:
{
Description: The name of the database which you would like to attach, use * if you want to follow all current and future databases. ,
Required: True ,
}
string ,
clusterResourceId:
{
Description: The resource id of the cluster where the databases you would like to attach reside. ,
Required: True ,
}
string ,
attachedDatabaseNames:
{
Description: The list of databases from the clusterResourceId which are currently attached to the cluster. ,
Required: False ,
}
[
string ,
]
,
defaultPrincipalsModificationKind:
{
Description: The default principals modification kind ,
Enum:
{
Union: No description available. ,
Replace: No description available. ,
None: 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 ,
]
,
}
,
}
AttachedDatabaseConfigurations_CreateOrUpdate (removed)
Description :  Creates or updates an attached database configuration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}
{
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 ,
attachedDatabaseConfigurationName:
{
Description: The name of the attached database configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The database parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the attached database configuration. ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
databaseName:
{
Description: The name of the database which you would like to attach, use * if you want to follow all current and future databases. ,
Required: True ,
}
string ,
clusterResourceId:
{
Description: The resource id of the cluster where the databases you would like to attach reside. ,
Required: True ,
}
string ,
attachedDatabaseNames:
{
Description: The list of databases from the clusterResourceId which are currently attached to the cluster. ,
Required: False ,
}
[
string ,
]
,
defaultPrincipalsModificationKind:
{
Description: The default principals modification kind ,
Enum:
{
Union: No description available. ,
Replace: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
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: The properties of the attached database configuration. ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
databaseName:
{
Description: The name of the database which you would like to attach, use * if you want to follow all current and future databases. ,
Required: True ,
}
string ,
clusterResourceId:
{
Description: The resource id of the cluster where the databases you would like to attach reside. ,
Required: True ,
}
string ,
attachedDatabaseNames:
{
Description: The list of databases from the clusterResourceId which are currently attached to the cluster. ,
Required: False ,
}
[
string ,
]
,
defaultPrincipalsModificationKind:
{
Description: The default principals modification kind ,
Enum:
{
Union: No description available. ,
Replace: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the attached database configuration. ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
databaseName:
{
Description: The name of the database which you would like to attach, use * if you want to follow all current and future databases. ,
Required: True ,
}
string ,
clusterResourceId:
{
Description: The resource id of the cluster where the databases you would like to attach reside. ,
Required: True ,
}
string ,
attachedDatabaseNames:
{
Description: The list of databases from the clusterResourceId which are currently attached to the cluster. ,
Required: False ,
}
[
string ,
]
,
defaultPrincipalsModificationKind:
{
Description: The default principals modification kind ,
Enum:
{
Union: No description available. ,
Replace: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the attached database configuration. ,
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. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
databaseName:
{
Description: The name of the database which you would like to attach, use * if you want to follow all current and future databases. ,
Required: True ,
}
string ,
clusterResourceId:
{
Description: The resource id of the cluster where the databases you would like to attach reside. ,
Required: True ,
}
string ,
attachedDatabaseNames:
{
Description: The list of databases from the clusterResourceId which are currently attached to the cluster. ,
Required: False ,
}
[
string ,
]
,
defaultPrincipalsModificationKind:
{
Description: The default principals modification kind ,
Enum:
{
Union: No description available. ,
Replace: No description available. ,
None: 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 ,
]
,
}
,
}
AttachedDatabaseConfigurations_Delete (removed)
Description :  Deletes the attached database configuration with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}
{
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 ,
attachedDatabaseConfigurationName:
{
Description: The name of the attached database configuration. ,
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_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 ,
tenantName:
{
Description: The tenant name of the principal ,
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 ,
tenantName:
{
Description: The tenant name of the principal ,
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 ,
]
,
}
,
}
DataConnections_ListByDatabase (removed)
Description :  Returns the list of data connections of the given Kusto database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections
{
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 data connections. ,
Required: False ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: 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 ,
]
,
}
,
}
DataConnections_dataConnectionValidation (removed)
Description :  Checks that the data connection parameters are valid.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnectionValidation
{
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 data connection parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
dataConnectionName:
{
Description: The name of the data connection. ,
Required: False ,
}
string ,
properties:
{
Description: The data connection properties to validate. ,
Required: False ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of Kusto data connection validation errors. ,
Required: False ,
}
[
{
errorMessage:
{
Description: A message which indicates a problem in data connection validation. ,
Required: False ,
}
string ,
}
,
]
,
}
DataConnections_CheckNameAvailability (removed)
Description :  Checks that the data connection name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/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 ,
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 ,
dataConnectionName:
{
Description: The name of the data connection. ,
Required: True ,
}
{
name:
{
Description: Data Connection name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, Microsoft.Kusto/clusters/databases/dataConnections. ,
Enum:
{
Microsoft.Kusto/clusters/databases/dataConnections: 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 ,
reason:
{
Description: Message providing the reason why the given name is invalid. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: 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 ,
]
,
}
,
}
DataConnections_Get (removed)
Description :  Returns a data connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}
{
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 ,
dataConnectionName:
{
Description: The name of the data 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 ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: 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 ,
]
,
}
,
}
DataConnections_CreateOrUpdate (removed)
Description :  Creates or updates a data connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}
{
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 ,
dataConnectionName:
{
Description: The name of the data connection. ,
Required: True ,
}
string ,
parameters:
{
Description: The data connection parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
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 ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: 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 ,
]
,
}
,
}
DataConnections_Update (removed)
Description :  Updates a data connection.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}
{
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 ,
dataConnectionName:
{
Description: The name of the data connection. ,
Required: True ,
}
string ,
parameters:
{
Description: The data connection parameters supplied to the Update operation. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
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 ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the endpoint for the data connection ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
IotHub: 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 ,
]
,
}
,
}
DataConnections_Delete (removed)
Description :  Deletes the data connection with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}
{
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 ,
dataConnectionName:
{
Description: The name of the data 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 ,
]
,
}
,
}
Clusters_ListLanguageExtensions (removed)
Description :  Returns a list of language extensions that can run within KQL queries.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/listLanguageExtensions
{
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 ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: 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 ,
]
,
}
,
}
Clusters_AddLanguageExtensions (removed)
Description :  Add a list of language extensions that can run within KQL queries.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/addLanguageExtensions
{
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 ,
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 ,
languageExtensionsToAdd:
{
Description: The language extensions to add. ,
Required: True ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ 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_RemoveLanguageExtensions (removed)
Description :  Remove a list of language extensions that can run within KQL queries.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/removeLanguageExtensions
{
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 ,
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 ,
languageExtensionsToRemove:
{
Description: The language extensions to remove. ,
Required: True ,
}
{
value:
{
Description: The list of language extensions. ,
Required: False ,
}
[
{
languageExtensionName:
{
Description: The language extension name. ,
Enum:
{
PYTHON: No description available. ,
R: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ 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 ,
]
,
}
,
}