az network watcher troubleshooting

Manage Network Watcher troubleshooting sessions.

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

Commands

az network watcher troubleshooting show

Get the results of the last troubleshooting operation.

az network watcher troubleshooting start

Troubleshoot issues with VPN connections or gateway connectivity.

az network watcher troubleshooting show

Get the results of the last troubleshooting operation.

az network watcher troubleshooting show --resource
                                        [--query-examples]
                                        [--resource-group]
                                        [--resource-type {vnetGateway, vpnConnection}]
                                        [--subscription]

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

accepted values: vnetGateway, vpnConnection
--subscription

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

az network watcher troubleshooting start

Troubleshoot issues with VPN connections or gateway connectivity.

az network watcher troubleshooting start --resource
                                         --storage-account
                                         --storage-path
                                         [--no-wait]
                                         [--resource-group]
                                         [--resource-type {vnetGateway, vpnConnection}]
                                         [--subscription]

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

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

--resource-type -t

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

accepted values: vnetGateway, vpnConnection
--subscription

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