VirtualWans interface

Package:

@azure/arm-network

Interface representing a VirtualWans.

Methods

beginCreateOrUpdate(string, string, VirtualWAN, VirtualWansCreateOrUpdateOptionalParams)	Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.
beginCreateOrUpdateAndWait(string, string, VirtualWAN, VirtualWansCreateOrUpdateOptionalParams)	Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.
beginDelete(string, string, VirtualWansDeleteOptionalParams)	Deletes a VirtualWAN.
beginDeleteAndWait(string, string, VirtualWansDeleteOptionalParams)	Deletes a VirtualWAN.
get(string, string, VirtualWansGetOptionalParams)	Retrieves the details of a VirtualWAN.
list(VirtualWansListOptionalParams)	Lists all the VirtualWANs in a subscription.
listByResourceGroup(string, VirtualWansListByResourceGroupOptionalParams)	Lists all the VirtualWANs in a resource group.
updateTags(string, string, TagsObject, VirtualWansUpdateTagsOptionalParams)	Updates a VirtualWAN tags.

Method Details

beginCreateOrUpdate(string, string, VirtualWAN, VirtualWansCreateOrUpdateOptionalParams)

Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.

function beginCreateOrUpdate(resourceGroupName: string, virtualWANName: string, wANParameters: VirtualWAN, options?: VirtualWansCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualWAN>, VirtualWAN>>

Parameters

resourceGroupName

string

The resource group name of the VirtualWan.

virtualWANName

string

The name of the VirtualWAN being created or updated.

wANParameters

VirtualWAN

Parameters supplied to create or update VirtualWAN.

options

VirtualWansCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, VirtualWAN, VirtualWansCreateOrUpdateOptionalParams)

Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualWANName: string, wANParameters: VirtualWAN, options?: VirtualWansCreateOrUpdateOptionalParams): Promise<VirtualWAN>

Parameters

resourceGroupName

string

The resource group name of the VirtualWan.

virtualWANName

string

The name of the VirtualWAN being created or updated.

wANParameters

VirtualWAN

Parameters supplied to create or update VirtualWAN.

options

VirtualWansCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualWAN>

beginDelete(string, string, VirtualWansDeleteOptionalParams)

Deletes a VirtualWAN.

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

Parameters

resourceGroupName

string

The resource group name of the VirtualWan.

virtualWANName

string

The name of the VirtualWAN being deleted.

options

VirtualWansDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, VirtualWansDeleteOptionalParams)

Deletes a VirtualWAN.

function beginDeleteAndWait(resourceGroupName: string, virtualWANName: string, options?: VirtualWansDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name of the VirtualWan.

virtualWANName

string

The name of the VirtualWAN being deleted.

options

VirtualWansDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, VirtualWansGetOptionalParams)

Retrieves the details of a VirtualWAN.

function get(resourceGroupName: string, virtualWANName: string, options?: VirtualWansGetOptionalParams): Promise<VirtualWAN>

Parameters

resourceGroupName

string

The resource group name of the VirtualWan.

virtualWANName

string

The name of the VirtualWAN being retrieved.

options

VirtualWansGetOptionalParams

The options parameters.

Returns

Promise<VirtualWAN>

list(VirtualWansListOptionalParams)

Lists all the VirtualWANs in a subscription.

function list(options?: VirtualWansListOptionalParams): PagedAsyncIterableIterator<VirtualWAN, VirtualWAN[], PageSettings>

Parameters

options

VirtualWansListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualWAN, VirtualWAN[], PageSettings>

listByResourceGroup(string, VirtualWansListByResourceGroupOptionalParams)

Lists all the VirtualWANs in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: VirtualWansListByResourceGroupOptionalParams): PagedAsyncIterableIterator<VirtualWAN, VirtualWAN[], PageSettings>

Parameters

resourceGroupName

string

The resource group name of the VirtualWan.

options

VirtualWansListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualWAN, VirtualWAN[], PageSettings>

updateTags(string, string, TagsObject, VirtualWansUpdateTagsOptionalParams)

Updates a VirtualWAN tags.

function updateTags(resourceGroupName: string, virtualWANName: string, wANParameters: TagsObject, options?: VirtualWansUpdateTagsOptionalParams): Promise<VirtualWAN>

Parameters

resourceGroupName

string

The resource group name of the VirtualWan.

virtualWANName

string

The name of the VirtualWAN being updated.

wANParameters

TagsObject

Parameters supplied to Update VirtualWAN tags.

options

VirtualWansUpdateTagsOptionalParams

The options parameters.

Returns

Promise<VirtualWAN>