virtual_hubs_effective_virtual_hub_routes

Creates, updates, deletes, gets or lists a virtual_hubs_effective_virtual_hub_routes resource.

Overview

Name	virtual_hubs_effective_virtual_hub_routes
Type	Resource
Id	azure.network.virtual_hubs_effective_virtual_hub_routes

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the list of the effective routes or follow the location header for the effective routes list.

Name	Datatype	Description
addressPrefixes	array	The list of address prefixes.
asPath	string	The ASPath of this route.
nextHopType	string	The type of the next hop.
nextHops	array	The list of next hops.
routeOrigin	string	The origin of this route.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, virtualHubName		Gets the effective routes configured for the Virtual Hub resource or the specified resource .

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
resourceGroupName	string	The resource group name of the VirtualHub.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualHubName	string	The name of the VirtualHub.

SELECT examples

get

Gets the effective routes configured for the Virtual Hub resource or the specified resource .

SELECT
addressPrefixes,
asPath,
nextHopType,
nextHops,
routeOrigin
FROM azure.network.virtual_hubs_effective_virtual_hub_routes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualHubName = '{{ virtualHubName }}' -- required
;