VirtualNetworkGatewayResource.GetAdvertisedRoutesAsync Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.7.0

Source:

VirtualNetworkGatewayResource.cs

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: 2023-09-01
• Resource: VirtualNetworkGatewayResource

public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.GatewayRouteListResult>> GetAdvertisedRoutesAsync (Azure.WaitUntil waitUntil, string peer, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAdvertisedRoutesAsync : Azure.WaitUntil * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.GatewayRouteListResult>>
override this.GetAdvertisedRoutesAsync : Azure.WaitUntil * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.GatewayRouteListResult>>

Public Overridable Function GetAdvertisedRoutesAsync (waitUntil As WaitUntil, peer As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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

Task<ArmOperation<GatewayRouteListResult>>

Exceptions

ArgumentNullException

peer is null.