az synapse kql-script

リファレンス

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

コマンド

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

ワークスペースの名前。

省略可能のパラメーター

--kusto-database-name

Kusto データベースの名前。

--kusto-pool-name

Kusto プールの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

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

ワークスペースの名前。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--yes -y

確認のダイアログを表示しません。

規定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

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

ワークスペースの名前。

省略可能のパラメーター

--name -n

KQL スクリプトの名前。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

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

ワークスペースの名前。

省略可能のパラメーター

--kusto-database-name

Kusto データベースの名前。

--kusto-pool-name

Kusto プールの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

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

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

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

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

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

ワークスペースの名前。

省略可能のパラメーター

--created

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

規定値: False

--custom

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

--deleted

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

規定値: False

--exists

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

規定値: False

--interval

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

規定値: 30

--timeout

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

規定値: 3600

--updated

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

規定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

az synapse kql-script

コマンド

az synapse kql-script create

例

必須のパラメーター

省略可能のパラメーター

az synapse kql-script delete

例

必須のパラメーター

省略可能のパラメーター

az synapse kql-script export

例

必須のパラメーター

省略可能のパラメーター

az synapse kql-script import

例

必須のパラメーター

省略可能のパラメーター

az synapse kql-script list

例

必須のパラメーター

az synapse kql-script show

例

必須のパラメーター

az synapse kql-script wait

必須のパラメーター

省略可能のパラメーター

その他のリソース