SandboxCustomImagesOperations interface

Package:

@azure/arm-kusto

Interface representing a SandboxCustomImages operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
checkNameAvailability	Checks that the sandbox custom image resource name is valid and is not already in use.
createOrUpdate	Creates or updates a sandbox custom image.
delete	Deletes a sandbox custom image.
get	Returns a sandbox custom image
listByCluster	Returns the list of the existing sandbox custom images of the given Kusto cluster.
update	Updates a sandbox custom image.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

checkNameAvailability

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

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

Property Value

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

createOrUpdate

Creates or updates a sandbox custom image.

createOrUpdate: (resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, parameters: SandboxCustomImage, options?: SandboxCustomImagesCreateOrUpdateOptionalParams) => PollerLike<OperationState<SandboxCustomImage>, SandboxCustomImage>

Property Value

(resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, parameters: SandboxCustomImage, options?: SandboxCustomImagesCreateOrUpdateOptionalParams) => PollerLike<OperationState<SandboxCustomImage>, SandboxCustomImage>

delete

Deletes a sandbox custom image.

delete: (resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, options?: SandboxCustomImagesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, options?: SandboxCustomImagesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Returns a sandbox custom image

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

Property Value

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

listByCluster

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

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

Property Value

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

update

Updates a sandbox custom image.

update: (resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, parameters: SandboxCustomImage, options?: SandboxCustomImagesUpdateOptionalParams) => PollerLike<OperationState<SandboxCustomImage>, SandboxCustomImage>

Property Value

(resourceGroupName: string, clusterName: string, sandboxCustomImageName: string, parameters: SandboxCustomImage, options?: SandboxCustomImagesUpdateOptionalParams) => PollerLike<OperationState<SandboxCustomImage>, SandboxCustomImage>