NetworkExtensions.GetVirtualRouter Method

Definition

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 Azure.Response<Azure.ResourceManager.Network.VirtualRouterResource> GetVirtualRouter (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string virtualRouterName, string expand = default, System.Threading.CancellationToken cancellationToken = default);
static member GetVirtualRouter : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Network.VirtualRouterResource>
<Extension()>
Public Function GetVirtualRouter (resourceGroupResource As ResourceGroupResource, virtualRouterName As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

Exceptions

resourceGroupResource or virtualRouterName is null.

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

Applies to