lakewatch 指揮群

Note

Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明,包括任何使用數據條款。

Important

Lakewatch 目前還在 測試階段。 工作區管理員可以從 「預覽 」頁面控制對此功能的存取。 請參閱管理工作區層級預覽。

lakewatch Databricks CLI 中的指令群組包含管理 Lakewatch 資料來源、偵測規則及各目錄設定的指令。 請參閱 Lakewatch 文件。

指令 lakewatch 群組需要 Databricks CLI 版本 1.25.0 或更高版本。 若要檢查您的版本,請執行 databricks -v。

Databricks lakewatch 建立-資料來源

Important

這項功能位於 測試版 (Beta) 中。

建立資料來源。

建立新的資料來源。

databricks lakewatch create-datasource CATALOG_NAME SCHEMA_NAME DATASOURCE_NAME SCHEDULE [flags]

Arguments

CATALOG_NAME

    包含資料來源的 Unity 目錄名稱。 建立時必須,之後無法更改。 讀取回傳提供的值;目錄目前名稱會被報告於 effective_catalog_name。

SCHEMA_NAME

    包含資料來源的 Unity 目錄結構名稱。 建立時必須,之後無法更改。 讀取回傳提供的值;結構的當前名稱會在 中回報 effective_schema_name。

DATASOURCE_NAME

    Unity 目錄中資料來源的名稱,在其架構中唯一。 建立時必須,且可在同一目錄與架構內更新。 Get 會將此欄位與目前的 Unity 目錄名稱同步,該名稱亦在 effective_datasource_name中回報。

SCHEDULE

    資料來源擷取作業執行的排程。 資料來源無法暫停,因此設定為 false 的請求 schedule.enabled 會被拒絕。 Unity 目錄連線資料來源不支援連續排程。

選項

--compute-mode DatasourceComputeMode

    資料來源匯入作業的運算模式。 支援的值:DS_COMPUTE_PERFORMANCE_OPTIMIZED、DS_COMPUTE_STANDARD。

--description string

    資料來源的自由格式描述。

--json JSON

    要麼是內嵌 JSON 字串,要麼 @path/to/file.json 是請求主體。

--name string

    資料來源的資源名稱,格式為 datasources/{datasource_id}。

--run-as-principal string

    資料來源執行的使用者或服務主體,以使用者電子郵件或服務主體應用程式 ID 表示。

--warehouse-id string

    執行 Lakewatch 用以驗證建立或更新請求(例如來源與目的地存取檢查)檢查的 SQL 倉儲的 ID。

全球旗幟

Databricks lakewatch 建立規則

Important

這項功能位於 測試版 (Beta) 中。

建立規則。

建立一條新規則。

databricks lakewatch create-rule CATALOG_NAME SCHEMA_NAME RULE_NAME SEVERITY FIDELITY SCHEDULE OUTPUT [flags]

Arguments

CATALOG_NAME

    包含該規則的 Unity 目錄目錄名稱。 Required. 建立之後無法變更。 讀取回傳提供的值;目錄目前名稱會被報告於 effective_catalog_name。

SCHEMA_NAME

    包含該規則的 Unity 目錄結構描述名稱。 Required. 建立之後無法變更。 讀取回傳提供的值;結構的當前名稱會在 中回報 effective_schema_name。

RULE_NAME

    規則在其 Unity 目錄架構中的名稱。 建立時必須;可在同一目錄與架構內更新。 Get 會將此欄位與目前的 Unity 目錄名稱同步,該名稱亦在 effective_rule_name中回報。

SEVERITY

    自由格式嚴重性標籤,例如資訊性、中等、高或嚴重。

FIDELITY

    此規則的訊號品質。 支援值:[FIDELITY_DEVELOPMENT、FIDELITY_HIGH、FIDELITY_INVESTIGATIVE、FIDELITY_MEDIUM]。

SCHEDULE

    當規則執行時。

OUTPUT

    每個訊號要記錄什麼。

選項

--category string

    自由格式規則類別。

--content-resource-id string

    不可變的 UUIDv4 將已編寫的內容資源標示為此規則。

--deduplication RuleDeduplication

    訊號去重模式。 支援的值:DEDUPLICATION_DEFAULT、DEDUPLICATION_DISABLED、DEDUPLICATION_ENABLED。

--deduplication-time-window string

    去重的時間窗口,例如 1h、24h、7d 或自動。

--description string

    自由形式的描述。

--json JSON

    要麼是內嵌 JSON 字串,要麼 @path/to/file.json 是請求主體。

