interfaces_effective_route_tables

Creates, updates, deletes, gets or lists an interfaces_effective_route_tables resource.

Overview

Name	interfaces_effective_route_tables
Type	Resource
Id	azure.network.interfaces_effective_route_tables

Fields

The following fields are returned by SELECT queries:

get

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

Name	Datatype	Description
name	string	The name of the user defined route. This is optional.
addressPrefix	array	The address prefixes of the effective routes in CIDR notation.
disableBgpRoutePropagation	boolean	If true, on-premises routes are not propagated to the network interfaces in the subnet.
nextHopIpAddress	array	The IP address of the next hop of the effective route.
nextHopType	string	The type of Azure hop the packet should be sent to.
source	string	Who created the route.
state	string	The value of effective route.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, networkInterfaceName, subscriptionId		Gets all route tables applied to a network interface.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
networkInterfaceName	string	The name of the network interface.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets all route tables applied to a network interface.

SELECT
name,
addressPrefix,
disableBgpRoutePropagation,
nextHopIpAddress,
nextHopType,
source,
state
FROM azure.network.interfaces_effective_route_tables
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkInterfaceName = '{{ networkInterfaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;