Network Watchers - Get Next Hop

Gets the next hop from the specified VM.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/nextHop?api-version=2018-02-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

networkWatcherName
path True
  • string

The name of the network watcher.

api-version
query True
  • string

Client API version.

Request Body

Media Types: "application/json", "text/json"

default

Name Required Type Description
destinationIPAddress True
  • string

The destination IP address.

sourceIPAddress True
  • string

The source IP address.

targetNicResourceId
  • string

The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of the nics, then this parameter must be specified. Otherwise optional).

targetResourceId True
  • string

The resource identifier of the target resource against which the action is to be performed.

Responses

Name Type Description
200 OK

Request successful. The operation returns the next hop from the VM.

Media Types: "application/json", "text/json"

202 Accepted

Accepted and the operation will complete asynchronously.

Media Types: "application/json", "text/json"

Definitions

NextHopParameters

Parameters that define the source and destination endpoint.

NextHopResult

The information about next hop from the specified VM.

NextHopType

Next hop type.

NextHopParameters

Parameters that define the source and destination endpoint.

Name Type Description
destinationIPAddress
  • string

The destination IP address.

sourceIPAddress
  • string

The source IP address.

targetNicResourceId
  • string

The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of the nics, then this parameter must be specified. Otherwise optional).

targetResourceId
  • string

The resource identifier of the target resource against which the action is to be performed.

NextHopResult

The information about next hop from the specified VM.

Name Type Description
nextHopIpAddress
  • string

Next hop IP Address

nextHopType

Next hop type.

routeTableId
  • string

The resource identifier for the route table associated with the route being returned. If the route being returned does not correspond to any user created routes then this field will be the string 'System Route'.

NextHopType

Next hop type.

Name Type Description
HyperNetGateway
  • string
Internet
  • string
None
  • string
VirtualAppliance
  • string
VirtualNetworkGateway
  • string
VnetLocal
  • string