NetworkExtensions.GetVirtualNetworkAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.Network

Assembly:: Azure.ResourceManager.Network.dll

Package:: Azure.ResourceManager.Network v1.7.0

Package:: Azure.ResourceManager.Network v1.6.0-beta.1

Source:: NetworkExtensions.cs

Source:: NetworkExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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: 2023-09-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

Task<Response<VirtualNetworkResource>>

Exceptions

ArgumentNullException

resourceGroupResource or virtualNetworkName is null.

ArgumentException

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

Applies to