Share via


VirtualNetworkGatewayResource.GetAdvertisedRoutes Method

Definition

This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes
  • Operation Id: VirtualNetworkGateways_GetAdvertisedRoutes
  • Default Api Version: 2024-03-01
  • Resource: VirtualNetworkGatewayResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.GatewayRouteListResult> GetAdvertisedRoutes (Azure.WaitUntil waitUntil, string peer, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAdvertisedRoutes : Azure.WaitUntil * string * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.GatewayRouteListResult>
override this.GetAdvertisedRoutes : Azure.WaitUntil * string * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.GatewayRouteListResult>
Public Overridable Function GetAdvertisedRoutes (waitUntil As WaitUntil, peer As String, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of GatewayRouteListResult)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

peer
String

The IP address of the peer.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

peer is null.

Applies to