--name string

    資源名稱,格式為 rules/{rule_id}。

--objective string

    此規則偵測內容的詳細說明。

--run-as-principal string

    此規則工作執行的主體身分,以使用者電子郵件或服務主體應用程式 ID 表示。

--runbook string

    長篇操作指引,取自撰寫規則的中繼資料。

--suppress-until-time string

    若設定此規則,該規則的訊號在指定時間前不會開啟新警示。

全球旗幟

Databricks lakewatch 刪除-資料來源

Important

這項功能位於 測試版 (Beta) 中。

刪除資料來源。

依資源名稱刪除資料來源。

databricks lakewatch delete-datasource NAME [flags]

Arguments

NAME

    資料來源的資源名稱,格式為 datasources/{datasource_id}。

全球旗幟

Databricks lakewatch 刪除規則

Important

這項功能位於 測試版 (Beta) 中。

刪除規則。

依資源名稱刪除規則。

databricks lakewatch delete-rule NAME [flags]

Arguments

NAME

    要刪除的規則的資源名稱。 格式: rules/{rule_id}。

全球旗幟

Databricks LakeWatch Get-Alert-config

Important

這項功能位於 測試版 (Beta) 中。

取得目錄的警示設定。

傳回目錄的警示投遞設定。

databricks lakewatch get-alert-config NAME [flags]

Arguments

NAME

    設定的資源名稱,格式為 catalogs/{catalog}/alertConfig。

全球旗幟

DataBricks Lakewatch Get-Common-Config

Important

這項功能位於 測試版 (Beta) 中。

取得目錄的通用設定。

回傳目錄的常見 Lakewatch 配置。

databricks lakewatch get-common-config NAME [flags]

Arguments

NAME

    設定的資源名稱,格式為 catalogs/{catalog}/commonConfig。

全球旗幟

DataBricks LakeWatch Get-DataSource

Important

這項功能位於 測試版 (Beta) 中。

取得資料來源。

以資源名稱回傳單一資料來源。

databricks lakewatch get-datasource NAME [flags]

Arguments

NAME

    資料來源的資源名稱,格式為 datasources/{datasource_id}。

全球旗幟

Databricks lakewatch get-datasource-config

Important

這項功能位於 測試版 (Beta) 中。

取得目錄的資料來源設定。

回傳目錄的資料來源擷取設定。

databricks lakewatch get-datasource-config NAME [flags]

Arguments

NAME

    設定的資源名稱,格式為 catalogs/{catalog}/datasourceConfig。

全球旗幟

DataBricks LakeWatch Get-rule

Important

這項功能位於 測試版 (Beta) 中。

取得規則。

以其資源名稱回傳單一規則。

databricks lakewatch get-rule NAME [flags]

Arguments

NAME

    偵測規則的完整資源名稱,格式為 rules/{rule_id}。

全球旗幟

DataBricks LakeWatch get-rule-config

Important

這項功能位於 測試版 (Beta) 中。

取得目錄的規則設定。

回傳目錄的偵測規則設定。

databricks lakewatch get-rule-config NAME [flags]

Arguments

NAME

    設定的資源名稱,格式為 catalogs/{catalog}/ruleConfig。

全球旗幟

DataBricks LakeWatch List-Datasources

Important

這項功能位於 測試版 (Beta) 中。

列出資料來源。

列出 Unity 目錄目錄中的資料來源,可選擇縮窄至單一結構或依名稱篩選。 結果會以分頁方式呈現。 仍在建立或刪除中的資料來源不會被列出。

databricks lakewatch list-datasources CATALOG_NAME [flags]

Arguments

CATALOG_NAME

    用以列出資料來源的 Unity 目錄目錄名稱。 必須;每個請求都會列出單一目錄的資料來源。

選項

--filter string

    限制結果為指定名稱資料來源的篩選式, datasource_name 例如 = “my_source”。

--limit int

    要傳回的結果數目上限。

--page-size int

    單頁可返回的最大結果數量。

--schema-name string

    Unity 目錄結構 catalog_name名稱。

--view DatasourceView

    每個資料來源要回傳哪些欄位。 支援的值:DATASOURCE_VIEW_BASIC、DATASOURCE_VIEW_FULL。

全球旗幟

Databricks lakewatch list-rules

Important

這項功能位於 測試版 (Beta) 中。

列出規則。

列出規則,並可選擇篩選與分頁。

databricks lakewatch list-rules CATALOG_NAME [flags]

Arguments

