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

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified sandbox custom image

Name	Datatype	Description
properties	object	A sandbox custom image.

list_by_cluster

Successfully retrieved the list of sandbox custom images.

Name	Datatype	Description
properties	object	A sandbox custom image.

Methods

The following methods are available for this resource:

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

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
clusterName	string	The name of the Kusto cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
sandboxCustomImageName	string	The name of the sandbox custom image.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Returns a sandbox custom image

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

list_by_cluster

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

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

INSERT examples

create_or_update

Creates or updates a sandbox custom image.

INSERT INTO azure.data_explorer.sandbox_custom_images (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
sandboxCustomImageName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ sandboxCustomImageName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: sandbox_custom_images
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sandbox_custom_images resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sandbox_custom_images resource.
    - name: clusterName
      value: string
      description: Required parameter for the sandbox_custom_images resource.
    - name: sandboxCustomImageName
      value: string
      description: Required parameter for the sandbox_custom_images resource.
    - name: properties
      value: object
      description: |
        A sandbox custom image.

UPDATE examples

update

Updates a sandbox custom image.

UPDATE azure.data_explorer.sandbox_custom_images
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND sandboxCustomImageName = '{{ sandboxCustomImageName }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes a sandbox custom image.

DELETE FROM azure.data_explorer.sandbox_custom_images
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND sandboxCustomImageName = '{{ sandboxCustomImageName }}' --required
;

Lifecycle Methods

check_name_availability

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

EXEC azure.data_explorer.sandbox_custom_images.check_name_availability 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;