az network-function traffic-collector

Note

This reference is part of the traffic-collector extension for the Azure CLI (version 2.40.0 or higher). The extension will automatically install the first time you run an az network-function traffic-collector command. Learn more about extensions.

Manage Azure Traffic Collector resources.

Commands

Name	Description	Type	Status
az network-function traffic-collector collector-policy	Manage Collector Policy for Azure Traffic Collector resource.	Extension	GA
az network-function traffic-collector collector-policy create	Create a Collector Policy.	Extension	GA
az network-function traffic-collector collector-policy delete	Delete a specified Collector Policy.	Extension	GA
az network-function traffic-collector collector-policy list	List Collector policies.	Extension	GA
az network-function traffic-collector collector-policy show	Get the specified Collector Policy.	Extension	GA
az network-function traffic-collector collector-policy update	Update a specified Collector Policy.	Extension	GA
az network-function traffic-collector collector-policy wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az network-function traffic-collector create	Create an Azure Traffic Collector resource.	Extension	GA
az network-function traffic-collector delete	Delete a specified Azure Traffic Collector resource.	Extension	GA
az network-function traffic-collector list	Return a list of Azure Traffic Collectors.	Extension	GA
az network-function traffic-collector show	Get the specified Azure Traffic Collector resource.	Extension	GA
az network-function traffic-collector update	Update an Azure Traffic Collector resource.	Extension	GA
az network-function traffic-collector wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az network-function traffic-collector create

Create an Azure Traffic Collector resource.

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

Examples

Create a new azure traffic collector resource

az network-function traffic-collector create --resource-group rg1 --traffic-collector-name atc1 --location eastus

Required Parameters

--name --traffic-collector-name -n

Azure Traffic Collector name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--location -l

Resource location. When not specified, the location of the resource group will be used.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network-function traffic-collector delete

Delete a specified Azure Traffic Collector resource.

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

Examples

Delete a specified azure traffic collector resource

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --traffic-collector-name -n

Azure Traffic Collector name.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network-function traffic-collector list

Return a list of Azure Traffic Collectors.

az network-function traffic-collector list [--resource-group]

Examples

Return a list of azure traffic collectors in a resource group

az network-function traffic-collector list --resource-group rg1

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network-function traffic-collector show

Get the specified Azure Traffic Collector resource.

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

Examples

Get the specified azure traffic collector in a resource group

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --traffic-collector-name -n

Azure Traffic Collector name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network-function traffic-collector update

Update an Azure Traffic Collector resource.

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

Examples

Update an azure traffic collector resource

az network-function traffic-collector update --resource-group rg1 --traffic-collector-name atc1 --tags key=value

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--location -l

Resource location.

--name --traffic-collector-name -n

Azure Traffic Collector name.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network-function traffic-collector wait

Place the CLI in a waiting state until a condition is met.

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

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

Default value: 30

--name --traffic-collector-name -n

Azure Traffic Collector name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.