Share via

az network watcher troubleshooting

Manage Network Watcher troubleshooting sessions.

For more information on configuring troubleshooting visit https://learn.microsoft.com/azure/network-watcher/network-watcher-troubleshoot-manage-cli.

Commands

Name Description Type Status
az network watcher troubleshooting show

Get the results of the last troubleshooting operation.

 Core GA
az network watcher troubleshooting start

Troubleshoot issues with VPN connections or gateway connectivity.

 Core GA

az network watcher troubleshooting show

Edit

Get the results of the last troubleshooting operation.

az network watcher troubleshooting show --resource
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--resource-group]
                                        [--resource-type {vnetGateway, vpnConnection}]
                                        [--watcher-rg]

Examples

Show the results or status of a troubleshooting operation for a Vnet Gateway.

az network watcher troubleshooting show -g MyResourceGroup --resource MyVnetGateway --resource-type vnetGateway

Required Parameters

--resource

Name or ID of the resource to troubleshoot.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

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

--resource-type -t

The resource type.

Property Value
Accepted values: vnetGateway, vpnConnection
--watcher-rg

Name of the resource group the watcher is in.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network watcher troubleshooting start

Edit

Troubleshoot issues with VPN connections or gateway connectivity.

az network watcher troubleshooting start --resource
                                         --storage-account
                                         --storage-path
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--resource-type {vnetGateway, vpnConnection}]
                                         [--watcher-rg]

Examples

Start a troubleshooting operation on a VPN Connection.

az network watcher troubleshooting start -g MyResourceGroup --resource MyVPNConnection --resource-type vpnConnection --storage-account MyStorageAccount --storage-path https://{storageAccountName}.blob.core.windows.net/{containerName}

Required Parameters

--resource

Name or ID of the resource to troubleshoot.

--storage-account

Name or ID of the storage account in which to store the troubleshooting results.

--storage-path

Fully qualified URI to the storage blob container in which to store the troubleshooting results.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

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

--resource-type -t

The type of target resource to troubleshoot, if resource ID is not specified.

Property Value
Accepted values: vnetGateway, vpnConnection
--watcher-rg

Name of the resource group the watcher is in.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False