Get Effective Route Table for Network Interface

Article
08/03/2016

The Get Effective Route Table for Network Interface operation returns information about the effective routes that are applies for the specified network interface.

Request

The Get Effective Route Table for Network Interface request is specified as follows. Replace <subscription-id> with your subscription ID, <cloud-service-name> with the name of the cloud service, <deployment-name> with the name of the deployment, <role-instance-name> with the name of the role instance, and <network-interface-name> with the name of the network interface.

Method	Request URI
GET	https://management.core.windows.net/<subscription-id>/services/hostedservices/<hosted-service-name>/deployments/<deployment-name>/roleinstances/<role-instance-name>/networkinterfaces/<network-interface-name>/effectiveroutetable

URI Parameters

None.

Request Headers

The following table describes the request headers.

Request Header	Description
x-ms-version	Required. Specifies the version of the operation to use for this request. The value of this header must be set to 2015-04-01 or higher.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

A successful operation returns status code 202 (Accepted).

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header	Description
x-ms-request-id	A value that uniquely identifies a request made against the management service.

Response Body

<EffectiveRouteTable xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
   <EffectiveRouteList> 
      <EffectiveRoute> 
         <Name /> 
         <Source>Default</Source> 
         <Status>Active</Status> 
         <AddressPrefixes> 
            <AddressPrefix>192.168.100.0/24</AddressPrefix> 
         </AddressPrefixes> 
         <EffectiveNextHop> 
            <Type>VNETLocal</Type> 
            <IpAddresses /> 
         </EffectiveNextHop> 
      </EffectiveRoute> 
      <EffectiveRoute> 
         <Name /> 
         <Source>Default</Source> 
         <Status>Active</Status> 
         <AddressPrefixes> 
            <AddressPrefix>0.0.0.0/0</AddressPrefix> 
         </AddressPrefixes> 
         <EffectiveNextHop> 
            <Type>Internet</Type> 
            <IpAddresses /> 
         </EffectiveNextHop> 
      </EffectiveRoute> 
   </EffectiveRouteList> 
</EffectiveRouteTable>

Element name	Description
Name	Specifies the name of the effective route.
Source	Specifies the source of the effective route. Possible Values are: User VPNGateway Default
Status	Specifies the status of the effective route. Possible Values are: Active Invalid
AddressPrefix	Specifies the address prefix of the effective route in CIDR notation.
Type	Specifies the type of the next hop of the effective route. Possible Values are: VPNGateway VNETLocal Internet VirtualAppliance Null
IpAddress	Specifies the IP address of the next hop of the effective route.