Share via

Route Class

  • Reference

Route resource.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.network.models._models_py3.SubResource
Route

Constructor

Route(*, id: str | None = None, name: str | None = None, type: str | None = None, address_prefix: str | None = None, next_hop_type: str | _models.RouteNextHopType | None = None, next_hop_ip_address: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource ID.
name
str

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

The type of the resource.
address_prefix
str

The destination CIDR to which the route applies.
next_hop_type
str or RouteNextHopType

The type of Azure hop the packet should be sent to. Known values are: "VirtualNetworkGateway", "VnetLocal", "Internet", "VirtualAppliance", and "None".
next_hop_ip_address
str

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

Variables

Name Description
id
str

Resource ID.
name
str

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

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

The type of the resource.
address_prefix
str

The destination CIDR to which the route applies.
next_hop_type
str or RouteNextHopType

The type of Azure hop the packet should be sent to. Known values are: "VirtualNetworkGateway", "VnetLocal", "Internet", "VirtualAppliance", and "None".
next_hop_ip_address
str

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

The provisioning state of the route resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".
has_bgp_override
bool

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