Azure Native v1.102.0, May 2 23

azure-native.network.getVirtualNetworkGatewayAdvertisedRoutes

Explore with Pulumi AI

This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer. API Version: 2020-11-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>

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]

func GetVirtualNetworkGatewayAdvertisedRoutes(ctx *Context, args *GetVirtualNetworkGatewayAdvertisedRoutesArgs, opts ...InvokeOption) (*GetVirtualNetworkGatewayAdvertisedRoutesResult, error)
func GetVirtualNetworkGatewayAdvertisedRoutesOutput(ctx *Context, args *GetVirtualNetworkGatewayAdvertisedRoutesOutputArgs, opts ...InvokeOption) GetVirtualNetworkGatewayAdvertisedRoutesResultOutput

> 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)
}

public static CompletableFuture<GetVirtualNetworkGatewayAdvertisedRoutesResult> getVirtualNetworkGatewayAdvertisedRoutes(GetVirtualNetworkGatewayAdvertisedRoutesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

Peer string: The IP address of the peer.
ResourceGroupName string: The name of the resource group.
VirtualNetworkGatewayName string: The name of the virtual network gateway.

Peer string: The IP address of the peer.
ResourceGroupName string: The name of the resource group.
VirtualNetworkGatewayName string: The name of the virtual network gateway.

peer String: The IP address of the peer.
resourceGroupName String: The name of the resource group.
virtualNetworkGatewayName String: The name of the virtual network gateway.

peer string: The IP address of the peer.
resourceGroupName string: The name of the resource group.
virtualNetworkGatewayName string: The name of the virtual network gateway.

peer str: The IP address of the peer.
resource_group_name str: The name of the resource group.
virtual_network_gateway_name str: The name of the virtual network gateway.

peer String: The IP address of the peer.
resourceGroupName String: The name of the resource group.
virtualNetworkGatewayName String: The name of the virtual network gateway.

getVirtualNetworkGatewayAdvertisedRoutes Result

The following output properties are available:

Value List<Pulumi.AzureNative.Network.Outputs.GatewayRouteResponse>: List of gateway routes.

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 string: The route's AS path sequence.
LocalAddress string: The gateway's local address.
Network string: The route's network prefix.
NextHop string: The route's next hop.
Origin string: The source this route was learned from.
SourcePeer string: The peer this route was learned from.
Weight int: The route's weight.

AsPath string: The route's AS path sequence.
LocalAddress string: The gateway's local address.
Network string: The route's network prefix.
NextHop string: The route's next hop.
Origin string: The source this route was learned from.
SourcePeer string: The peer this route was learned from.
Weight int: The route's weight.

asPath String: The route's AS path sequence.
localAddress String: The gateway's local address.
network String: The route's network prefix.
nextHop String: The route's next hop.
origin String: The source this route was learned from.
sourcePeer String: The peer this route was learned from.
weight Integer: The route's weight.

asPath string: The route's AS path sequence.
localAddress string: The gateway's local address.
network string: The route's network prefix.
nextHop string: The route's next hop.
origin string: The source this route was learned from.
sourcePeer string: The peer this route was learned from.
weight number: The route's weight.

as_path str: The route's AS path sequence.
local_address str: The gateway's local address.
network str: The route's network prefix.
next_hop str: The route's next hop.
origin str: The source this route was learned from.
source_peer str: The peer this route was learned from.
weight int: The route's weight.

asPath String: The route's AS path sequence.
localAddress String: The gateway's local address.
network String: The route's network prefix.
nextHop String: The route's next hop.
origin String: The source this route was learned from.
sourcePeer String: The peer this route was learned from.
weight Number: The route's weight.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0