az synapse kusto attached-database-configuration

此命令群組是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

使用 synapse 管理 kusto 集區附加的資料庫組態。

命令

名稱 Description 類型 狀態
az synapse kusto attached-database-configuration create

建立附加的資料庫組態。

核心 實驗性
az synapse kusto attached-database-configuration delete

刪除具有指定名稱的附加資料庫組態。

核心 實驗性
az synapse kusto attached-database-configuration list

傳回指定 Kusto 集區的附加資料庫組態清單。

核心 實驗性
az synapse kusto attached-database-configuration show

傳回附加的資料庫組態。

核心 實驗性
az synapse kusto attached-database-configuration update

更新附加的資料庫組態。

核心 實驗性
az synapse kusto attached-database-configuration wait

將 CLI 置於等候狀態,直到符合 synapse kusto attached-database-configuration 的條件為止。

核心 實驗性

az synapse kusto attached-database-configuration create

實驗

命令群組 'synapse kusto attached-database-configuration' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

建立附加的資料庫組態。

az synapse kusto attached-database-configuration create --attached-database-configuration-name
                                                        --kusto-pool-name
                                                        --resource-group
                                                        --workspace-name
                                                        [--database-name]
                                                        [--default-principals-modification-kind {None, Replace, Union}]
                                                        [--kusto-pool-resource-id]
                                                        [--location]
                                                        [--no-wait]
                                                        [--table-level-sharing-properties]

範例

KustoPoolAttachedDatabaseConfigurationsCreateOrUpdate

az synapse kusto attached-database-configuration create --attached-database-configuration-name "attachedDatabaseConfigurations1" --kusto-pool-name "kustoclusterrptest4" --location "westus" --kusto-pool-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/Workspaces/kustorptest/KustoPools/kustoclusterrptest4" --database-name "kustodatabase" --default-principals-modification-kind "Union" --table-level-sharing-properties external-tables-to-exclude="ExternalTable2" external-tables-to-include="ExternalTable1" materialized-views-to-exclude="MaterializedViewTable2" materialized-views-to-include="MaterializedViewTable1" tables-to-exclude="Table2" tables-to-include="Table1" --resource-group "kustorptest" --workspace-name "kustorptest"

必要參數

--attached-database-configuration-name

附加資料庫組態的名稱。

--kusto-pool-name

Kusto 集區的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--workspace-name

工作區的名稱。

選擇性參數

--database-name

您要附加的資料庫名稱,如果您要追蹤所有目前和未來的資料庫,請使用 * 。

--default-principals-modification-kind

默認主體修改種類。

接受的值: None, Replace, Union
--kusto-pool-resource-id

您要附加之資料庫所在的 kusto 集區資源識別碼。

--location -l

位置。​​ 來自的值: az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False
--table-level-sharing-properties

數據表層級共享規格。

使用方式:--table-level-sharing-properties tables-to-include=XX tables-to-exclude=XX external-tables-to-include=XX external-tables-to-exclude=XX materialized-views-to-include=XX materialized-views-to-exclude=XX

tables-to-include:要包含在追蹤資料庫數據表中的數據表清單-to-exclude:要從追蹤資料庫 external-tables-to-include 中排除的數據表清單:要包含在追蹤資料庫 external-tables 中的外部數據表清單 to-exclude:從下列專案資料庫具體化檢視排除的外部數據表清單:要包含在追蹤資料庫具體化檢視中的具體化檢視清單具體化檢視清單具體化檢視表清單-to-exclude:從追蹤者排除具體化檢視清單資料庫。

全域參數
--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 kusto attached-database-configuration delete

實驗

命令群組 'synapse kusto attached-database-configuration' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

刪除具有指定名稱的附加資料庫組態。

az synapse kusto attached-database-configuration delete [--attached-database-configuration-name]
                                                        [--ids]
                                                        [--kusto-pool-name]
                                                        [--no-wait]
                                                        [--resource-group]
                                                        [--subscription]
                                                        [--workspace-name]
                                                        [--yes]

範例

KustoPoolAttachedDatabaseConfigurationsDelete

az synapse kusto attached-database-configuration delete --attached-database-configuration-name "attachedDatabaseConfigurations1" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"

選擇性參數

--attached-database-configuration-name

附加資料庫組態的名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--kusto-pool-name

Kusto 集區的名稱。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False
--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--subscription

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

--workspace-name

工作區的名稱。

--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 kusto attached-database-configuration list

實驗

命令群組 'synapse kusto attached-database-configuration' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

傳回指定 Kusto 集區的附加資料庫組態清單。

az synapse kusto attached-database-configuration list --kusto-pool-name
                                                      --resource-group
                                                      --workspace-name

範例

KustoPoolAttachedDatabaseConfigurationsListByKustoPool

az synapse kusto attached-database-configuration list --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"

必要參數

--kusto-pool-name

