Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getVirtualNetworkGatewayAdvertisedRoutes
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.network.getVirtualNetworkGatewayAdvertisedRoutes

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer. Azure REST API version: 2023-02-01.

Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Using getVirtualNetworkGatewayAdvertisedRoutes

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 getVirtualNetworkGatewayAdvertisedRoutes(args: GetVirtualNetworkGatewayAdvertisedRoutesArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkGatewayAdvertisedRoutesResult>
function getVirtualNetworkGatewayAdvertisedRoutesOutput(args: GetVirtualNetworkGatewayAdvertisedRoutesOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkGatewayAdvertisedRoutesResult>
Copy
def get_virtual_network_gateway_advertised_routes(peer: Optional[str] = None,
                                                  resource_group_name: Optional[str] = None,
                                                  virtual_network_gateway_name: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkGatewayAdvertisedRoutesResult
def get_virtual_network_gateway_advertised_routes_output(peer: Optional[pulumi.Input[str]] = None,
                                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                                  virtual_network_gateway_name: Optional[pulumi.Input[str]] = None,
                                                  opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkGatewayAdvertisedRoutesResult]
Copy
func GetVirtualNetworkGatewayAdvertisedRoutes(ctx *Context, args *GetVirtualNetworkGatewayAdvertisedRoutesArgs, opts ...InvokeOption) (*GetVirtualNetworkGatewayAdvertisedRoutesResult, error)
func GetVirtualNetworkGatewayAdvertisedRoutesOutput(ctx *Context, args *GetVirtualNetworkGatewayAdvertisedRoutesOutputArgs, opts ...InvokeOption) GetVirtualNetworkGatewayAdvertisedRoutesResultOutput
Copy

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

public static class GetVirtualNetworkGatewayAdvertisedRoutes 
{
    public static Task<GetVirtualNetworkGatewayAdvertisedRoutesResult> InvokeAsync(GetVirtualNetworkGatewayAdvertisedRoutesArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualNetworkGatewayAdvertisedRoutesResult> Invoke(GetVirtualNetworkGatewayAdvertisedRoutesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVirtualNetworkGatewayAdvertisedRoutesResult> getVirtualNetworkGatewayAdvertisedRoutes(GetVirtualNetworkGatewayAdvertisedRoutesArgs args, InvokeOptions options)
public static Output<GetVirtualNetworkGatewayAdvertisedRoutesResult> getVirtualNetworkGatewayAdvertisedRoutes(GetVirtualNetworkGatewayAdvertisedRoutesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getVirtualNetworkGatewayAdvertisedRoutes
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Peer This property is required. string
The IP address of the peer.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network gateway.
Peer This property is required. string
The IP address of the peer.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network gateway.
peer This property is required. String
The IP address of the peer.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual network gateway.
peer This property is required. string
The IP address of the peer.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
virtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network gateway.
peer This property is required. str
The IP address of the peer.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
virtual_network_gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the virtual network gateway.
peer This property is required. String
The IP address of the peer.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual network gateway.

getVirtualNetworkGatewayAdvertisedRoutes Result

The following output properties are available:

Value []GatewayRouteResponse
List of gateway routes.
value List<GatewayRouteResponse>
List of gateway routes.
value GatewayRouteResponse[]
List of gateway routes.
value Sequence[GatewayRouteResponse]
List of gateway routes.
value List<Property Map>
List of gateway routes.

Supporting Types

GatewayRouteResponse

AsPath This property is required. string
The route's AS path sequence.
LocalAddress This property is required. string
The gateway's local address.
Network This property is required. string
The route's network prefix.
NextHop This property is required. string
The route's next hop.
Origin This property is required. string
The source this route was learned from.
SourcePeer This property is required. string
The peer this route was learned from.
Weight This property is required. int
The route's weight.
AsPath This property is required. string
The route's AS path sequence.
LocalAddress This property is required. string
The gateway's local address.
Network This property is required. string
The route's network prefix.
NextHop This property is required. string
The route's next hop.
Origin This property is required. string
The source this route was learned from.
SourcePeer This property is required. string
The peer this route was learned from.
Weight This property is required. int
The route's weight.
asPath This property is required. String
The route's AS path sequence.
localAddress This property is required. String
The gateway's local address.
network This property is required. String
The route's network prefix.
nextHop This property is required. String
The route's next hop.
origin This property is required. String
The source this route was learned from.
sourcePeer This property is required. String
The peer this route was learned from.
weight This property is required. Integer
The route's weight.
asPath This property is required. string
The route's AS path sequence.
localAddress This property is required. string
The gateway's local address.
network This property is required. string
The route's network prefix.
nextHop This property is required. string
The route's next hop.
origin This property is required. string
The source this route was learned from.
sourcePeer This property is required. string
The peer this route was learned from.
weight This property is required. number
The route's weight.
as_path This property is required. str
The route's AS path sequence.
local_address This property is required. str
The gateway's local address.
network This property is required. str
The route's network prefix.
next_hop This property is required. str
The route's next hop.
origin This property is required. str
The source this route was learned from.
source_peer This property is required. str
The peer this route was learned from.
weight This property is required. int
The route's weight.
asPath This property is required. String
The route's AS path sequence.
localAddress This property is required. String
The gateway's local address.
network This property is required. String
The route's network prefix.
nextHop This property is required. String
The route's next hop.
origin This property is required. String
The source this route was learned from.
sourcePeer This property is required. String
The peer this route was learned from.
weight This property is required. Number
The route's weight.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native