Share via

VirtualRouters interface

  • Reference
Package:
@azure/arm-network

Interface representing a VirtualRouters.

Methods

beginCreateOrUpdate(string, string, VirtualRouter, VirtualRoutersCreateOrUpdateOptionalParams)

Creates or updates the specified Virtual Router.
beginCreateOrUpdateAndWait(string, string, VirtualRouter, VirtualRoutersCreateOrUpdateOptionalParams)

Creates or updates the specified Virtual Router.
beginDelete(string, string, VirtualRoutersDeleteOptionalParams)

Deletes the specified Virtual Router.
beginDeleteAndWait(string, string, VirtualRoutersDeleteOptionalParams)

Deletes the specified Virtual Router.
get(string, string, VirtualRoutersGetOptionalParams)

Gets the specified Virtual Router.
list(VirtualRoutersListOptionalParams)

Gets all the Virtual Routers in a subscription.
listByResourceGroup(string, VirtualRoutersListByResourceGroupOptionalParams)

Lists all Virtual Routers in a resource group.

Method Details

beginCreateOrUpdate(string, string, VirtualRouter, VirtualRoutersCreateOrUpdateOptionalParams)

Creates or updates the specified Virtual Router.

function beginCreateOrUpdate(resourceGroupName: string, virtualRouterName: string, parameters: VirtualRouter, options?: VirtualRoutersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualRouter>, VirtualRouter>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualRouterName

string

The name of the Virtual Router.

parameters
VirtualRouter

Parameters supplied to the create or update Virtual Router.

options
VirtualRoutersCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, VirtualRouter, VirtualRoutersCreateOrUpdateOptionalParams)

Creates or updates the specified Virtual Router.

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualRouterName: string, parameters: VirtualRouter, options?: VirtualRoutersCreateOrUpdateOptionalParams): Promise<VirtualRouter>

Parameters

resourceGroupName

string

The name of the resource group.

virtualRouterName

string

The name of the Virtual Router.

parameters
VirtualRouter

Parameters supplied to the create or update Virtual Router.

options
VirtualRoutersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualRouter>

beginDelete(string, string, VirtualRoutersDeleteOptionalParams)

Deletes the specified Virtual Router.

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

Parameters

resourceGroupName

string

The name of the resource group.

virtualRouterName

string

The name of the Virtual Router.

options
VirtualRoutersDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, VirtualRoutersDeleteOptionalParams)

Deletes the specified Virtual Router.

function beginDeleteAndWait(resourceGroupName: string, virtualRouterName: string, options?: VirtualRoutersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

virtualRouterName

string

The name of the Virtual Router.

options
VirtualRoutersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, VirtualRoutersGetOptionalParams)

Gets the specified Virtual Router.

function get(resourceGroupName: string, virtualRouterName: string, options?: VirtualRoutersGetOptionalParams): Promise<VirtualRouter>

Parameters

resourceGroupName

string

The name of the resource group.

virtualRouterName

string

The name of the Virtual Router.

options
VirtualRoutersGetOptionalParams

The options parameters.

Returns

Promise<VirtualRouter>

list(VirtualRoutersListOptionalParams)

Gets all the Virtual Routers in a subscription.

function list(options?: VirtualRoutersListOptionalParams): PagedAsyncIterableIterator<VirtualRouter, VirtualRouter[], PageSettings>

Parameters

options
VirtualRoutersListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualRouter, VirtualRouter[], PageSettings>

listByResourceGroup(string, VirtualRoutersListByResourceGroupOptionalParams)

Lists all Virtual Routers in a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group.

options
VirtualRoutersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualRouter, VirtualRouter[], PageSettings>