KqlScriptOperations interface

Package:

@azure/synapse-artifacts

Interface representing a KqlScriptOperations.

Methods

beginCreateOrUpdate(string, KqlScriptResource, KqlScriptCreateOrUpdateOptionalParams)	Creates or updates a KQL Script
beginCreateOrUpdateAndWait(string, KqlScriptResource, KqlScriptCreateOrUpdateOptionalParams)	Creates or updates a KQL Script
beginDeleteByName(string, KqlScriptDeleteByNameOptionalParams)	Delete KQL script by name
beginDeleteByNameAndWait(string, KqlScriptDeleteByNameOptionalParams)	Delete KQL script by name
beginRename(string, ArtifactRenameRequest, KqlScriptRenameOptionalParams)	Rename KQL script
beginRenameAndWait(string, ArtifactRenameRequest, KqlScriptRenameOptionalParams)	Rename KQL script
getByName(string, KqlScriptGetByNameOptionalParams)	Get KQL script by name

Method Details

beginCreateOrUpdate(string, KqlScriptResource, KqlScriptCreateOrUpdateOptionalParams)

Creates or updates a KQL Script

function beginCreateOrUpdate(kqlScriptName: string, kqlScript: KqlScriptResource, options?: KqlScriptCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<KqlScriptResource>, KqlScriptResource>>

Parameters

kqlScriptName

string

KQL script name

kqlScript

KqlScriptResource

KQL script

options

KqlScriptCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, KqlScriptResource, KqlScriptCreateOrUpdateOptionalParams)

Creates or updates a KQL Script

function beginCreateOrUpdateAndWait(kqlScriptName: string, kqlScript: KqlScriptResource, options?: KqlScriptCreateOrUpdateOptionalParams): Promise<KqlScriptResource>

Parameters

kqlScriptName

string

KQL script name

kqlScript

KqlScriptResource

KQL script

options

KqlScriptCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<KqlScriptResource>

beginDeleteByName(string, KqlScriptDeleteByNameOptionalParams)

Delete KQL script by name

function beginDeleteByName(kqlScriptName: string, options?: KqlScriptDeleteByNameOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

kqlScriptName

string

KQL script name

options

KqlScriptDeleteByNameOptionalParams

The options parameters.

Returns

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

beginDeleteByNameAndWait(string, KqlScriptDeleteByNameOptionalParams)

Delete KQL script by name

function beginDeleteByNameAndWait(kqlScriptName: string, options?: KqlScriptDeleteByNameOptionalParams): Promise<void>

Parameters

kqlScriptName

string

KQL script name

options

KqlScriptDeleteByNameOptionalParams

The options parameters.

Returns

Promise<void>

beginRename(string, ArtifactRenameRequest, KqlScriptRenameOptionalParams)

Rename KQL script

function beginRename(kqlScriptName: string, renameRequest: ArtifactRenameRequest, options?: KqlScriptRenameOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

kqlScriptName

string

KQL script name

renameRequest

ArtifactRenameRequest

Rename request

options

KqlScriptRenameOptionalParams

The options parameters.

Returns

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

beginRenameAndWait(string, ArtifactRenameRequest, KqlScriptRenameOptionalParams)

Rename KQL script

function beginRenameAndWait(kqlScriptName: string, renameRequest: ArtifactRenameRequest, options?: KqlScriptRenameOptionalParams): Promise<void>

Parameters

kqlScriptName

string

KQL script name

renameRequest

ArtifactRenameRequest

Rename request

options

KqlScriptRenameOptionalParams

The options parameters.

Returns

Promise<void>

getByName(string, KqlScriptGetByNameOptionalParams)

Get KQL script by name

function getByName(kqlScriptName: string, options?: KqlScriptGetByNameOptionalParams): Promise<KqlScriptResource>

Parameters

kqlScriptName

string

KQL script name

options

KqlScriptGetByNameOptionalParams

The options parameters.

Returns

Promise<KqlScriptResource>