VirtualNetworks interface

Package:

@azure/arm-network

Interface representing a VirtualNetworks.

Methods

beginCreateOrUpdate(string, string, VirtualNetwork, VirtualNetworksCreateOrUpdateOptionalParams)	Creates or updates a virtual network in the specified resource group.
beginCreateOrUpdateAndWait(string, string, VirtualNetwork, VirtualNetworksCreateOrUpdateOptionalParams)	Creates or updates a virtual network in the specified resource group.
beginDelete(string, string, VirtualNetworksDeleteOptionalParams)	Deletes the specified virtual network.
beginDeleteAndWait(string, string, VirtualNetworksDeleteOptionalParams)	Deletes the specified virtual network.
beginListDdosProtectionStatusAndWait(string, string, VirtualNetworksListDdosProtectionStatusOptionalParams)	Gets the Ddos Protection Status of all IP Addresses under the Virtual Network
checkIPAddressAvailability(string, string, string, VirtualNetworksCheckIPAddressAvailabilityOptionalParams)	Checks whether a private IP address is available for use.
get(string, string, VirtualNetworksGetOptionalParams)	Gets the specified virtual network by resource group.
list(string, VirtualNetworksListOptionalParams)	Gets all virtual networks in a resource group.
listAll(VirtualNetworksListAllOptionalParams)	Gets all virtual networks in a subscription.
listUsage(string, string, VirtualNetworksListUsageOptionalParams)	Lists usage stats.
updateTags(string, string, TagsObject, VirtualNetworksUpdateTagsOptionalParams)	Updates a virtual network tags.

Method Details

beginCreateOrUpdate(string, string, VirtualNetwork, VirtualNetworksCreateOrUpdateOptionalParams)

Creates or updates a virtual network in the specified resource group.

function beginCreateOrUpdate(resourceGroupName: string, virtualNetworkName: string, parameters: VirtualNetwork, options?: VirtualNetworksCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

parameters

VirtualNetwork

Parameters supplied to the create or update virtual network operation.

options

VirtualNetworksCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>

beginCreateOrUpdateAndWait(string, string, VirtualNetwork, VirtualNetworksCreateOrUpdateOptionalParams)

Creates or updates a virtual network in the specified resource group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualNetworkName: string, parameters: VirtualNetwork, options?: VirtualNetworksCreateOrUpdateOptionalParams): Promise<VirtualNetwork>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

parameters

VirtualNetwork

Parameters supplied to the create or update virtual network operation.

options

VirtualNetworksCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualNetwork>

beginDelete(string, string, VirtualNetworksDeleteOptionalParams)

Deletes the specified virtual network.

function beginDelete(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworksDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

options

VirtualNetworksDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, VirtualNetworksDeleteOptionalParams)

Deletes the specified virtual network.

function beginDeleteAndWait(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworksDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

options

VirtualNetworksDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginListDdosProtectionStatusAndWait(string, string, VirtualNetworksListDdosProtectionStatusOptionalParams)

Gets the Ddos Protection Status of all IP Addresses under the Virtual Network

function beginListDdosProtectionStatusAndWait(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworksListDdosProtectionStatusOptionalParams): PagedAsyncIterableIterator<PublicIpDdosProtectionStatusResult, PublicIpDdosProtectionStatusResult[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

options

VirtualNetworksListDdosProtectionStatusOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PublicIpDdosProtectionStatusResult, PublicIpDdosProtectionStatusResult[], PageSettings>

checkIPAddressAvailability(string, string, string, VirtualNetworksCheckIPAddressAvailabilityOptionalParams)

Checks whether a private IP address is available for use.

function checkIPAddressAvailability(resourceGroupName: string, virtualNetworkName: string, ipAddress: string, options?: VirtualNetworksCheckIPAddressAvailabilityOptionalParams): Promise<IPAddressAvailabilityResult>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

ipAddress

string

The private IP address to be verified.

options

VirtualNetworksCheckIPAddressAvailabilityOptionalParams

The options parameters.

Returns

Promise<IPAddressAvailabilityResult>

get(string, string, VirtualNetworksGetOptionalParams)

Gets the specified virtual network by resource group.

function get(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworksGetOptionalParams): Promise<VirtualNetwork>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

options

VirtualNetworksGetOptionalParams

The options parameters.

Returns

Promise<VirtualNetwork>

list(string, VirtualNetworksListOptionalParams)

Gets all virtual networks in a resource group.

function list(resourceGroupName: string, options?: VirtualNetworksListOptionalParams): PagedAsyncIterableIterator<VirtualNetwork, VirtualNetwork[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options

VirtualNetworksListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualNetwork, VirtualNetwork[], PageSettings>

listAll(VirtualNetworksListAllOptionalParams)

Gets all virtual networks in a subscription.

function listAll(options?: VirtualNetworksListAllOptionalParams): PagedAsyncIterableIterator<VirtualNetwork, VirtualNetwork[], PageSettings>

Parameters

options

VirtualNetworksListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualNetwork, VirtualNetwork[], PageSettings>

listUsage(string, string, VirtualNetworksListUsageOptionalParams)

Lists usage stats.

function listUsage(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworksListUsageOptionalParams): PagedAsyncIterableIterator<VirtualNetworkUsage, VirtualNetworkUsage[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

options

VirtualNetworksListUsageOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualNetworkUsage, VirtualNetworkUsage[], PageSettings>

updateTags(string, string, TagsObject, VirtualNetworksUpdateTagsOptionalParams)

Updates a virtual network tags.

function updateTags(resourceGroupName: string, virtualNetworkName: string, parameters: TagsObject, options?: VirtualNetworksUpdateTagsOptionalParams): Promise<VirtualNetwork>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

parameters

TagsObject

Parameters supplied to update virtual network tags.

options

VirtualNetworksUpdateTagsOptionalParams

The options parameters.

Returns

Promise<VirtualNetwork>