Microsoft.Kusto clusters/sandboxCustomImages 2024-04-13

Bicep resource definition

The clusters/sandboxCustomImages resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Kusto/clusters/sandboxCustomImages resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Kusto/clusters/sandboxCustomImages@2024-04-13' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    baseImageName: 'string'
    language: 'string'
    languageVersion: 'string'
    requirementsFileContent: 'string'
  }
}

Property values

Microsoft.Kusto/clusters/sandboxCustomImages

Name Description Value
name The resource name string

Constraints:
Pattern = ^.*$ (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
properties A sandbox custom image. SandboxCustomImageProperties

SandboxCustomImageProperties

Name Description Value
baseImageName The base image name on which the custom image is built on top of. It can be one of the LanguageExtensionImageName (e.g.: 'Python3_10_8', 'Python3_10_8_DL') or the name of an existing custom image. Either this property or languageVersion should be specified. string
language The language name, for example Python. 'Python' (required)
languageVersion The version of the language. Either this property or baseImageName should be specified. string
requirementsFileContent The requirements file content. string

ARM template resource definition

The clusters/sandboxCustomImages resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Kusto/clusters/sandboxCustomImages resource, add the following JSON to your template.

{
  "type": "Microsoft.Kusto/clusters/sandboxCustomImages",
  "apiVersion": "2024-04-13",
  "name": "string",
  "properties": {
    "baseImageName": "string",
    "language": "string",
    "languageVersion": "string",
    "requirementsFileContent": "string"
  }
}

Property values

Microsoft.Kusto/clusters/sandboxCustomImages

Name Description Value
apiVersion The api version '2024-04-13'
name The resource name string

Constraints:
Pattern = ^.*$ (required)
properties A sandbox custom image. SandboxCustomImageProperties
type The resource type 'Microsoft.Kusto/clusters/sandboxCustomImages'

SandboxCustomImageProperties

Name Description Value
baseImageName The base image name on which the custom image is built on top of. It can be one of the LanguageExtensionImageName (e.g.: 'Python3_10_8', 'Python3_10_8_DL') or the name of an existing custom image. Either this property or languageVersion should be specified. string
language The language name, for example Python. 'Python' (required)
languageVersion The version of the language. Either this property or baseImageName should be specified. string
requirementsFileContent The requirements file content. string

Terraform (AzAPI provider) resource definition

The clusters/sandboxCustomImages 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/sandboxCustomImages resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Kusto/clusters/sandboxCustomImages@2024-04-13"
  name = "string"
  body = jsonencode({
    properties = {
      baseImageName = "string"
      language = "string"
      languageVersion = "string"
      requirementsFileContent = "string"
    }
  })
}

Property values

Microsoft.Kusto/clusters/sandboxCustomImages

Name Description Value
name The resource name string

Constraints:
Pattern = ^.*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: clusters
properties A sandbox custom image. SandboxCustomImageProperties
type The resource type "Microsoft.Kusto/clusters/sandboxCustomImages@2024-04-13"

SandboxCustomImageProperties

Name Description Value
baseImageName The base image name on which the custom image is built on top of. It can be one of the LanguageExtensionImageName (e.g.: 'Python3_10_8', 'Python3_10_8_DL') or the name of an existing custom image. Either this property or languageVersion should be specified. string
language The language name, for example Python. 'Python' (required)
languageVersion The version of the language. Either this property or baseImageName should be specified. string
requirementsFileContent The requirements file content. string