az monitor data-collection rule

注意

此參考是 Azure CLI 的 monitor-control-service 擴充功能的一部分（2.55.0 版或更高版本）。 擴充功能會在您第一次執行 az monitor data-collection rule 命令時自動安裝。 深入了解擴充功能。

管理監視控制服務的數據收集規則。

命令

名稱	Description	類型	狀態
az monitor data-collection rule association	管理監視控件服務的數據收集規則關聯。	副檔名	GA
az monitor data-collection rule association create	建立關聯。	副檔名	GA
az monitor data-collection rule association delete	刪除關聯。	副檔名	GA
az monitor data-collection rule association list	列出指定數據收集規則的關聯。 和列出指定數據收集端點的關聯。 和列出指定資源的關聯。	副檔名	GA
az monitor data-collection rule association list-by-resource	列出指定資源的關聯。	副檔名	GA
az monitor data-collection rule association show	取得指定的關聯。	副檔名	GA
az monitor data-collection rule association update	更新關聯。	副檔名	GA
az monitor data-collection rule create	建立資料收集規則。	副檔名	GA
az monitor data-collection rule data-flow	管理數據流。	副檔名	GA
az monitor data-collection rule data-flow add	新增數據流。	副檔名	GA
az monitor data-collection rule data-flow list	列出數據流。	副檔名	GA
az monitor data-collection rule delete	刪除資料收集規則。	副檔名	GA
az monitor data-collection rule list	列出指定資源群組中的所有數據收集規則。 和列出指定訂用帳戶中的所有數據收集規則。	副檔名	GA
az monitor data-collection rule log-analytics	管理 Log Analytics 目的地。	副檔名	GA
az monitor data-collection rule log-analytics add	新增數據收集規則的Log Analytics目的地。	副檔名	GA
az monitor data-collection rule log-analytics delete	刪除資料收集規則的Log Analytics目的地。	副檔名	GA
az monitor data-collection rule log-analytics list	列出數據收集規則的Log Analytics目的地。	副檔名	GA
az monitor data-collection rule log-analytics show	顯示數據收集規則的Log Analytics目的地。	副檔名	GA
az monitor data-collection rule log-analytics update	更新數據收集規則的Log Analytics目的地。	副檔名	GA
az monitor data-collection rule performance-counter	管理記錄性能計數器數據源。	副檔名	GA
az monitor data-collection rule performance-counter add	新增記錄性能計數器數據源。	副檔名	GA
az monitor data-collection rule performance-counter delete	刪除記錄性能計數器數據源。	副檔名	GA
az monitor data-collection rule performance-counter list	列出記錄性能計數器數據源。	副檔名	GA
az monitor data-collection rule performance-counter show	顯示記錄性能計數器數據源。	副檔名	GA
az monitor data-collection rule performance-counter update	更新記錄性能計數器數據源。	副檔名	GA
az monitor data-collection rule show	傳回指定的數據收集規則。	副檔名	GA
az monitor data-collection rule syslog	管理 Syslog 數據源。	副檔名	GA
az monitor data-collection rule syslog add	新增 Syslog 數據源。	副檔名	GA
az monitor data-collection rule syslog delete	刪除 Syslog 資料源。	副檔名	GA
az monitor data-collection rule syslog list	列出 Syslog 數據源。	副檔名	GA
az monitor data-collection rule syslog show	顯示 Syslog 數據源。	副檔名	GA
az monitor data-collection rule syslog update	更新 Syslog 數據源。	副檔名	GA
az monitor data-collection rule update	更新數據收集規則。	副檔名	GA
az monitor data-collection rule windows-event-log	管理 Windows 事件記錄檔數據源。	副檔名	GA
az monitor data-collection rule windows-event-log add	新增 Windows 事件記錄檔數據源。	副檔名	GA
az monitor data-collection rule windows-event-log delete	刪除 Windows 事件記錄檔數據源。	副檔名	GA
az monitor data-collection rule windows-event-log list	列出 Windows 事件記錄檔數據源。	副檔名	GA
az monitor data-collection rule windows-event-log show	顯示 Windows 事件記錄檔數據源。	副檔名	GA
az monitor data-collection rule windows-event-log update	更新 Windows 事件記錄檔數據源。	副檔名	GA

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 {Linux, Windows}]
                                       [--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"

必要參數

--data-collection-rule-name --name --rule-name -n

數據收集規則的名稱。 名稱不區分大小寫。

--resource-group -g

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

選擇性參數

--data-collection-endpoint-id --endpoint-id

要關聯之數據收集端點的資源標識符。

--data-flows

數據流的規格。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--data-sources

數據源的規格。 此屬性是選擇性的，如果規則是要透過對布建端點的直接呼叫來使用，則可以省略此屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--description

關聯的描述。

--destinations

目的地的規格。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--identity

資源的受控服務識別。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--kind

資源的種類。

接受的值: Linux, Windows

--location -l

資源所在的地理位置。

--rule-file

規則參數的 json 檔案。 如果提供，則會依規則檔案使用量的值覆寫對應的參數：--rule-file sample.json 規則 json 檔案應該是組織為 json 格式的規則參數， 例如： { “properties”： { “destinations”： { “azureMonitorMetrics”： { “name”： “azureMonitorMetrics-default” } }， “dataFlows”： [ { “streams”： [ “Microsoft-InsightsMetrics” ]， “destinations”： [ “azureMonitorMetrics-default” ] } ] } }。

--stream-declarations

此規則中使用的自定義數據流宣告。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

全域參數

--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 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"

選擇性參數

--data-collection-rule-name --name --rule-name -n

數據收集規則的名稱。 名稱不區分大小寫。

--ids

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

--resource-group -g

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

--subscription

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

--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 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

選擇性參數

--max-items

命令輸出中要傳回的項目總數。 如果可用的專案總數超過指定的值，則會在命令的輸出中提供令牌。 若要繼續分頁，請在後續命令的自變數中 --next-token 提供令牌值。

--next-token

標記，指定要開始分頁的位置。 這是先前截斷回應中的令牌值。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<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 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"

選擇性參數

--data-collection-rule-name --name --rule-name -n

數據收集規則的名稱。 名稱不區分大小寫。

--ids

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

--resource-group -g

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

--subscription

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

全域參數

--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 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 {Linux, Windows}]
                                       [--log-analytics]
                                       [--monitor-metrics]
                                       [--performance-counters]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--stream-declarations]
                                       [--subscription]
                                       [--syslog]
                                       [--tags]
                                       [--windows-event-logs]

