Compartilhar via

Clusters/bancos de dados/scripts microsoft.Kusto 2023-05-02

Definição de recurso do Bicep

O tipo de recurso clusters/bancos de dados/scripts pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Kusto/clusters/databases/scripts, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.Kusto/clusters/databases/scripts@2023-05-02' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    continueOnErrors: bool
    forceUpdateTag: 'string'
    scriptContent: 'string'
    scriptUrl: 'string'
    scriptUrlSasToken: 'string'
  }
}

Valores de propriedade

Microsoft.Kusto/clusters/databases/scripts

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Padrão = ^.*$ (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para o recurso do tipo: clusters/bancos de dados
Propriedades O script do banco de dados. ScriptProperties

ScriptProperties

Nome Descrição Valor
continueOnErrors Sinalizador que indica se deve continuar se um dos comandos falhar. Bool
forceUpdateTag Uma cadeia de caracteres exclusiva. Se alterado, o script será aplicado novamente. cadeia
scriptContent O conteúdo do script. Essa propriedade deve ser usada quando o script for fornecido embutido e não por meio de um arquivo em uma SA. Não deve ser usado junto com as propriedades scriptUrl E scriptUrlSasToken. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
scriptUrl A URL para o arquivo de blob de script KQL. Não deve ser usado junto com a propriedade scriptContent cadeia
scriptUrlSasToken O token SaS que fornece acesso de leitura ao arquivo que contém o script. Deve ser fornecido ao usar a propriedade scriptUrl. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

Exemplos de uso

Exemplos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar esse tipo de recurso.

Arquivo Bicep Descrição
implantar o BD do Azure Data Explorer com a conexão do Cosmos DB Implantar o BD do Azure Data Explorer com a conexão do Cosmos DB.
implantar o banco de dados do Azure Data Explorer com a conexão da Grade de Eventos Implantar o banco de dados do Azure Data Explorer com a conexão da Grade de Eventos.
implantar o banco de dados do Azure Data Explorer com a conexão do Hub de Eventos Implantar o banco de dados do Azure Data Explorer com a conexão do Hub de Eventos.
do hub FinOps Esse modelo cria uma nova instância do hub FinOps, incluindo Data Explorer, Data Lake Storage e Data Factory.

Definição de recurso de modelo do ARM

O tipo de recurso clusters/bancos de dados/scripts pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Kusto/clusters/databases/scripts, adicione o JSON a seguir ao seu modelo.

{
  "type": "Microsoft.Kusto/clusters/databases/scripts",
  "apiVersion": "2023-05-02",
  "name": "string",
  "properties": {
    "continueOnErrors": "bool",
    "forceUpdateTag": "string",
    "scriptContent": "string",
    "scriptUrl": "string",
    "scriptUrlSasToken": "string"
  }
}

Valores de propriedade

Microsoft.Kusto/clusters/databases/scripts

Nome Descrição Valor
apiVersion A versão da API '2023-05-02'
nome O nome do recurso corda

Restrições:
Padrão = ^.*$ (obrigatório)
Propriedades O script do banco de dados. ScriptProperties
tipo O tipo de recurso 'Microsoft.Kusto/clusters/databases/scripts'

ScriptProperties

Nome Descrição Valor
continueOnErrors Sinalizador que indica se deve continuar se um dos comandos falhar. Bool
forceUpdateTag Uma cadeia de caracteres exclusiva. Se alterado, o script será aplicado novamente. cadeia
scriptContent O conteúdo do script. Essa propriedade deve ser usada quando o script for fornecido embutido e não por meio de um arquivo em uma SA. Não deve ser usado junto com as propriedades scriptUrl E scriptUrlSasToken. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
scriptUrl A URL para o arquivo de blob de script KQL. Não deve ser usado junto com a propriedade scriptContent cadeia
scriptUrlSasToken O token SaS que fornece acesso de leitura ao arquivo que contém o script. Deve ser fornecido ao usar a propriedade scriptUrl. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

Exemplos de uso

Modelos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.

Modelo Descrição
implantar o BD do Azure Data Explorer com a conexão do Cosmos DB

Implantar no Azure 		Implantar o BD do Azure Data Explorer com a conexão do Cosmos DB.
implantar o banco de dados do Azure Data Explorer com a conexão da Grade de Eventos

Implantar no Azure 		Implantar o banco de dados do Azure Data Explorer com a conexão da Grade de Eventos.
implantar o banco de dados do Azure Data Explorer com a conexão do Hub de Eventos

Implantar no Azure 		Implantar o banco de dados do Azure Data Explorer com a conexão do Hub de Eventos.
do hub FinOps

Implantar no Azure 		Esse modelo cria uma nova instância do hub FinOps, incluindo Data Explorer, Data Lake Storage e Data Factory.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso clusters/bancos de dados/scripts pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Kusto/clusters/databases/scripts, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Kusto/clusters/databases/scripts@2023-05-02"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      continueOnErrors = bool
      forceUpdateTag = "string"
      scriptContent = "string"
      scriptUrl = "string"
      scriptUrlSasToken = "string"
    }
  }
}