CATALOG_NAME

    要列出規則的 Unity 目錄名稱。 Required.

選項

--filter string

    限制結果的篩選表達式,例如 rule_name = “my_rule” 只回傳具有該名稱的規則。

--limit int

    要傳回的結果數目上限。

--page-size int

    可返回的規則數量上限。

--schema-name string

    Unity 目錄結構 catalog_name名稱。

--view RuleView

    每條規則要退多少。 支援的值:RULE_VIEW_BASIC、RULE_VIEW_FULL。

全球旗幟

Databricks Lakewatch 更新-alert-config

Important

這項功能位於 測試版 (Beta) 中。

更新目錄的警示設定。

更新目錄的警示投遞設定。

databricks lakewatch update-alert-config NAME UPDATE_MASK [flags]

Arguments

NAME

    設定的資源名稱,格式為 catalogs/{catalog}/alertConfig。

UPDATE_MASK

    欄位遮罩必須是單一字串,並以逗號分隔多個字段(無空格)。 欄位路徑相對於資源物件,使用點(.)來導覽子欄位(例如 author.given_name)。 禁止指定序列或映射欄位中的元素,因為只能指定整個集合欄位。 功能變數名稱必須完全符合資源功能變數名稱。

    使用 * 的欄位遮罩表示完整取代。 建議一律明確列出要更新的欄位,避免使用 * 萬用字元,因為未來 API 變更時可能會產生意外結果。

選項

--default-security-alert-collation-window string

    用來彙整訊號成安全警示的視窗。

--default-system-alert-collation-window string

    用於將 SystemEvents 彙整成系統警示的視窗。

--etag string

    Optimistic-concurrency 前提條件:如果設定了且與資源目前的 etag 不符,則該更新將因衝突而被拒絕(HTTP 409)。

--json JSON

    要麼是內嵌 JSON 字串,要麼 @path/to/file.json 是請求主體。

全球旗幟

Databricks lakewatch update-common-config

Important

這項功能位於 測試版 (Beta) 中。

更新目錄的共用設定。

更新目錄的常見 Lakewatch 設定。

databricks lakewatch update-common-config NAME UPDATE_MASK [flags]

Arguments

NAME

    設定的資源名稱,格式為 catalogs/{catalog}/commonConfig。

UPDATE_MASK

    欄位遮罩必須是單一字串,並以逗號分隔多個字段(無空格)。 欄位路徑相對於資源物件,使用點(.)來導覽子欄位(例如 author.given_name)。 禁止指定序列或映射欄位中的元素,因為只能指定整個集合欄位。 功能變數名稱必須完全符合資源功能變數名稱。

    使用 * 的欄位遮罩表示完整取代。 建議一律明確列出要更新的欄位,避免使用 * 萬用字元,因為未來 API 變更時可能會產生意外結果。

選項

--custom-content-pack-path string

    Unity 目錄磁碟區路徑,用來存放使用者自製的自訂內容包,例如 /Volumes/{catalog}/{schema}/{volume}。 沒有預設值。 未設定時,僅會套用內建內容包。

--custom-presets-path string

    Unity 目錄磁碟區路徑,用來存放使用者自創的自訂預設,例如 /Volumes/{catalog}/{schema}/{volume}。 沒有預設值。 未設定時,僅會套用內建預設。

--etag string

    Optimistic-concurrency 前提條件:如果設定了且與資源目前的 etag 不符,則該更新將因衝突而被拒絕(HTTP 409)。

--json JSON

    要麼是內嵌 JSON 字串,要麼 @path/to/file.json 是請求主體。

--per-resource-permissions-enabled

    使用者是否可以對個別資源授予權限,而非僅限於資料夾層級。

全球旗幟

Databricks lakewatch 更新-資料來源

Important

這項功能位於 測試版 (Beta) 中。

更新資料來源。

更新現有資料來源。

databricks lakewatch update-datasource NAME UPDATE_MASK CATALOG_NAME SCHEMA_NAME DATASOURCE_NAME SCHEDULE [flags]

Arguments

NAME

    資料來源的資源名稱,格式為 datasources/{datasource_id}。 與資料來源的 Unity 目錄位置(catalog_name、、 schema_name及 datasource_name)不同,當資料來源或其目錄或結構在 Unity 目錄中重新命名時,名稱不會改變。

