sandbox_custom_images

Creates, updates, deletes, gets or lists a sandbox_custom_images resource.

Overview

Name	sandbox_custom_images
Type	Resource
Id	azure.kusto.sandbox_custom_images

Fields

The following fields are returned by SELECT queries:

check_name_availability

Name	Datatype	Description
name	string	The name that was checked.
message	string	Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
nameAvailable	boolean	Specifies a Boolean value that indicates if the name is available.
reason	string	Message providing the reason why the given name is invalid. Known values are: "Invalid" and "AlreadyExists". (Invalid, AlreadyExists)

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
baseImageName	string	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.
language	string	The language name, for example Python. Required. "Python" (Python)
languageVersion	string	The version of the language. Either this property or baseImageName should be specified.
provisioningState	string	The provisioned state of the resource. Known values are: "Running", "Creating", "Deleting", "Succeeded", "Failed", "Moving", and "Canceled". (Running, Creating, Deleting, Succeeded, Failed, Moving, Canceled)
requirementsFileContent	string	The requirements file content.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_cluster

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
baseImageName	string	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.
language	string	The language name, for example Python. Required. "Python" (Python)
languageVersion	string	The version of the language. Either this property or baseImageName should be specified.
provisioningState	string	The provisioned state of the resource. Known values are: "Running", "Creating", "Deleting", "Succeeded", "Failed", "Moving", and "Canceled". (Running, Creating, Deleting, Succeeded, Failed, Moving, Canceled)
requirementsFileContent	string	The requirements file content.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
check_name_availability	select	resource_group_name, cluster_name, subscription_id		Checks that the sandbox custom image resource name is valid and is not already in use.
get	select	resource_group_name, cluster_name, sandbox_custom_image_name, subscription_id		Returns a sandbox custom image.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id		Returns the list of the existing sandbox custom images of the given Kusto cluster.
create_or_update	insert	resource_group_name, cluster_name, sandbox_custom_image_name, subscription_id		Creates or updates a sandbox custom image.
update	update	resource_group_name, cluster_name, sandbox_custom_image_name, subscription_id		Updates a sandbox custom image.
create_or_update	replace	resource_group_name, cluster_name, sandbox_custom_image_name, subscription_id		Creates or updates a sandbox custom image.
delete	delete	resource_group_name, cluster_name, sandbox_custom_image_name, subscription_id		Deletes a sandbox custom image.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_name	string	The name of the Kusto cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sandbox_custom_image_name	string	The name of the sandbox custom image. Required.
subscription_id	string

SELECT examples

check_name_availability

Checks that the sandbox custom image resource name is valid and is not already in use.

SELECT
name,
message,
nameAvailable,
reason
FROM azure.kusto.sandbox_custom_images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Returns a sandbox custom image.

SELECT
id,
name,
baseImageName,
language,
languageVersion,
provisioningState,
requirementsFileContent,
systemData,
type
FROM azure.kusto.sandbox_custom_images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND sandbox_custom_image_name = '{{ sandbox_custom_image_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_cluster

Returns the list of the existing sandbox custom images of the given Kusto cluster.

SELECT
id,
name,
baseImageName,
language,
languageVersion,
provisioningState,
requirementsFileContent,
systemData,
type
FROM azure.kusto.sandbox_custom_images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a sandbox custom image.

INSERT INTO azure.kusto.sandbox_custom_images (
properties,
resource_group_name,
cluster_name,
sandbox_custom_image_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ sandbox_custom_image_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sandbox_custom_images
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sandbox_custom_images resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the sandbox_custom_images resource.
  - name: sandbox_custom_image_name
    value: "{{ sandbox_custom_image_name }}"
    description: Required parameter for the sandbox_custom_images resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sandbox_custom_images resource.
  - name: properties
    description: |
      A sandbox custom image.
    value:
      language: "{{ language }}"
      languageVersion: "{{ languageVersion }}"
      baseImageName: "{{ baseImageName }}"
      requirementsFileContent: "{{ requirementsFileContent }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates a sandbox custom image.

UPDATE azure.kusto.sandbox_custom_images
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND sandbox_custom_image_name = '{{ sandbox_custom_image_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates a sandbox custom image.

REPLACE azure.kusto.sandbox_custom_images
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND sandbox_custom_image_name = '{{ sandbox_custom_image_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a sandbox custom image.

DELETE FROM azure.kusto.sandbox_custom_images
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND sandbox_custom_image_name = '{{ sandbox_custom_image_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;