sandbox_custom_images

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

Overview

Name	sandbox_custom_images
Type	Resource
Id	azure.data_explorer.sandbox_custom_images

Fields

vw_sandbox_custom_images

Name	Datatype	Description
clusterName	text	field from the properties object
language	text	field from the properties object
language_version	text	field from the properties object
provisioning_state	text	field from the properties object
requirements_file_content	text	field from the properties object
resourceGroupName	text	field from the properties object
sandboxCustomImageName	text	field from the properties object
subscriptionId	text	field from the properties object

sandbox_custom_images

Name	Datatype	Description
properties	object	A class representing the properties of a sandbox custom image object.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clusterName, resourceGroupName, sandboxCustomImageName, subscriptionId	Returns a sandbox custom image
list_by_cluster	SELECT	clusterName, resourceGroupName, subscriptionId	Returns the list of the existing sandbox custom images of the given Kusto cluster.
create_or_update	INSERT	clusterName, resourceGroupName, sandboxCustomImageName, subscriptionId	Creates or updates a sandbox custom image.
delete	DELETE	clusterName, resourceGroupName, sandboxCustomImageName, subscriptionId	Deletes a sandbox custom image.
update	UPDATE	clusterName, resourceGroupName, sandboxCustomImageName, subscriptionId	Updates a sandbox custom image.
check_name_availability	EXEC	clusterName, resourceGroupName, subscriptionId, data__name, data__type	Checks that the sandbox custom image resource name is valid and is not already in use.

SELECT examples

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

vw_sandbox_custom_images

SELECT
clusterName,
language,
language_version,
provisioning_state,
requirements_file_content,
resourceGroupName,
sandboxCustomImageName,
subscriptionId
FROM azure.data_explorer.vw_sandbox_custom_images
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

sandbox_custom_images

SELECT
properties
FROM azure.data_explorer.sandbox_custom_images
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new sandbox_custom_images resource.

All Properties

/*+ create */
INSERT INTO azure.data_explorer.sandbox_custom_images (
clusterName,
resourceGroupName,
sandboxCustomImageName,
subscriptionId,
properties
)
SELECT 
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ sandboxCustomImageName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: language
          value: string
        - name: languageVersion
          value: string
        - name: requirementsFileContent
          value: string
        - name: provisioningState
          value: []

UPDATE example

Updates a sandbox_custom_images resource.

/*+ update */
UPDATE azure.data_explorer.sandbox_custom_images
SET 
properties = '{{ properties }}'
WHERE 
clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND sandboxCustomImageName = '{{ sandboxCustomImageName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified sandbox_custom_images resource.

/*+ delete */
DELETE FROM azure.data_explorer.sandbox_custom_images
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND sandboxCustomImageName = '{{ sandboxCustomImageName }}'
AND subscriptionId = '{{ subscriptionId }}';