az synapse kql-script

  • Reference

Manage script with kusto.

Commands

Name Description Type Status
az synapse kql-script create

Creates a KQL script.

 Core GA
az synapse kql-script delete

Deletes a KQL script.

 Core GA
az synapse kql-script export

Export KQL scripts.

 Core GA
az synapse kql-script import

Creates a KQL script.

 Core GA
az synapse kql-script list

List KQL scripts.

 Core GA
az synapse kql-script show

Gets a KQL script.

 Core GA
az synapse kql-script wait

Place the CLI in a waiting state until a condition of a KQL script is met.

 Core GA

az synapse kql-script create

Edit

Creates a KQL script.

az synapse kql-script create --file
                             --name
                             --resource-group
                             --workspace-name
                             [--kusto-database-name]
                             [--kusto-pool-name]
                             [--no-wait]

Examples

KustoScriptsCreateOrUpdate

az synapse kql-script create --resource-group "kustorptest" --workspace-name "kustoWorkspaceName"                --kusto-pool-name kustopooltest --kusto-database-name kustodbtest --file C:\samples\KqlScript.kql                --name "kustoScript1"

Required Parameters

--file -f

The KQL query file path.

--name -n

The name of the KQL script.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the workspace.

Optional Parameters

--kusto-database-name

The name of the Kusto database.

--kusto-pool-name

The name of the Kusto pool.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse kql-script delete

Edit

Deletes a KQL script.

az synapse kql-script delete --name
                             --workspace-name
                             [--no-wait]
                             [--yes]

Examples

KustoScriptsDelete

az synapse kql-script delete --workspace-name "kustoWorkspaceName" --name "kustoScript1"

Required Parameters

--name -n

The name of the KQL script.

--workspace-name

The name of the workspace.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse kql-script export

Edit

Export KQL scripts.

az synapse kql-script export --output-folder
                             --workspace-name
                             [--name]

Examples

KustoScriptsExport

az synapse kql-script export --workspace-name "kustoWorkspaceName" --output-folder "C:\KqlScirpt"

Required Parameters

--output-folder

The name of the output folder.

--workspace-name

The name of the workspace.

Optional Parameters

--name -n

The name of the KQL script.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse kql-script import

Edit

Creates a KQL script.

az synapse kql-script import --file
                             --name
                             --resource-group
                             --workspace-name
                             [--kusto-database-name]
                             [--kusto-pool-name]
                             [--no-wait]

Examples

KustoScriptsCreateOrUpdate

az synapse kql-script import --resource-group "kustorptest" --workspace-name "kustoWorkspaceName"                --kusto-pool-name kustopooltest --kusto-database-name kustodbtest --file C:\samples\KqlScript.kql                --name "kustoScript1"

Required Parameters

--file -f

The KQL query file path.

--name -n

The name of the KQL script.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the workspace.

Optional Parameters

--kusto-database-name

The name of the Kusto database.

--kusto-pool-name

The name of the Kusto pool.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse kql-script list

Edit

List KQL scripts.

az synapse kql-script list --workspace-name

Examples

KustoScriptsList

az synapse kql-script list --workspace-name "kustoWorkspaceName"

Required Parameters

--workspace-name

The name of the workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse kql-script show

Edit

Gets a KQL script.

az synapse kql-script show --name
                           --workspace-name

Examples

KustoScriptsGet

az synapse kql-script show --workspace-name "kustoWorkspaceName" --name "kustoScript1"

Required Parameters

--name -n

The name of the KQL script.

--workspace-name

The name of the workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse kql-script wait

Edit

Place the CLI in a waiting state until a condition of a KQL script is met.

az synapse kql-script wait --name
                           --workspace-name
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--interval]
                           [--timeout]
                           [--updated]

Required Parameters

--name -n

The name of the KQL script.

--workspace-name

The name of the workspace.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.