SandboxCustomImages interface

Package:

@azure/arm-kusto

Interface representing a SandboxCustomImages.

Methods

beginCreateOrUpdate(string, string, string, SandboxCustomImage, SandboxCustomImagesCreateOrUpdateOptionalParams)	Creates or updates a sandbox custom image.
beginCreateOrUpdateAndWait(string, string, string, SandboxCustomImage, SandboxCustomImagesCreateOrUpdateOptionalParams)	Creates or updates a sandbox custom image.
beginDelete(string, string, string, SandboxCustomImagesDeleteOptionalParams)	Deletes a sandbox custom image.
beginDeleteAndWait(string, string, string, SandboxCustomImagesDeleteOptionalParams)	Deletes a sandbox custom image.
beginUpdate(string, string, string, SandboxCustomImage, SandboxCustomImagesUpdateOptionalParams)	Updates a sandbox custom image.
beginUpdateAndWait(string, string, string, SandboxCustomImage, SandboxCustomImagesUpdateOptionalParams)	Updates a sandbox custom image.
checkNameAvailability(string, string, SandboxCustomImagesCheckNameRequest, SandboxCustomImagesCheckNameAvailabilityOptionalParams)	Checks that the sandbox custom image resource name is valid and is not already in use.
get(string, string, string, SandboxCustomImagesGetOptionalParams)	Returns a sandbox custom image
listByCluster(string, string, SandboxCustomImagesListByClusterOptionalParams)	Returns the list of the existing sandbox custom images of the given Kusto cluster.

Method Details

beginCreateOrUpdate(string, string, string, SandboxCustomImage, SandboxCustomImagesCreateOrUpdateOptionalParams)

Creates or updates a sandbox custom image.

function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, parameters: SandboxCustomImage, options?: SandboxCustomImagesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SandboxCustomImage>, SandboxCustomImage>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

sandboxCustomImageName

string

The name of the sandbox custom image.

parameters

SandboxCustomImage

The sandbox custom image parameters.

options

SandboxCustomImagesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SandboxCustomImage>, SandboxCustomImage>>

beginCreateOrUpdateAndWait(string, string, string, SandboxCustomImage, SandboxCustomImagesCreateOrUpdateOptionalParams)

Creates or updates a sandbox custom image.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, parameters: SandboxCustomImage, options?: SandboxCustomImagesCreateOrUpdateOptionalParams): Promise<SandboxCustomImage>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

sandboxCustomImageName

string

The name of the sandbox custom image.

parameters

SandboxCustomImage

The sandbox custom image parameters.

options

SandboxCustomImagesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SandboxCustomImage>

beginDelete(string, string, string, SandboxCustomImagesDeleteOptionalParams)

Deletes a sandbox custom image.

function beginDelete(resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, options?: SandboxCustomImagesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

sandboxCustomImageName

string

The name of the sandbox custom image.

options

SandboxCustomImagesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, SandboxCustomImagesDeleteOptionalParams)

Deletes a sandbox custom image.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, options?: SandboxCustomImagesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

sandboxCustomImageName

string

The name of the sandbox custom image.

options

SandboxCustomImagesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, SandboxCustomImage, SandboxCustomImagesUpdateOptionalParams)

Updates a sandbox custom image.

function beginUpdate(resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, parameters: SandboxCustomImage, options?: SandboxCustomImagesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SandboxCustomImage>, SandboxCustomImage>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

sandboxCustomImageName

string

The name of the sandbox custom image.

parameters

SandboxCustomImage

The sandbox custom image parameters.

options

SandboxCustomImagesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SandboxCustomImage>, SandboxCustomImage>>

beginUpdateAndWait(string, string, string, SandboxCustomImage, SandboxCustomImagesUpdateOptionalParams)

Updates a sandbox custom image.

function beginUpdateAndWait(resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, parameters: SandboxCustomImage, options?: SandboxCustomImagesUpdateOptionalParams): Promise<SandboxCustomImage>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

sandboxCustomImageName

string

The name of the sandbox custom image.

parameters

SandboxCustomImage

The sandbox custom image parameters.

options

SandboxCustomImagesUpdateOptionalParams

The options parameters.

Returns

Promise<SandboxCustomImage>

checkNameAvailability(string, string, SandboxCustomImagesCheckNameRequest, SandboxCustomImagesCheckNameAvailabilityOptionalParams)

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

function checkNameAvailability(resourceGroupName: string, clusterName: string, resourceName: SandboxCustomImagesCheckNameRequest, options?: SandboxCustomImagesCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

resourceName

SandboxCustomImagesCheckNameRequest

The name of the resource.

options

SandboxCustomImagesCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameResult>

get(string, string, string, SandboxCustomImagesGetOptionalParams)

Returns a sandbox custom image

function get(resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, options?: SandboxCustomImagesGetOptionalParams): Promise<SandboxCustomImage>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

sandboxCustomImageName

string

The name of the sandbox custom image.

options

SandboxCustomImagesGetOptionalParams

The options parameters.

Returns

Promise<SandboxCustomImage>

listByCluster(string, string, SandboxCustomImagesListByClusterOptionalParams)

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

function listByCluster(resourceGroupName: string, clusterName: string, options?: SandboxCustomImagesListByClusterOptionalParams): PagedAsyncIterableIterator<SandboxCustomImage, SandboxCustomImage[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the Kusto cluster.

options

SandboxCustomImagesListByClusterOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SandboxCustomImage, SandboxCustomImage[], PageSettings>