Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The clusters/databases/scripts resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Kusto/clusters/databases/scripts resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Kusto/clusters/databases/scripts@2022-02-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
continueOnErrors: bool
forceUpdateTag: 'string'
scriptContent: 'string'
scriptUrl: 'string'
scriptUrlSasToken: 'string'
}
}
Property Values
Microsoft.Kusto/clusters/databases/scripts
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: clusters/databases |
| properties | The database script. | ScriptProperties |
ScriptProperties
| Name | Description | Value |
|---|---|---|
| continueOnErrors | Flag that indicates whether to continue if one of the command fails. | bool |
| forceUpdateTag | A unique string. If changed the script will be applied again. | string |
| scriptContent | The script content. This property should be used when the script is provide inline and not through file in a SA. Must not be used together with scriptUrl and scriptUrlSasToken properties. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| scriptUrl | The url to the KQL script blob file. Must not be used together with scriptContent property | string |
| scriptUrlSasToken | The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property. | string Constraints: Sensitive value. Pass in as a secure parameter. |
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Deploy Azure Data Explorer DB with Cosmos DB connection | Deploy Azure Data Explorer DB with Cosmos DB connection. |
| Deploy Azure Data Explorer db with Event Grid connection | Deploy Azure Data Explorer db with Event Grid connection. |
| Deploy Azure Data Explorer db with Event Hub connection | Deploy Azure Data Explorer db with Event Hub connection. |
| FinOps hub | This template creates a new FinOps hub instance, including Data Explorer, Data Lake storage, and Data Factory. |
ARM template resource definition
The clusters/databases/scripts resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Kusto/clusters/databases/scripts resource, add the following JSON to your template.
{
"type": "Microsoft.Kusto/clusters/databases/scripts",
"apiVersion": "2022-02-01",
"name": "string",
"properties": {
"continueOnErrors": "bool",
"forceUpdateTag": "string",
"scriptContent": "string",
"scriptUrl": "string",
"scriptUrlSasToken": "string"
}
}
Property Values
Microsoft.Kusto/clusters/databases/scripts
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-02-01' |
| name | The resource name | string (required) |
| properties | The database script. | ScriptProperties |
| type | The resource type | 'Microsoft.Kusto/clusters/databases/scripts' |
ScriptProperties
| Name | Description | Value |
|---|---|---|
| continueOnErrors | Flag that indicates whether to continue if one of the command fails. | bool |
| forceUpdateTag | A unique string. If changed the script will be applied again. | string |
| scriptContent | The script content. This property should be used when the script is provide inline and not through file in a SA. Must not be used together with scriptUrl and scriptUrlSasToken properties. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| scriptUrl | The url to the KQL script blob file. Must not be used together with scriptContent property | string |
| scriptUrlSasToken | The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property. | string Constraints: Sensitive value. Pass in as a secure parameter. |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Deploy Azure Data Explorer DB with Cosmos DB connection |
Deploy Azure Data Explorer DB with Cosmos DB connection. |
| Deploy Azure Data Explorer db with Event Grid connection |
Deploy Azure Data Explorer db with Event Grid connection. |
| Deploy Azure Data Explorer db with Event Hub connection |
Deploy Azure Data Explorer db with Event Hub connection. |
| FinOps hub |
This template creates a new FinOps hub instance, including Data Explorer, Data Lake storage, and Data Factory. |
Terraform (AzAPI provider) resource definition
The clusters/databases/scripts resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Kusto/clusters/databases/scripts resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Kusto/clusters/databases/scripts@2022-02-01"
name = "string"
parent_id = "string"
body = {
properties = {
continueOnErrors = bool
forceUpdateTag = "string"
scriptContent = "string"
scriptUrl = "string"
scriptUrlSasToken = "string"
}
}
}
Property Values
Microsoft.Kusto/clusters/databases/scripts
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: clusters/databases |
| properties | The database script. | ScriptProperties |
| type | The resource type | "Microsoft.Kusto/clusters/databases/scripts@2022-02-01" |
ScriptProperties
| Name | Description | Value |
|---|---|---|
| continueOnErrors | Flag that indicates whether to continue if one of the command fails. | bool |
| forceUpdateTag | A unique string. If changed the script will be applied again. | string |
| scriptContent | The script content. This property should be used when the script is provide inline and not through file in a SA. Must not be used together with scriptUrl and scriptUrlSasToken properties. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| scriptUrl | The url to the KQL script blob file. Must not be used together with scriptContent property | string |
| scriptUrlSasToken | The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property. | string Constraints: Sensitive value. Pass in as a secure parameter. |