EffectiveRoute Class

Effective Route.

Inheritance

Model

EffectiveRoute

Constructor

EffectiveRoute(*, name: typing.Union[str, NoneType] = None, disable_bgp_route_propagation: typing.Union[bool, NoneType] = None, source: typing.Union[str, _ForwardRef('EffectiveRouteSource'), NoneType] = None, state: typing.Union[str, _ForwardRef('EffectiveRouteState'), NoneType] = None, address_prefix: typing.Union[typing.List[str], NoneType] = None, next_hop_ip_address: typing.Union[typing.List[str], NoneType] = None, next_hop_type: typing.Union[str, _ForwardRef('RouteNextHopType'), NoneType] = None, **kwargs)

Parameters

name

str

The name of the user defined route. This is optional.

disable_bgp_route_propagation

bool

If true, on-premises routes are not propagated to the network interfaces in the subnet.

source

str or EffectiveRouteSource

Who created the route. Possible values are: 'Unknown', 'User', 'VirtualNetworkGateway', and 'Default'. Possible values include: "Unknown", "User", "VirtualNetworkGateway", "Default".

state

str or EffectiveRouteState

The value of effective route. Possible values are: 'Active' and 'Invalid'. Possible values include: "Active", "Invalid".

address_prefix

list[str]

The address prefixes of the effective routes in CIDR notation.

next_hop_ip_address

list[str]

The IP address of the next hop of the effective route.

next_hop_type

str or RouteNextHopType

The type of Azure hop the packet should be sent to. Possible values include: "VirtualNetworkGateway", "VnetLocal", "Internet", "VirtualAppliance", "None".