選擇性參數

--add

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

--data-collection-endpoint-id --endpoint-id

要關聯之數據收集端點的資源標識符。

--data-collection-rule-name --name --rule-name -n

數據收集規則的名稱。 名稱不區分大小寫。

--data-flows --data-flows-remain

數據流的規格。 使用方式：--data-flow streams=XX1 streams=XX2 destinations=XX1 destinations=XX2 streams：必要。 此數據流的數據流清單。 destinations：必要專案。 此數據流的目的地清單。 您可以使用多個 --data-flow 自變數來指定多個動作。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--data-flows-raw

數據流的規格。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--data-sources

數據源的規格。 此屬性是選擇性的，如果規則是要透過對布建端點的直接呼叫來使用，則可以省略此屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--description

關聯的描述。

--destinations

目的地的規格。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--extensions

Azure VM 擴充功能數據源組態的清單。 預期值：json-string/@json-file。

--force-string

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

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

--identity

資源的受控服務識別。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--ids

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

--kind

資源的種類。

接受的值: Linux, Windows

--log-analytics

Log Analytics 目的地清單。 使用量：--log-analytics resource-id=XX name=XX resource-id：必要。 Log Analytics 工作區的資源標識碼。 name：必要。 目的地的易記名稱。 此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。 您可以使用多個 --log-analytics 自變數來指定多個動作。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--monitor-metrics

Azure 監視器計量目的地。 使用方式：--monitor-metrics name=XX name：必要。 目的地的易記名稱。 此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--performance-counters

性能計數器數據源組態的清單。 使用方式：--performance-counters streams=XX1 streams=XX2 sampling-frequency=XX counter-specifiers=XX1 counter-specifiers=XX2 name=XX streams：必要。 此數據源將傳送至的數據流清單。 數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。取樣頻率：必要。 連續計數器測量（樣本）之間的秒數。 counter-specifiers：必要。 您想要收集之性能計數器的規範名稱清單。 使用通配符 \ 收集所有實例的計數器。 若要在 Windows 上取得性能計數器清單，請執行命令 『typeperf』。 name：必要。 數據源的易記名稱。 此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。 您可以使用多個 --performance-counters 自變數來指定多個動作。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--remove

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

--resource-group -g

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

--set

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

--stream-declarations

此規則中使用的自定義數據流宣告。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--subscription

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

--syslog

Syslog 資料源組態的清單。 使用方式：--syslog streams=XX1 streams=XX2 facility-names=XX1 facility-names=XX2 log-levels=XX1 log-levels=XX2 name=XX streams：必要。 此數據源將傳送至的數據流清單。 數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。設備名稱：必要。 設施名稱的清單。 記錄層級：要收集的記錄層級。 name：必要。 數據源的易記名稱。 此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。 您可以使用多個 --syslog 自變數來指定多個動作。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--windows-event-logs

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 事件記錄檔查詢清單。 name：必要。 數據源的易記名稱。 此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。 您可以使用多個 --windows-event-logs 自變數來指定多個動作。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

全域參數

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