Freigeben über


Microsoft.Kusto cluster/databases/scripts 2022-02-01

Bicep-Ressourcendefinition

Der Ressourcentyp cluster/databases/scripts kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Kusto/clusters/databases/scripts-Ressource zu erstellen, fügen Sie ihrer Vorlage die folgende Bicep hinzu.

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'
  }
}

Eigenschaftswerte

Microsoft.Kusto/clusters/databases/scripts

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Elternteil In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für Ressource vom Typ: Cluster/Datenbanken
Eigenschaften Das Datenbankskript. ScriptProperties-

ScriptProperties

Name Beschreibung Wert
continueOnErrors Flag, das angibt, ob der Vorgang fortgesetzt werden soll, wenn ein Befehl fehlschlägt. Bool
forceUpdateTag Eine eindeutige Zeichenfolge. Wenn das Skript geändert wird, wird es erneut angewendet. Schnur
scriptContent Der Skriptinhalt. Diese Eigenschaft sollte verwendet werden, wenn das Skript inline und nicht über die Datei in einer SA bereitgestellt wird. Darf nicht zusammen mit scriptUrl- und scriptUrlSasToken-Eigenschaften verwendet werden. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
scriptUrl Die URL zur KQL-Skript-BLOB-Datei. Darf nicht zusammen mit der scriptContent-Eigenschaft verwendet werden Schnur
scriptUrlSasToken Das SaS-Token, das Lesezugriff auf die Datei ermöglicht, die das Skript enthält. Muss bei Verwendung der scriptUrl-Eigenschaft bereitgestellt werden. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

Verwendungsbeispiele

Azure-Schnellstartbeispiele

Die folgenden Azure-Schnellstartvorlagen Bicep-Beispiele für die Bereitstellung dieses Ressourcentyps enthalten.

Bicep-Datei Beschreibung
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung.
Bereitstellen von Azure Data Explorer db mit Ereignisrasterverbindung Bereitstellen von Azure Data Explorer db mit Event Grid-Verbindung.
Bereitstellen von Azure Data Explorer db mit Event Hub-Verbindung Bereitstellen von Azure Data Explorer db mit Event Hub-Verbindung.
FinOps Hub- Diese Vorlage erstellt eine neue FinOps-Hubinstanz, einschließlich Data Explorer, Data Lake Storage und Data Factory.

ARM-Vorlagenressourcendefinition

Der Ressourcentyp cluster/databases/scripts kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Kusto/clusters/databases/scripts-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

Microsoft.Kusto/clusters/databases/scripts

Name Beschreibung Wert
apiVersion Die API-Version '2022-02-01'
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Das Datenbankskript. ScriptProperties-
Art Der Ressourcentyp 'Microsoft.Kusto/clusters/databases/scripts'

ScriptProperties

Name Beschreibung Wert
continueOnErrors Flag, das angibt, ob der Vorgang fortgesetzt werden soll, wenn ein Befehl fehlschlägt. Bool
forceUpdateTag Eine eindeutige Zeichenfolge. Wenn das Skript geändert wird, wird es erneut angewendet. Schnur
scriptContent Der Skriptinhalt. Diese Eigenschaft sollte verwendet werden, wenn das Skript inline und nicht über die Datei in einer SA bereitgestellt wird. Darf nicht zusammen mit scriptUrl- und scriptUrlSasToken-Eigenschaften verwendet werden. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
scriptUrl Die URL zur KQL-Skript-BLOB-Datei. Darf nicht zusammen mit der scriptContent-Eigenschaft verwendet werden Schnur
scriptUrlSasToken Das SaS-Token, das Lesezugriff auf die Datei ermöglicht, die das Skript enthält. Muss bei Verwendung der scriptUrl-Eigenschaft bereitgestellt werden. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

Verwendungsbeispiele

Azure-Schnellstartvorlagen

Die folgenden Azure-Schnellstartvorlagen diesen Ressourcentyp bereitstellen.

Schablone Beschreibung
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung

Bereitstellen in Azure
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung.
Bereitstellen von Azure Data Explorer db mit Ereignisrasterverbindung

Bereitstellen in Azure
Bereitstellen von Azure Data Explorer db mit Event Grid-Verbindung.
Bereitstellen von Azure Data Explorer db mit Event Hub-Verbindung

Bereitstellen in Azure
Bereitstellen von Azure Data Explorer db mit Event Hub-Verbindung.
FinOps Hub-

Bereitstellen in Azure
Diese Vorlage erstellt eine neue FinOps-Hubinstanz, einschließlich Data Explorer, Data Lake Storage und Data Factory.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp cluster/databases/scripts kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Kusto/clusters/databases/scripts-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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"
    }
  }
}

Eigenschaftswerte

Microsoft.Kusto/clusters/databases/scripts

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: Cluster/Datenbanken
Eigenschaften Das Datenbankskript. ScriptProperties-
Art Der Ressourcentyp "Microsoft.Kusto/clusters/databases/scripts@2022-02-01"

ScriptProperties

Name Beschreibung Wert
continueOnErrors Flag, das angibt, ob der Vorgang fortgesetzt werden soll, wenn ein Befehl fehlschlägt. Bool
forceUpdateTag Eine eindeutige Zeichenfolge. Wenn das Skript geändert wird, wird es erneut angewendet. Schnur
scriptContent Der Skriptinhalt. Diese Eigenschaft sollte verwendet werden, wenn das Skript inline und nicht über die Datei in einer SA bereitgestellt wird. Darf nicht zusammen mit scriptUrl- und scriptUrlSasToken-Eigenschaften verwendet werden. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
scriptUrl Die URL zur KQL-Skript-BLOB-Datei. Darf nicht zusammen mit der scriptContent-Eigenschaft verwendet werden Schnur
scriptUrlSasToken Das SaS-Token, das Lesezugriff auf die Datei ermöglicht, die das Skript enthält. Muss bei Verwendung der scriptUrl-Eigenschaft bereitgestellt werden. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

Verwendungsbeispiele

Terraform-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung von Kusto-Skript.

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    = ["*"]
}

Ein grundlegendes Beispiel für die Bereitstellung von Kusto-Skript.

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    = ["*"]
}