az sentinel metadata

注意

此參考是 Azure CLI 的 sentinel 延伸模組的一部分 （2.37.0 版或更高版本）。 擴充功能會在您第一次執行 az sentinel metadata 命令時自動安裝。 深入了解擴充功能。

使用 sentinel 管理中繼資料。

命令

名稱	Description	類型	狀態
az sentinel metadata create	建立中繼資料。	擴充	實驗性
az sentinel metadata delete	刪除中繼資料。	擴充	實驗性
az sentinel metadata list	所有中繼資料的清單。	擴充	實驗性
az sentinel metadata show	取得中繼資料。	擴充	實驗性
az sentinel metadata update	更新中繼資料。	擴充	實驗性

az sentinel metadata create

實驗

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

建立中繼資料。

az sentinel metadata create --metadata-name
                            --resource-group
                            --workspace-name
                            [--author]
                            [--categories]
                            [--content-id]
                            [--content-schema-version]
                            [--custom-version]
                            [--dependencies]
                            [--etag]
                            [--first-publish-date]
                            [--icon]
                            [--kind {AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate}]
                            [--last-publish-date]
                            [--parent-id]
                            [--preview-images]
                            [--preview-images-dark]
                            [--providers]
                            [--source]
                            [--support]
                            [--threat-tactics]
                            [--threat-techniques]
                            [--version]

必要參數

--metadata-name --name -n

中繼資料名稱。

--resource-group -g

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

--workspace-name -w

實驗

工作區的名稱。

選擇性參數

--author

內容專案的建立者。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--categories

解決方案內容專案的類別支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--content-id

內容的靜態識別碼。 用來識別解決方案或社群的相依性和內容。 現用內容和解決方案的硬式編碼/靜態。 使用者建立的動態。 這是資源名稱。

--content-schema-version

內容的架構版本。 可用來根據架構版本區分不同的流程。

--custom-version

內容的自訂版本。 選擇性的任意文字。

--dependencies

內容專案的相依性，需要哪些其他內容專案才能運作。 可以使用遞迴/巢狀結構來描述更複雜的相依性。 對於單一相依性，可以提供識別碼/kind/version 或複雜格式的運算子/準則。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--etag

Azure 資源的 Etag。

--first-publish-date

第一個發佈日期方案內容專案。

--icon

圖示識別碼。 稍後可以從解決方案範本擷取此識別碼。

--kind

中繼資料所針對的內容種類。

接受的值: AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate

--last-publish-date

方案內容專案的上次發佈日期。

--parent-id

中繼資料所針對之內容專案的完整父資源識別碼。 這是完整的資源識別碼，包括範圍（訂用帳戶和資源群組）。

--preview-images

預覽映射檔名稱。 這些會取自解決方案成品支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--preview-images-dark

預覽映射檔名稱。 這些會取自解決方案成品。 用於深色主題支援支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--providers

解決方案內容專案的提供者支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--source

內容的來源。 這是建立的位置/方式。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--support

中繼資料的支援資訊 - 類型、名稱、連絡資訊 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--threat-tactics

資源的策略涵蓋支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--threat-techniques

資源涵蓋的技術，這些技術必須與所使用的策略一致，支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--version

內容的版本。 預設值和建議的格式為數值（例如 1、1.0、1.0.0、1.0.0.0），遵循 ARM 範本最佳做法。 也可以是任何字串，但之後我們無法保證任何版本檢查。

全域參數

--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 sentinel metadata delete

實驗

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

刪除中繼資料。

az sentinel metadata delete [--ids]
                            [--metadata-name]
                            [--resource-group]
                            [--subscription]
                            [--workspace-name]
                            [--yes]

選擇性參數

--ids

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

--metadata-name --name -n

中繼資料名稱。

--resource-group -g

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

--subscription

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

--workspace-name -w

實驗

工作區的名稱。

--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 sentinel metadata list

實驗

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

所有中繼資料的清單。

az sentinel metadata list --resource-group
                          --workspace-name
                          [--filter]
                          [--orderby]
                          [--skip]
                          [--top]