Kusto 集區的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--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 kusto attached-database-configuration show

實驗

命令群組 'synapse kusto attached-database-configuration' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

傳回附加的資料庫組態。

az synapse kusto attached-database-configuration show [--attached-database-configuration-name]
                                                      [--ids]
                                                      [--kusto-pool-name]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--workspace-name]

範例

KustoPoolAttachedDatabaseConfigurationsGet

az synapse kusto attached-database-configuration show --attached-database-configuration-name "attachedDatabaseConfigurations1" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"

選擇性參數

--attached-database-configuration-name

附加資料庫組態的名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--kusto-pool-name

Kusto 集區的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--subscription

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

--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 kusto attached-database-configuration update

實驗

命令群組 'synapse kusto attached-database-configuration' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

更新附加的資料庫組態。

az synapse kusto attached-database-configuration update [--add]
                                                        [--attached-database-configuration-name]
                                                        [--database-name]
                                                        [--default-principals-modification-kind {None, Replace, Union}]
                                                        [--force-string]
                                                        [--ids]
                                                        [--kusto-pool-name]
                                                        [--kusto-pool-resource-id]
                                                        [--location]
                                                        [--no-wait]
                                                        [--remove]
                                                        [--resource-group]
                                                        [--set]
                                                        [--subscription]
                                                        [--table-level-sharing-properties]
                                                        [--workspace-name]

選擇性參數

--add

藉由指定路徑和索引鍵值組,將物件加入物件清單。 範例:--add property.listProperty <key=value, string or JSON string>

預設值: []
--attached-database-configuration-name

附加資料庫組態的名稱。

--database-name

您要附加的資料庫名稱,如果您要追蹤所有目前和未來的資料庫,請使用 * 。

--default-principals-modification-kind

默認主體修改種類。

接受的值: None, Replace, Union
--force-string

使用 'set' 或 'add' 時,請保留字串常值,而不是嘗試轉換成 JSON。

預設值: False
--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--kusto-pool-name

Kusto 集區的名稱。

--kusto-pool-resource-id

您要附加之資料庫所在的 kusto 集區資源識別碼。

--location -l

位置。​​ 來自的值: az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False
--remove

從清單中移除屬性或專案。 範例: --remove property.list <indexToRemove>--remove propertyToRemove

預設值: []
--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--set

指定要設定的屬性路徑和值,以更新物件。 範例:--set property1.property2=<value>

預設值: []
--subscription

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

--table-level-sharing-properties

數據表層級共享規格。

使用方式:--table-level-sharing-properties tables-to-include=XX tables-to-exclude=XX external-tables-to-include=XX external-tables-to-exclude=XX materialized-views-to-include=XX materialized-views-to-exclude=XX

tables-to-include:要包含在追蹤資料庫數據表中的數據表清單-to-exclude:要從追蹤資料庫 external-tables-to-include 中排除的數據表清單:要包含在追蹤資料庫 external-tables 中的外部數據表清單 to-exclude:從下列專案資料庫具體化檢視排除的外部數據表清單:要包含在追蹤資料庫具體化檢視中的具體化檢視清單具體化檢視清單具體化檢視表清單-to-exclude:從追蹤者排除具體化檢視清單資料庫。

--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 kusto attached-database-configuration wait

實驗

命令群組 'synapse kusto attached-database-configuration' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

將 CLI 置於等候狀態,直到符合 synapse kusto attached-database-configuration 的條件為止。

az synapse kusto attached-database-configuration wait [--attached-database-configuration-name]
                                                      [--created]
                                                      [--custom]
                                                      [--deleted]
                                                      [--exists]
                                                      [--ids]
                                                      [--interval]
                                                      [--kusto-pool-name]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--timeout]
                                                      [--updated]
                                                      [--workspace-name]

範例

暫停執行下一行 CLI 腳本,直到成功建立 synapse kusto attached-database-configuration 為止。

az synapse kusto attached-database-configuration wait --attached-database-configuration-name "attachedDatabaseConfigurations1" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest" --created

暫停執行下一行 CLI 腳本,直到 synapse kusto attached-database-configuration 成功更新為止。

az synapse kusto attached-database-configuration wait --attached-database-configuration-name "attachedDatabaseConfigurations1" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest" --updated

暫停執行下一行 CLI 腳本,直到成功刪除 synapse kusto attached-database-configuration 為止。

az synapse kusto attached-database-configuration wait --attached-database-configuration-name "attachedDatabaseConfigurations1" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest" --deleted

選擇性參數

--attached-database-configuration-name

附加資料庫組態的名稱。

--created

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

預設值: False
--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False
--exists

等候資源存在。

預設值: False
--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--interval

輪詢間隔以秒為單位。

預設值: 30
--kusto-pool-name

Kusto 集區的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--subscription

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

--timeout

以秒為單位的等候上限。

預設值: 3600
--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False
--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 來取得完整偵錯記錄。