az synapse kql-script

參考

使用 kusto 管理腳本。

命令

名稱	Description	類型	狀態
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	將 CLI 置於等候狀態，直到符合 KQL 腳本的條件為止。	核心	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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az synapse kql-script wait

編輯

將 CLI 置於等候狀態，直到符合 KQL 腳本的條件為止。

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

必要參數

--name -n

KQL 腳本的名稱。

--workspace-name

工作區的名稱。

選擇性參數

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

必要參數

選擇性參數

意見反應

其他資源