az network-function traffic-collector collector-policy

注意

此參考是 Azure CLI 流量收集器 延伸模組的一部分 (2.40.0 版或更高版本)。 擴充功能會在您第一次執行 az network-function traffic-collector-policy 命令時自動安裝。 深入了解擴充功能。

管理 Azure 流量收集器資源的收集器原則。

命令

名稱 Description 類型 狀態
az network-function traffic-collector collector-policy create

建立收集器原則。

擴充 GA
az network-function traffic-collector collector-policy delete

刪除指定的收集器原則。

擴充 GA
az network-function traffic-collector collector-policy list

列出收集器原則。

擴充 GA
az network-function traffic-collector collector-policy show

取得指定的收集器原則。

擴充 GA
az network-function traffic-collector collector-policy update

更新指定的收集器原則。

擴充 GA
az network-function traffic-collector collector-policy wait

將 CLI 置於等候狀態,直到符合條件為止。

擴充 GA

az network-function traffic-collector collector-policy create

建立收集器原則。

az network-function traffic-collector collector-policy create --collector-policy-name
                                                              --resource-group
                                                              --traffic-collector-name
                                                              [--emission-policies]
                                                              [--ingestion-policy]
                                                              [--location]
                                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                              [--tags]

範例

建立新的收集器原則

az network-function traffic-collector collector-policy create --resource-group rg1 --traffic-collector-name atc1 --name cp1 --location eastus --ingestion-policy {ingestion-sources:[{resource-id:/subscriptions/<subscription_id>/resourceGroups/<resource_group>/providers/Microsoft.Network/expressRouteCircuits/<cp_name>,source-type:Resource}],ingestion-type:IPFIX}

必要參數

--collector-policy-name --name -n

收集器原則名稱。

--resource-group -g

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

--traffic-collector-name -t

Azure 流量收集器名稱。

選擇性參數

--emission-policies

排放原則。 支援速記語法、json-file 和 yaml-file。 請嘗試 「??」 以顯示更多。

--ingestion-policy

擷取原則。 支援速記語法、json-file 和 yaml-file。 請嘗試 「??」 以顯示更多。

--location -l

資源位置。 未指定時,將會使用資源群組的位置。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--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 network-function traffic-collector collector-policy delete

刪除指定的收集器原則。

az network-function traffic-collector collector-policy delete [--collector-policy-name]
                                                              [--ids]
                                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                              [--resource-group]
                                                              [--subscription]
                                                              [--traffic-collector-name]
                                                              [--yes]

範例

刪除指定的收集器原則

az network-function traffic-collector collector-policy delete --resource-group rg1 --traffic-collector-name atc1 --name cp1

選擇性參數

--collector-policy-name --name -n

收集器原則名稱。

--ids

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

--no-wait

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

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

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

--subscription

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

--traffic-collector-name -t

Azure 流量收集器名稱。

--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 network-function traffic-collector collector-policy list

列出收集器原則。

az network-function traffic-collector collector-policy list --resource-group
                                                            --traffic-collector-name

範例

依資源群組和流量收集器名稱傳回收集器原則清單

az network-function traffic-collector collector-policy list --resource-group rg1 --traffic-collector-name atc1

必要參數

--resource-group -g

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

--traffic-collector-name -t

Azure 流量收集器名稱。

全域參數
--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 network-function traffic-collector collector-policy show

取得指定的收集器原則。

az network-function traffic-collector collector-policy show [--collector-policy-name]
                                                            [--ids]
                                                            [--resource-group]
                                                            [--subscription]
                                                            [--traffic-collector-name]

範例

取得指定的收集器原則

az network-function traffic-collector collector-policy show --resource-group rg1 --traffic-collector-name atc1 --name cp1

選擇性參數

--collector-policy-name --name -n

收集器原則名稱。

--ids

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

--resource-group -g

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

--subscription

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

--traffic-collector-name -t

Azure 流量收集器名稱。

全域參數
--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 network-function traffic-collector collector-policy update

更新指定的收集器原則。

az network-function traffic-collector collector-policy update [--add]
                                                              [--collector-policy-name]
                                                              [--emission-policies]
                                                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                              [--ids]
                                                              [--ingestion-policy]
                                                              [--location]
                                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                              [--remove]
                                                              [--resource-group]
                                                              [--set]
                                                              [--subscription]
                                                              [--tags]
                                                              [--traffic-collector-name]

範例

更新指定的收集器原則

az network-function traffic-collector collector-policy update --resource-group rg1 --traffic-collector-name atc1 --name cp1 --location eastus --emission-policies [0]={emission-destinations:[{destination-type:AzureMonitor}],emission-type:IPFIX}

選擇性參數

--add

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

--collector-policy-name --name -n

收集器原則名稱。

--emission-policies

排放原則。 支援速記語法、json-file 和 yaml-file。 請嘗試 「??」 以顯示更多。

--force-string

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

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

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

--ingestion-policy

擷取原則。 支援速記語法、json-file 和 yaml-file。 請嘗試 「??」 以顯示更多。

--location -l

資源位置。

--no-wait

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

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

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

--resource-group -g

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

--set

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

--subscription

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

--tags

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

--traffic-collector-name -t

Azure 流量收集器名稱。

全域參數
--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 network-function traffic-collector collector-policy wait

將 CLI 置於等候狀態,直到符合條件為止。

az network-function traffic-collector collector-policy wait [--collector-policy-name]
                                                            [--created]
                                                            [--custom]
                                                            [--deleted]
                                                            [--exists]
                                                            [--ids]
                                                            [--interval]
                                                            [--resource-group]
                                                            [--subscription]
                                                            [--timeout]
                                                            [--traffic-collector-name]
                                                            [--updated]

選擇性參數

--collector-policy-name --name -n

收集器原則名稱。

--created

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

預設值: False
--custom

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

--deleted

等到刪除為止。

預設值: False
--exists

等候資源存在。

預設值: False
--ids

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

--interval

輪詢間隔以秒為單位。

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

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

--subscription

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

--timeout

以秒為單位的等候上限。

預設值: 3600
--traffic-collector-name -t

Azure 流量收集器名稱。

--updated

等到 provisioningState 更新為 'Succeeded'。

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