3.1.5.8.2.3 routes

The routes resource represents a provider route. If a host connects to a logical subnet as part of hosting a virtual network, then all routes in that logical subnet are applied to the host. Consequently, the host can route the traffic to the correct destination.

The URI for the resource is as follows.

 https://<url>/networking/v1/logicalNetworks/{grandParentResourceId}/subnets/{parentResourceId}/routes/{resourceId}

url: The address or name of the REST server of the Network Controller.

grandParentResourceId: the identifier for the specific ancestor resource within the resource type. See section 2.2.3.1 for more details.

parentResourceId: the identifier for the specific resource that is the descendant of the grandParentResource and the ancestor of the routes resource. See section 2.2.3.3 for more details.

resourceId: the identifier for the specific resource within the resource type that is the descendant of the parentResource. See section 2.2.3.4 for more details.

Note  The server MAY support additional versions, besides v1 in the URI.

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.8.2.3.1.1

Create a new routes resource or update an existing routes resource.

GET

3.1.5.8.2.3.1.2

Get one routes resource.

GET ALL

3.1.5.8.2.3.1.3

List all routes resources in the Network Controller.

DELETE

3.1.5.8.2.3.1.4

Delete a routes resource.

The following property elements are valid.

Element name

Type

Description

etag

Read-only

Specified in Common JSON Elements, section 2.2.2.

provisioningState

Read-only

Specified in Common JSON Elements, section 2.2.2.

destination

Required

Indicates the destination subnet that this route applies to.  It is specified in the form of 0.0.0.0/0. The destination subnet is of the same type as the subnet that it is created in. For example, this has to be an IPv4 destination subnet if its parent subnet is an IPv4 subnet, similarily for IPv6 the destination route is the subnet is IPv6.

nextHop

Required

Indicates the next hop IP address for this routes resource. It is specified in the form of 0.0.0.0. The next hop has to be a valid IP address in the subnet.