Share via

Route interface

  • Reference
Package:
@azure/arm-network

Route resource.

Extends
SubResource

Properties

addressPrefix

The destination CIDR to which the route applies.
etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
hasBgpOverride

A value indicating whether this route overrides overlapping BGP routes regardless of LPM. NOTE: This property will not be serialized. It can only be populated by the server.
name

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

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

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

The provisioning state of the route resource. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource.

Inherited Properties

id

Resource ID.

Property Details

addressPrefix

The destination CIDR to which the route applies.

addressPrefix?: string

Property Value

string

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

hasBgpOverride

A value indicating whether this route overrides overlapping BGP routes regardless of LPM. NOTE: This property will not be serialized. It can only be populated by the server.

hasBgpOverride?: boolean

Property Value

boolean

name

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

name?: string

Property Value

string

nextHopIpAddress

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

nextHopIpAddress?: string

Property Value

string

nextHopType

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

nextHopType?: string

Property Value

string

provisioningState

The provisioning state of the route resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

type

The type of the resource.

type?: string

Property Value

string

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From SubResource.id