NetworkExtensions.GetVirtualRouterAsync Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.9.0

Source:

NetworkExtensions.cs

Gets the specified Virtual Router.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}
• Operation Id: VirtualRouters_Get
• Default Api Version: 2024-03-01
• Resource: VirtualRouterResource

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VirtualRouterResource>> GetVirtualRouterAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string virtualRouterName, string expand = default, System.Threading.CancellationToken cancellationToken = default);

static member GetVirtualRouterAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VirtualRouterResource>>

<Extension()>
Public Function GetVirtualRouterAsync (resourceGroupResource As ResourceGroupResource, virtualRouterName As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VirtualRouterResource))

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

virtualRouterName

String

The name of the Virtual Router.

expand

String

Expands referenced resources.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<VirtualRouterResource>>

Exceptions

ArgumentNullException

resourceGroupResource or virtualRouterName is null.

ArgumentException

virtualRouterName is an empty string, and was expected to be non-empty.