必要參數

--resource-group -g

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

--workspace-name -w

實驗

工作區的名稱。

選擇性參數

--filter

根據布林值條件篩選結果。 選擇性。

--orderby

排序結果。 選擇性。

--skip

用來略過 OData 查詢中的 n 個專案 （offset）。 如果有任何左邊的結果，則會傳回 nextLink 至下一頁的結果。

--top

只傳回前 n 個結果。 選擇性。

全域參數

--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 sentinel metadata show

實驗

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

取得中繼資料。

az sentinel metadata show [--ids]
                          [--metadata-name]
                          [--resource-group]
                          [--subscription]
                          [--workspace-name]

選擇性參數

--ids

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

--metadata-name --name -n

中繼資料名稱。

--resource-group -g

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

--subscription

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

--workspace-name -w

實驗

工作區的名稱。

全域參數

--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 sentinel metadata update

實驗

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

更新中繼資料。

az sentinel metadata update [--add]
                            [--author]
                            [--categories]
                            [--content-id]
                            [--content-schema-version]
                            [--custom-version]
                            [--dependencies]
                            [--etag]
                            [--first-publish-date]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--icon]
                            [--ids]
                            [--kind {AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate}]
                            [--last-publish-date]
                            [--metadata-name]
                            [--parent-id]
                            [--preview-images]
                            [--preview-images-dark]
                            [--providers]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--source]
                            [--subscription]
                            [--support]
                            [--threat-tactics]
                            [--threat-techniques]
                            [--version]
                            [--workspace-name]

選擇性參數

--add

藉由指定路徑和索引鍵值組，將 物件加入物件清單。 範例：--add property.listProperty < key=value、string 或 JSON 字串 > 。

--author

內容專案的建立者。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--categories

解決方案內容專案的類別支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--content-id

內容的靜態識別碼。 用來識別解決方案或社群的相依性和內容。 現用內容和解決方案的硬式編碼/靜態。 使用者建立的動態。 這是資源名稱。

--content-schema-version

內容的架構版本。 可用來根據架構版本區分不同的流程。

--custom-version

內容的自訂版本。 選擇性的任意文字。

--dependencies

內容專案的相依性，需要哪些其他內容專案才能運作。 可以使用遞迴/巢狀結構來描述更複雜的相依性。 對於單一相依性，可以提供識別碼/kind/version 或複雜格式的運算子/準則。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--etag

Azure 資源的 Etag。

--first-publish-date

第一個發佈日期方案內容專案。

--force-string

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--icon

圖示識別碼。 稍後可以從解決方案範本擷取此識別碼。

--ids

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

--kind

中繼資料所針對的內容種類。

接受的值: AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate

--last-publish-date

方案內容專案的上次發佈日期。

--metadata-name --name -n

中繼資料名稱。

--parent-id

中繼資料所針對之內容專案的完整父資源識別碼。 這是完整的資源識別碼，包括範圍（訂用帳戶和資源群組）。

--preview-images

預覽映射檔名稱。 這些會取自解決方案成品支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--preview-images-dark

預覽映射檔名稱。 這些會取自解決方案成品。 用於深色主題支援支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--providers

解決方案內容專案的提供者支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--remove

從清單中移除屬性或專案。 範例：--remove property.list OR --remove 屬性ToRemove。

--resource-group -g

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

--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=。

--source

內容的來源。 這是建立的位置/方式。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--subscription

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

--support

中繼資料的支援資訊 - 類型、名稱、連絡資訊 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--threat-tactics

資源的策略涵蓋支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--threat-techniques

資源涵蓋的技術，這些技術必須與所使用的策略一致，支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--version

內容的版本。 預設值和建議的格式為數值（例如 1、1.0、1.0.0、1.0.0.0），遵循 ARM 範本最佳做法。 也可以是任何字串，但之後我們無法保證任何版本檢查。

--workspace-name -w

實驗

工作區的名稱。

全域參數

--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 來取得完整偵錯記錄。