az network vnet-gateway packet-capture

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage packet capture on a virtual network gateway.

Commands

az network vnet-gateway packet-capture start	Start packet capture on a virtual network gateway.
az network vnet-gateway packet-capture stop	Stop packet capture on a virtual network gateway.
az network vnet-gateway packet-capture wait	Place the CLI in a waiting state until a condition of the vnet gateway packet capture is met.

az network vnet-gateway packet-capture start

Start packet capture on a virtual network gateway.

az network vnet-gateway packet-capture start [--filter]
                                             [--ids]
                                             [--name]
                                             [--no-wait]
                                             [--resource-group]

Examples

Start packet capture on a virtual network gateway.

az network vnet-gateway packet-capture start -g MyResourceGroup -n MyVnetGateway

Optional Parameters

--filter

Data filter.

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

Name of the VNet gateway.

--no-wait

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

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

--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 vnet-gateway packet-capture stop

Stop packet capture on a virtual network gateway.

az network vnet-gateway packet-capture stop --sas-url
                                            [--ids]
                                            [--name]
                                            [--no-wait]
                                            [--resource-group]

Examples

Stop packet capture on a virtual network gateway.

az network vnet-gateway packet-capture stop -g MyResourceGroup -n MyVnetGateway --sas-url https://myStorageAct.blob.azure.com/artifacts?st=2019-04-10T22%3A12Z&se=2019-04-11T09%3A12Z&sp=rl&sv=2018-03-28&sr=c&sig=0000000000

Required Parameters

--sas-url

The SAS url to be used for packet capture.

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

Name of the VNet gateway.

--no-wait

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

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

--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 vnet-gateway packet-capture wait

Place the CLI in a waiting state until a condition of the vnet gateway packet capture is met.

az network vnet-gateway packet-capture wait [--created]
                                            [--custom]
                                            [--deleted]
                                            [--exists]
                                            [--ids]
                                            [--interval]
                                            [--name]
                                            [--resource-group]
                                            [--timeout]
                                            [--updated]

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

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

Name of the VNet gateway.

--resource-group -g

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

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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.

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