Routes - List

Gets all routes in a route table.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes?api-version=2020-11-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The name of the resource group.

routeTableName
path True
  • string

The name of the route table.

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.

api-version
query True
  • string

Client API version.

Responses

Name Type Description
200 OK

Request successful. The operation returns a list of Route resources.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

List routes

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes?api-version=2020-11-01

Sample Response

{
  "value": [
    {
      "name": "route1",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1",
      "properties": {
        "provisioningState": "Succeeded",
        "addressPrefix": "10.0.3.0/24",
        "nextHopType": "Internet"
      }
    },
    {
      "name": "route2",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route2",
      "properties": {
        "provisioningState": "Succeeded",
        "addressPrefix": "10.0.2.0/24",
        "nextHopType": "VirtualNetworkGateway"
      }
    }
  ]
}

Definitions

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

ProvisioningState

The current provisioning state.

Route

Route resource.

RouteListResult

Response for the ListRoute API service call.

RouteNextHopType

The type of Azure hop the packet should be sent to.

CloudError

An error response from the service.

Name Type Description
error

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code
  • string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

A list of additional details about the error.

message
  • string

A message describing the error, intended to be suitable for display in a user interface.

target
  • string

The target of the particular error. For example, the name of the property in error.

ProvisioningState

The current provisioning state.

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

Route

Route resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.addressPrefix
  • string

The destination CIDR to which the route applies.

properties.hasBgpOverride
  • boolean

A value indicating whether this route overrides overlapping BGP routes regardless of LPM.

properties.nextHopIpAddress
  • string

The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

properties.nextHopType

The type of Azure hop the packet should be sent to.

properties.provisioningState

The provisioning state of the route resource.

type
  • string

The type of the resource.

RouteListResult

Response for the ListRoute API service call.

Name Type Description
nextLink
  • string

The URL to get the next set of results.

value

A list of routes in a resource group.

RouteNextHopType

The type of Azure hop the packet should be sent to.

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