UPDATE_MASK

    欄位遮罩必須是單一字串,並以逗號分隔多個字段(無空格)。 欄位路徑相對於資源物件,使用點(.)來導覽子欄位(例如 author.given_name)。 禁止指定序列或映射欄位中的元素,因為只能指定整個集合欄位。 功能變數名稱必須完全符合資源功能變數名稱。

    使用 * 的欄位遮罩表示完整取代。 建議一律明確列出要更新的欄位,避免使用 * 萬用字元,因為未來 API 變更時可能會產生意外結果。

CATALOG_NAME

    包含資料來源的 Unity 目錄名稱。 建立時必須,之後無法更改。 讀取回傳提供的值;目錄目前名稱會被報告於 effective_catalog_name。

SCHEMA_NAME

    包含資料來源的 Unity 目錄結構名稱。 建立時必須,之後無法更改。 讀取回傳提供的值;結構的當前名稱會在 中回報 effective_schema_name。

DATASOURCE_NAME

    Unity 目錄中資料來源的名稱,在其架構中唯一。 建立時必須,且可在同一目錄與架構內更新。 Get 會將此欄位與目前的 Unity 目錄名稱同步,該名稱亦在 effective_datasource_name中回報。

SCHEDULE

    資料來源擷取作業執行的排程。 資料來源無法暫停,因此設定為 false 的請求 schedule.enabled 會被拒絕。 Unity 目錄連線資料來源不支援連續排程。

選項

--compute-mode DatasourceComputeMode

    資料來源匯入作業的運算模式。 支援的值:DS_COMPUTE_PERFORMANCE_OPTIMIZED、DS_COMPUTE_STANDARD。

--description string

    資料來源的自由格式描述。

--etag string

    Optimistic-concurrency 前提條件:如果設定為非空值且與資源目前的 etag 不符,則該更新將被拒絕為衝突(HTTP 409)。

--json JSON

    要麼是內嵌 JSON 字串,要麼 @path/to/file.json 是請求主體。

--name string

    資料來源的資源名稱,格式為 datasources/{datasource_id}。

--run-as-principal string

    資料來源執行的使用者或服務主體,以使用者電子郵件或服務主體應用程式 ID 表示。

--warehouse-id string

    執行 Lakewatch 用以驗證建立或更新請求(例如來源與目的地存取檢查)檢查的 SQL 倉儲的 ID。

全球旗幟

Databricks Lakewatch 更新-資料來源-設定

Important

這項功能位於 測試版 (Beta) 中。

更新目錄的資料來源設定。

更新目錄的資料來源擷取設定。

databricks lakewatch update-datasource-config NAME UPDATE_MASK [flags]

Arguments

NAME

    設定的資源名稱,格式為 catalogs/{catalog}/datasourceConfig。

UPDATE_MASK

    欄位遮罩必須是單一字串,並以逗號分隔多個字段(無空格)。 欄位路徑相對於資源物件,使用點(.)來導覽子欄位(例如 author.given_name)。 禁止指定序列或映射欄位中的元素,因為只能指定整個集合欄位。 功能變數名稱必須完全符合資源功能變數名稱。

    使用 * 的欄位遮罩表示完整取代。 建議一律明確列出要更新的欄位,避免使用 * 萬用字元,因為未來 API 變更時可能會產生意外結果。

選項

--default-compute-mode DatasourceComputeMode

    當個別資料來源未覆寫該作業時,套用預設運算模式。 支援的值:DS_COMPUTE_PERFORMANCE_OPTIMIZED、DS_COMPUTE_STANDARD。

--default-folder string

    當請求未指定結構時,將新資料來源放入此目錄中已註冊資料夾的結構名稱。

--etag string

    Optimistic-concurrency 前提條件:如果設定了且與資源目前的 etag 不符,則該更新將因衝突而被拒絕(HTTP 409)。

--json JSON

    要麼是內嵌 JSON 字串,要麼 @path/to/file.json 是請求主體。

全球旗幟

DataBricks LakeWatch 更新規則

Important

這項功能位於 測試版 (Beta) 中。

更新規則。

更新現有規則。

databricks lakewatch update-rule NAME UPDATE_MASK CATALOG_NAME SCHEMA_NAME RULE_NAME SEVERITY FIDELITY SCHEDULE OUTPUT [flags]

Arguments

NAME

    資源名稱,格式為 rules/{rule_id}。 由伺服器在建立時指派;更新時必須指派。

UPDATE_MASK

    要更新的欄位集合。 只有遮色片中指定的欄位會被修改。

CATALOG_NAME

    包含該規則的 Unity 目錄目錄名稱。 Required. 建立之後無法變更。 讀取回傳提供的值;目錄目前名稱會被報告於 effective_catalog_name。

