az synapse kql-script

kusto を使用してスクリプトを管理します。

コマンド

名前	説明	型	状態
az synapse kql-script create	KQL スクリプトを作成します。	Core	GA
az synapse kql-script delete	KQL スクリプトを削除します。	Core	GA
az synapse kql-script export	KQL スクリプトをエクスポートします。	Core	GA
az synapse kql-script import	KQL スクリプトを作成します。	Core	GA
az synapse kql-script list	KQL スクリプトを一覧表示します。	Core	GA
az synapse kql-script show	KQL スクリプトを取得します。	Core	GA
az synapse kql-script wait	KQL スクリプトの条件が満たされるまで、CLI を待機状態にします。	Core	GA

az synapse kql-script create

KQL スクリプトを作成します。

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

例

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"

必須のパラメーター

--file -f

KQL クエリ ファイルのパス。

--name -n

KQL スクリプトの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--workspace-name

ワークスペースの名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--kusto-database-name

Kusto データベースの名前。

--kusto-pool-name

Kusto プールの名前。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az synapse kql-script delete

KQL スクリプトを削除します。

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

例

KustoScriptsDelete

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

必須のパラメーター

--name -n

KQL スクリプトの名前。

--workspace-name

ワークスペースの名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--yes -y

確認を求めないでください。

プロパティ	値
規定値:	False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az synapse kql-script export

KQL スクリプトをエクスポートします。

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

例

KustoScriptsExport

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

必須のパラメーター

--output-folder

出力フォルダーの名前。

--workspace-name

ワークスペースの名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--name -n

KQL スクリプトの名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az synapse kql-script import

KQL スクリプトを作成します。

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

例

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"

必須のパラメーター

--file -f

KQL クエリ ファイルのパス。

--name -n

KQL スクリプトの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--workspace-name

ワークスペースの名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--kusto-database-name

Kusto データベースの名前。

--kusto-pool-name

Kusto プールの名前。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az synapse kql-script list

KQL スクリプトを一覧表示します。

az synapse kql-script list --workspace-name

例

KustoScriptsList

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

必須のパラメーター

--workspace-name

ワークスペースの名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az synapse kql-script show

KQL スクリプトを取得します。

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

例

KustoScriptsGet

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

必須のパラメーター

--name -n

KQL スクリプトの名前。

--workspace-name

ワークスペースの名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az synapse kql-script wait

KQL スクリプトの条件が満たされるまで、CLI を待機状態にします。

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

必須のパラメーター

--name -n

KQL スクリプトの名前。

--workspace-name

ワークスペースの名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

プロパティ	値
Parameter group:	Wait Condition Arguments

--deleted

削除されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--exists

リソースが存在するまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--interval

ポーリング間隔 (秒単位)。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	30

--timeout

最大待機時間 (秒単位)。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False