Share via


NetworkExtensions.GetVirtualNetworkAsync Method

Definition

Gets the specified virtual network by resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}
  • Operation Id: VirtualNetworks_Get
  • Default Api Version: 2024-03-01
  • Resource: VirtualNetworkResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VirtualNetworkResource>> GetVirtualNetworkAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string virtualNetworkName, string expand = default, System.Threading.CancellationToken cancellationToken = default);
static member GetVirtualNetworkAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VirtualNetworkResource>>
<Extension()>
Public Function GetVirtualNetworkAsync (resourceGroupResource As ResourceGroupResource, virtualNetworkName As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VirtualNetworkResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

virtualNetworkName
String

The name of the virtual network.

expand
String

Expands referenced resources.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or virtualNetworkName is null.

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

Applies to