SCHEMA_NAME

    包含該規則的 Unity 目錄結構描述名稱。 Required. 建立之後無法變更。 讀取回傳提供的值;結構的當前名稱會在 中回報 effective_schema_name。

RULE_NAME

    規則在其 Unity 目錄架構中的名稱。 建立時必須;可在同一目錄與架構內更新。 Get 會將此欄位與目前的 Unity 目錄名稱同步,該名稱亦在 effective_rule_name中回報。

SEVERITY

    自由格式嚴重性標籤,例如資訊性、中等、高或嚴重。

FIDELITY

    此規則的訊號品質。 支援值:[FIDELITY_DEVELOPMENT、FIDELITY_HIGH、FIDELITY_INVESTIGATIVE、FIDELITY_MEDIUM]。

SCHEDULE

    當規則執行時。

OUTPUT

    每個訊號要記錄什麼。

選項

--category string

    自由格式規則類別。

--content-resource-id string

    不可變的 UUIDv4 將已編寫的內容資源標示為此規則。

--deduplication RuleDeduplication

    訊號去重模式。 支援的值:DEDUPLICATION_DEFAULT、DEDUPLICATION_DISABLED、DEDUPLICATION_ENABLED。

--deduplication-time-window string

    去重的時間窗口,例如 1h、24h、7d 或自動。

--description string

    自由形式的描述。

--etag string

    來自最新讀數的樂觀並發代幣。

--json JSON

    要麼是內嵌 JSON 字串,要麼 @path/to/file.json 是請求主體。

--name string

    資源名稱,格式為 rules/{rule_id}。

--objective string

    此規則偵測內容的詳細說明。

--run-as-principal string

    此規則工作執行的主體身分,以使用者電子郵件或服務主體應用程式 ID 表示。

--runbook string

    長篇操作指引,取自撰寫規則的中繼資料。

--suppress-until-time string

    若設定此規則,該規則的訊號在指定時間前不會開啟新警示。

全球旗幟

Databricks lakewatch update-rule-config

Important

這項功能位於 測試版 (Beta) 中。

更新目錄的規則設定。

更新目錄的偵測規則設定。

databricks lakewatch update-rule-config NAME UPDATE_MASK [flags]

Arguments

NAME

    設定的資源名稱,格式為 catalogs/{catalog}/ruleConfig。

UPDATE_MASK

    欄位遮罩必須是單一字串,並以逗號分隔多個字段(無空格)。 欄位路徑相對於資源物件,使用點(.)來導覽子欄位(例如 author.given_name)。 禁止指定序列或映射欄位中的元素,因為只能指定整個集合欄位。 功能變數名稱必須完全符合資源功能變數名稱。

    使用 * 的欄位遮罩表示完整取代。 建議一律明確列出要更新的欄位,避免使用 * 萬用字元,因為未來 API 變更時可能會產生意外結果。

選項

--default-folder string

    當請求未指定結構時,將新規則放入此目錄中已註冊資料夾的結構名稱。

--default-signal-collation-window string

    當規則未自行設定時,訊號去重的預設持續時間,以緊湊的日、時、分鐘及秒組成部分書寫,例如 5d1h或 。 沒有預設值。 空值則會清除。

--etag string

    Optimistic-concurrency 前提條件:如果設定了且與資源目前的 etag 不符,則該更新將因衝突而被拒絕(HTTP 409)。

--json JSON

    要麼是內嵌 JSON 字串,要麼 @path/to/file.json 是請求主體。

全球旗幟

全域旗標

--debug

  是否要啟用偵錯記錄。

-h 或 --help

    顯示 Databricks CLI、相關命令群組或相關命令的幫助說明。

--log-file 字串

    字串,表示要寫入輸出記錄檔的檔案。 若未指定此旗標,則預設值是將輸出記錄寫入 stderr。

--log-format 節目形式

    記錄格式類型,text 或 json。 預設值為 text。

--log-level 字串

    表示日誌格式層級的字串。 若未指定,則日誌的格式層級功能將被停用。

-o, --output 類型

    指令輸出類型,text 或 json。 預設值為 text。

-p, --profile 字串

    用於執行命令的~/.databrickscfg檔案中的配置檔名稱。 如果未指定此旗標,則如果存在,則會使用名為 DEFAULT 的配置檔。

--progress-format 節目形式

    顯示進度記錄的格式:default、、appendinplace、 或json

-t, --target 字串

    如果適用,要使用的套件組合目標