Valores de propriedade

Microsoft.Kusto/clusters/databases/scripts

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Padrão = ^.*$ (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: clusters/bancos de dados
Propriedades O script do banco de dados. ScriptProperties
tipo O tipo de recurso "Microsoft.Kusto/clusters/databases/scripts@2023-05-02"

ScriptProperties

Nome Descrição Valor
continueOnErrors Sinalizador que indica se deve continuar se um dos comandos falhar. Bool
forceUpdateTag Uma cadeia de caracteres exclusiva. Se alterado, o script será aplicado novamente. cadeia
scriptContent O conteúdo do script. Essa propriedade deve ser usada quando o script for fornecido embutido e não por meio de um arquivo em uma SA. Não deve ser usado junto com as propriedades scriptUrl E scriptUrlSasToken. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
scriptUrl A URL para o arquivo de blob de script KQL. Não deve ser usado junto com a propriedade scriptContent cadeia
scriptUrlSasToken O token SaS que fornece acesso de leitura ao arquivo que contém o script. Deve ser fornecido ao usar a propriedade scriptUrl. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do Kusto Script.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "cluster" {
  type      = "Microsoft.Kusto/clusters@2023-05-02"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      enableAutoStop                = true
      enableDiskEncryption          = false
      enableDoubleEncryption        = false
      enablePurge                   = false
      enableStreamingIngest         = false
      engineType                    = "V2"
      publicIPType                  = "IPv4"
      publicNetworkAccess           = "Enabled"
      restrictOutboundNetworkAccess = "Disabled"
      trustedExternalTenants = [
      ]
    }
    sku = {
      capacity = 1
      name     = "Dev(No SLA)_Standard_D11_v2"
      tier     = "Basic"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "database" {
  type      = "Microsoft.Kusto/clusters/databases@2023-05-02"
  parent_id = azapi_resource.cluster.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "ReadWrite"
    properties = {
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "script" {
  type      = "Microsoft.Kusto/clusters/databases/scripts@2023-05-02"
  parent_id = azapi_resource.database.id
  name      = "create-table-script"
  body = {
    properties = {
      continueOnErrors = false
      forceUpdateTag   = "9e2e7874-aa37-7041-81b7-06397f03a37d"
      scriptContent    = ".create table TestTable(Id:string, Name:string, _ts:long, _timestamp:datetime)\n.create table TestTable ingestion json mapping \"TestMapping\"\n'['\n'    {\"column\":\"Id\",\"path\":\"$.id\"},'\n'    {\"column\":\"Name\",\"path\":\"$.name\"},'\n'    {\"column\":\"_ts\",\"path\":\"$._ts\"},'\n'    {\"column\":\"_timestamp\",\"path\":\"$._ts\", \"transform\":\"DateTimeFromUnixSeconds\"}'\n']'\n.alter table TestTable policy ingestionbatching \"{'MaximumBatchingTimeSpan': '0:0:10', 'MaximumNumberOfItems': 10000}\"\n"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Um exemplo básico de implantação do Kusto Script.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "cluster" {
  type      = "Microsoft.Kusto/clusters@2023-05-02"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      enableAutoStop                = true
      enableDiskEncryption          = false
      enableDoubleEncryption        = false
      enablePurge                   = false
      enableStreamingIngest         = false
      engineType                    = "V2"
      publicIPType                  = "IPv4"
      publicNetworkAccess           = "Enabled"
      restrictOutboundNetworkAccess = "Disabled"
      trustedExternalTenants = [
      ]
    }
    sku = {
      capacity = 1
      name     = "Dev(No SLA)_Standard_D11_v2"
      tier     = "Basic"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "database" {
  type      = "Microsoft.Kusto/clusters/databases@2023-05-02"
  parent_id = azapi_resource.cluster.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "ReadWrite"
    properties = {
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "script" {
  type      = "Microsoft.Kusto/clusters/databases/scripts@2023-05-02"
  parent_id = azapi_resource.database.id
  name      = "create-table-script"
  body = {
    properties = {
      continueOnErrors = false
      forceUpdateTag   = "9e2e7874-aa37-7041-81b7-06397f03a37d"
      scriptContent    = ".create table TestTable(Id:string, Name:string, _ts:long, _timestamp:datetime)\n.create table TestTable ingestion json mapping \"TestMapping\"\n'['\n'    {\"column\":\"Id\",\"path\":\"$.id\"},'\n'    {\"column\":\"Name\",\"path\":\"$.name\"},'\n'    {\"column\":\"_ts\",\"path\":\"$._ts\"},'\n'    {\"column\":\"_timestamp\",\"path\":\"$._ts\", \"transform\":\"DateTimeFromUnixSeconds\"}'\n']'\n.alter table TestTable policy ingestionbatching \"{'MaximumBatchingTimeSpan': '0:0:10', 'MaximumNumberOfItems': 10000}\"\n"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on