azure-native.network.getVirtualNetworkGatewayRoutesInformation

Azure Native v3.16.0, Mar 20 26

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

Using getVirtualNetworkGatewayRoutesInformation

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVirtualNetworkGatewayRoutesInformation(args: GetVirtualNetworkGatewayRoutesInformationArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkGatewayRoutesInformationResult>
function getVirtualNetworkGatewayRoutesInformationOutput(args: GetVirtualNetworkGatewayRoutesInformationOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkGatewayRoutesInformationResult>

def get_virtual_network_gateway_routes_information(attempt_refresh: Optional[bool] = None,
                                                   resource_group_name: Optional[str] = None,
                                                   virtual_network_gateway_name: Optional[str] = None,
                                                   opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkGatewayRoutesInformationResult
def get_virtual_network_gateway_routes_information_output(attempt_refresh: Optional[pulumi.Input[bool]] = None,
                                                   resource_group_name: Optional[pulumi.Input[str]] = None,
                                                   virtual_network_gateway_name: Optional[pulumi.Input[str]] = None,
                                                   opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkGatewayRoutesInformationResult]

func GetVirtualNetworkGatewayRoutesInformation(ctx *Context, args *GetVirtualNetworkGatewayRoutesInformationArgs, opts ...InvokeOption) (*GetVirtualNetworkGatewayRoutesInformationResult, error)
func GetVirtualNetworkGatewayRoutesInformationOutput(ctx *Context, args *GetVirtualNetworkGatewayRoutesInformationOutputArgs, opts ...InvokeOption) GetVirtualNetworkGatewayRoutesInformationResultOutput

> Note: This function is named GetVirtualNetworkGatewayRoutesInformation in the Go SDK.

public static class GetVirtualNetworkGatewayRoutesInformation 
{
    public static Task<GetVirtualNetworkGatewayRoutesInformationResult> InvokeAsync(GetVirtualNetworkGatewayRoutesInformationArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualNetworkGatewayRoutesInformationResult> Invoke(GetVirtualNetworkGatewayRoutesInformationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualNetworkGatewayRoutesInformationResult> getVirtualNetworkGatewayRoutesInformation(GetVirtualNetworkGatewayRoutesInformationArgs args, InvokeOptions options)
public static Output<GetVirtualNetworkGatewayRoutesInformationResult> getVirtualNetworkGatewayRoutesInformation(GetVirtualNetworkGatewayRoutesInformationArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:network:getVirtualNetworkGatewayRoutesInformation
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group.
VirtualNetworkGatewayName string: The name of the virtual network gateway.
AttemptRefresh bool: Attempt to recalculate the Route Sets Information for the gateway

ResourceGroupName string: The name of the resource group.
VirtualNetworkGatewayName string: The name of the virtual network gateway.
AttemptRefresh bool: Attempt to recalculate the Route Sets Information for the gateway

resourceGroupName String: The name of the resource group.
virtualNetworkGatewayName String: The name of the virtual network gateway.
attemptRefresh Boolean: Attempt to recalculate the Route Sets Information for the gateway

resourceGroupName string: The name of the resource group.
virtualNetworkGatewayName string: The name of the virtual network gateway.
attemptRefresh boolean: Attempt to recalculate the Route Sets Information for the gateway

resource_group_name str: The name of the resource group.
virtual_network_gateway_name str: The name of the virtual network gateway.
attempt_refresh bool: Attempt to recalculate the Route Sets Information for the gateway

resourceGroupName String: The name of the resource group.
virtualNetworkGatewayName String: The name of the virtual network gateway.
attemptRefresh Boolean: Attempt to recalculate the Route Sets Information for the gateway

getVirtualNetworkGatewayRoutesInformation Result

The following output properties are available:

CircuitsMetadataMap Dictionary<string, Pulumi.AzureNative.Network.Outputs.CircuitMetadataMapResponse>: Dictionary containing map of the circuit id and circuit details
LastComputedTime string: Timestamp denoting the last time when the route sets were computed for the gateway
NextEligibleComputeTime string: Timestamp denoting the next eligible time to re-compute the route sets for the gateway
RouteSetVersion string: Version for the route set
RouteSets List<Pulumi.AzureNative.Network.Outputs.GatewayRouteSetResponse>: List of Gateway Route Sets

CircuitsMetadataMap map[string]CircuitMetadataMapResponse: Dictionary containing map of the circuit id and circuit details
LastComputedTime string: Timestamp denoting the last time when the route sets were computed for the gateway
NextEligibleComputeTime string: Timestamp denoting the next eligible time to re-compute the route sets for the gateway
RouteSetVersion string: Version for the route set
RouteSets []GatewayRouteSetResponse: List of Gateway Route Sets

circuitsMetadataMap Map<String,CircuitMetadataMapResponse>: Dictionary containing map of the circuit id and circuit details
lastComputedTime String: Timestamp denoting the last time when the route sets were computed for the gateway
nextEligibleComputeTime String: Timestamp denoting the next eligible time to re-compute the route sets for the gateway
routeSetVersion String: Version for the route set
routeSets List<GatewayRouteSetResponse>: List of Gateway Route Sets

circuitsMetadataMap {[key: string]: CircuitMetadataMapResponse}: Dictionary containing map of the circuit id and circuit details
lastComputedTime string: Timestamp denoting the last time when the route sets were computed for the gateway
nextEligibleComputeTime string: Timestamp denoting the next eligible time to re-compute the route sets for the gateway
routeSetVersion string: Version for the route set
routeSets GatewayRouteSetResponse[]: List of Gateway Route Sets

circuits_metadata_map Mapping[str, CircuitMetadataMapResponse]: Dictionary containing map of the circuit id and circuit details
last_computed_time str: Timestamp denoting the last time when the route sets were computed for the gateway
next_eligible_compute_time str: Timestamp denoting the next eligible time to re-compute the route sets for the gateway
route_set_version str: Version for the route set
route_sets Sequence[GatewayRouteSetResponse]: List of Gateway Route Sets

circuitsMetadataMap Map<Property Map>: Dictionary containing map of the circuit id and circuit details
lastComputedTime String: Timestamp denoting the last time when the route sets were computed for the gateway
nextEligibleComputeTime String: Timestamp denoting the next eligible time to re-compute the route sets for the gateway
routeSetVersion String: Version for the route set
routeSets List<Property Map>: List of Gateway Route Sets

Supporting Types

CircuitMetadataMapResponse

Link string: Link to the Express Route circuit
Location string: Peering location of the Express Route Circuit
Name string: Express Route Circuit Name

Link string: Link to the Express Route circuit
Location string: Peering location of the Express Route Circuit
Name string: Express Route Circuit Name

link String: Link to the Express Route circuit
location String: Peering location of the Express Route Circuit
name String: Express Route Circuit Name

link string: Link to the Express Route circuit
location string: Peering location of the Express Route Circuit
name string: Express Route Circuit Name

link str: Link to the Express Route circuit
location str: Peering location of the Express Route Circuit
name str: Express Route Circuit Name

link String: Link to the Express Route circuit
location String: Peering location of the Express Route Circuit
name String: Express Route Circuit Name

GatewayRouteSetResponse

Details Dictionary<string, ImmutableArray<Pulumi.AzureNative.Network.Inputs.RouteSourceDetailsResponse>>: List of different Route Sources
Locations List<string>: List of different locations from where the routes are learned
Name string: Route Set name

Details map[string][]RouteSourceDetailsResponse: List of different Route Sources
Locations []string: List of different locations from where the routes are learned
Name string: Route Set name

details Map<String,List<RouteSourceDetailsResponse>>: List of different Route Sources
locations List<String>: List of different locations from where the routes are learned
name String: Route Set name

details {[key: string]: RouteSourceDetailsResponse[]}: List of different Route Sources
locations string[]: List of different locations from where the routes are learned
name string: Route Set name

details Mapping[str, Sequence[RouteSourceDetailsResponse]]: List of different Route Sources
locations Sequence[str]: List of different locations from where the routes are learned
name str: Route Set name

details Map<List<Property Map>>: List of different Route Sources
locations List<String>: List of different locations from where the routes are learned
name String: Route Set name

RouteSourceDetailsResponse

Circuit string: Express Route Circuit identifier
Pri string: Flag to indicate if the route learned from the primary device is active or passive
Sec string: Flag to indicate if the route learned from the secondary device is active or passive

Circuit string: Express Route Circuit identifier
Pri string: Flag to indicate if the route learned from the primary device is active or passive
Sec string: Flag to indicate if the route learned from the secondary device is active or passive

circuit String: Express Route Circuit identifier
pri String: Flag to indicate if the route learned from the primary device is active or passive
sec String: Flag to indicate if the route learned from the secondary device is active or passive

circuit string: Express Route Circuit identifier
pri string: Flag to indicate if the route learned from the primary device is active or passive
sec string: Flag to indicate if the route learned from the secondary device is active or passive

circuit str: Express Route Circuit identifier
pri str: Flag to indicate if the route learned from the primary device is active or passive
sec str: Flag to indicate if the route learned from the secondary device is active or passive

circuit String: Express Route Circuit identifier
pri String: Flag to indicate if the route learned from the primary device is active or passive
sec String: Flag to indicate if the route learned from the secondary device is active or passive