az monitor data-collection rule
注意
此參考是 Azure CLI 的 monitor-control-service 擴充功能的一部分(2.57.0 版或更高版本)。 擴充功能會在您第一次執行 az monitor data-collection rule 命令時自動安裝。 深入了解擴充功能。
管理監視控制服務的數據收集規則。
命令
az monitor data-collection rule create
建立資料收集規則。
az monitor data-collection rule create --data-collection-rule-name
--resource-group
[--data-collection-endpoint-id]
[--data-flows]
[--data-sources]
[--description]
[--destinations]
[--identity]
[--kind]
[--location]
[--rule-file]
[--stream-declarations]
[--tags]
範例
建立資料收集規則
az monitor data-collection rule create --resource-group "myResourceGroup" --location "eastus" --name "myCollectionRule" --rule-file "C:\samples\dcrEx1.json"
必要參數
數據收集規則的名稱。 名稱不區分大小寫。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
要關聯之數據收集端點的資源標識符。
數據流的規格。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
數據源的規格。 此屬性是選擇性的,如果規則是要透過對布建端點的直接呼叫來使用,則可以省略此屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
關聯的描述。
目的地的規格。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
資源的受控服務識別。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
資源的種類。 例如 Linux
, Windows
。
資源所在的地理位置。
規則參數的 json 檔案。 如果提供,則會依規則檔案使用量的值覆寫對應的參數:--rule-file sample.json規則 json 檔案應該是組織為 json 格式的規則參數, 例如: { “properties”: { “destinations”: { “azureMonitorMetrics”: { “name”: “azureMonitorMetrics-default” } }, “dataFlows”: [ { “streams”: [ “Microsoft-InsightsMetrics” ], “destinations”: [ “azureMonitorMetrics-default” ] } ] } }。
此規則中使用的自定義數據流宣告。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az monitor data-collection rule delete
刪除資料收集規則。
az monitor data-collection rule delete [--data-collection-rule-name]
[--ids]
[--resource-group]
[--subscription]
[--yes]
範例
刪除資料收集規則
az monitor data-collection rule delete --name "myCollectionRule" --resource-group "myResourceGroup"
選擇性參數
數據收集規則的名稱。 名稱不區分大小寫。
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
不提示確認。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az monitor data-collection rule list
列出指定資源群組中的所有數據收集規則。 和列出指定訂用帳戶中的所有數據收集規則。
az monitor data-collection rule list [--max-items]
[--next-token]
[--resource-group]
範例
依資源群組列出數據收集規則
az monitor data-collection rule list --resource-group "myResourceGroup"
依訂用帳戶列出數據收集規則
az monitor data-collection rule list
選擇性參數
命令輸出中要傳回的項目總數。 如果可用的專案總數超過指定的值,則會在命令的輸出中提供令牌。 若要繼續分頁,請在後續命令的自變數中 --next-token
提供令牌值。
標記,指定要開始分頁的位置。 這是先前截斷回應中的令牌值。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az monitor data-collection rule show
傳回指定的數據收集規則。
az monitor data-collection rule show [--data-collection-rule-name]
[--ids]
[--resource-group]
[--subscription]
範例
取得數據收集規則
az monitor data-collection rule show --name "myCollectionRule" --resource-group "myResourceGroup"
選擇性參數
數據收集規則的名稱。 名稱不區分大小寫。
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az monitor data-collection rule update
更新數據收集規則。
az monitor data-collection rule update [--add]
[--data-collection-endpoint-id]
[--data-collection-rule-name]
[--data-flows]
[--data-flows-raw]
[--data-sources]
[--description]
[--destinations]
[--extensions]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--identity]
[--ids]
[--kind]
[--log-analytics]
[--monitor-metrics]
[--performance-counters]
[--remove]
[--resource-group]
[--set]
[--stream-declarations]
[--subscription]
[--syslog]
[--tags]
[--windows-event-logs]
範例
更新數據收集規則
az monitor data-collection rule update --resource-group "myResourceGroup" --name "myCollectionRule" --data-flows destinations="centralWorkspace" streams="Microsoft-Perf" streams="Microsoft-Syslog" streams="Microsoft-WindowsEvent" --log-analytics name="centralWorkspace" resource-id="/subscriptions/703362b3-f278-4e4b-9179- c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspac es/centralTeamWorkspace" --performance-counters name="appTeamExtraCounters" counter- specifiers="\Process(_Total)\Thread Count" sampling-frequency=30 streams="Microsoft-Perf" --syslog name="cronSyslog" facility-names="cron" log-levels="Debug" log-levels="Critical" log-levels="Emergency" streams="Microsoft-Syslog" --windows-event-logs name="cloudSecurityTeamEvents" streams="Microsoft-WindowsEvent" x-path-queries="Security!"
選擇性參數
藉由指定路徑和索引鍵值組,將物件加入物件清單。 範例:--add property.listProperty <key=value、string 或 JSON 字串>。
要關聯之數據收集端點的資源標識符。
數據收集規則的名稱。 名稱不區分大小寫。
數據流的規格。 使用方式:--data-flow streams=XX1 streams=XX2 destinations=XX1 destinations=XX2 streams:必要。 此數據流的數據流清單。 destinations:必要專案。 此數據流的目的地清單。 您可以使用多個 --data-flow 自變數來指定多個動作。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
數據流的規格。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
數據源的規格。 此屬性是選擇性的,如果規則是要透過對布建端點的直接呼叫來使用,則可以省略此屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
關聯的描述。
目的地的規格。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
Azure VM 擴充功能數據源組態的清單。 預期值:json-string/@json-file。
使用 'set' 或 'add' 時,請保留字串常值,而不是嘗試轉換成 JSON。
資源的受控服務識別。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
資源的種類。 例如 Linux
, Windows
。
Log Analytics 目的地清單。 使用量:--log-analytics resource-id=XX name=XX resource-id:必要。 Log Analytics 工作區的資源標識碼。 名稱:必要。 目的地的易記名稱。 此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。 您可以使用多個 --log-analytics 自變數來指定多個動作。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
Azure 監視器計量目的地。 使用方式:--monitor-metrics name=XX name:必要。 目的地的易記名稱。 此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
性能計數器數據源組態的清單。 使用方式:--performance-counters streams=XX1 streams=XX2 sampling-frequency=XX counter-specifiers=XX1 counter-specifiers=XX2 name=XX streams:必要。 此數據源將傳送至的數據流清單。 數據流會指出將針對此數據使用哪些架構,而且通常會在Log Analytics中將數據傳送至哪個數據表。取樣頻率:必要。 連續計數器測量(樣本)之間的秒數。 counter-specifiers:必要。 您想要收集之性能計數器的規範名稱清單。 使用通配符 \ 收集所有實例的計數器。 若要在 Windows 上取得性能計數器清單,請執行命令 『typeperf』。 名稱:必要。 數據源的易記名稱。 此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。 您可以使用多個 --performance-counters 自變數來指定多個動作。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
從清單中移除屬性或專案。 範例:--remove property.list OR --remove 屬性ToRemove。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
指定要設定的屬性路徑和值,以更新物件。 範例:--set property1.property2=。
此規則中使用的自定義數據流宣告。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
Syslog 資料源組態的清單。 使用方式:--syslog streams=XX1 streams=XX2 facility-names=XX1 facility-names=XX2 log-levels=XX1 log-levels=XX2 name=XX streams:必要。 此數據源將傳送至的數據流清單。 數據流會指出將針對此數據使用哪些架構,而且通常會在Log Analytics中將數據傳送至哪個數據表。設備名稱:必要。 設施名稱的清單。 記錄層級:要收集的記錄層級。 名稱:必要。 數據源的易記名稱。 此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。 您可以使用多個 --syslog 自變數來指定多個動作。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
Windows 事件記錄檔數據源組態的清單。 使用方式:--windows-event-logs streams=XX1 streams=XX2 x-path-queries=XX1 x-path-queries=XX2 name=XX streams:必要。 此數據源將傳送至的數據流清單。 數據流會指出將針對此數據使用哪些架構,而且通常會在Log Analytics中將數據傳送至哪個數據表。x-path-queries:必要。 XPATH 格式的 Windows 事件記錄檔查詢清單。 名稱:必要。 數據源的易記名稱。 此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。 您可以使用多個 --windows-event-logs 自變數來指定多個動作。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。