VirtualRouterPeerings interface

Package:

@azure/arm-network

Interface representing a VirtualRouterPeerings.

Methods

beginCreateOrUpdate(string, string, string, VirtualRouterPeering, VirtualRouterPeeringsCreateOrUpdateOptionalParams)	Creates or updates the specified Virtual Router Peering.
beginCreateOrUpdateAndWait(string, string, string, VirtualRouterPeering, VirtualRouterPeeringsCreateOrUpdateOptionalParams)	Creates or updates the specified Virtual Router Peering.
beginDelete(string, string, string, VirtualRouterPeeringsDeleteOptionalParams)	Deletes the specified peering from a Virtual Router.
beginDeleteAndWait(string, string, string, VirtualRouterPeeringsDeleteOptionalParams)	Deletes the specified peering from a Virtual Router.
get(string, string, string, VirtualRouterPeeringsGetOptionalParams)	Gets the specified Virtual Router Peering.
list(string, string, VirtualRouterPeeringsListOptionalParams)	Lists all Virtual Router Peerings in a Virtual Router resource.

Method Details

beginCreateOrUpdate(string, string, string, VirtualRouterPeering, VirtualRouterPeeringsCreateOrUpdateOptionalParams)

Creates or updates the specified Virtual Router Peering.

function beginCreateOrUpdate(resourceGroupName: string, virtualRouterName: string, peeringName: string, parameters: VirtualRouterPeering, options?: VirtualRouterPeeringsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualRouterPeering>, VirtualRouterPeering>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualRouterName

string

The name of the Virtual Router.

peeringName

string

The name of the Virtual Router Peering.

parameters

VirtualRouterPeering

Parameters supplied to the create or update Virtual Router Peering operation.

options

VirtualRouterPeeringsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, VirtualRouterPeering, VirtualRouterPeeringsCreateOrUpdateOptionalParams)

Creates or updates the specified Virtual Router Peering.

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualRouterName: string, peeringName: string, parameters: VirtualRouterPeering, options?: VirtualRouterPeeringsCreateOrUpdateOptionalParams): Promise<VirtualRouterPeering>

Parameters

resourceGroupName

string

The name of the resource group.

virtualRouterName

string

The name of the Virtual Router.

peeringName

string

The name of the Virtual Router Peering.

parameters

VirtualRouterPeering

Parameters supplied to the create or update Virtual Router Peering operation.

options

VirtualRouterPeeringsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualRouterPeering>

beginDelete(string, string, string, VirtualRouterPeeringsDeleteOptionalParams)

Deletes the specified peering from a Virtual Router.

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

Parameters

resourceGroupName

string

The name of the resource group.

virtualRouterName

string

The name of the Virtual Router.

peeringName

string

The name of the peering.

options

VirtualRouterPeeringsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, VirtualRouterPeeringsDeleteOptionalParams)

Deletes the specified peering from a Virtual Router.

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

Parameters

resourceGroupName

string

The name of the resource group.

virtualRouterName

string

The name of the Virtual Router.

peeringName

string

The name of the peering.

options

VirtualRouterPeeringsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, VirtualRouterPeeringsGetOptionalParams)

Gets the specified Virtual Router Peering.

function get(resourceGroupName: string, virtualRouterName: string, peeringName: string, options?: VirtualRouterPeeringsGetOptionalParams): Promise<VirtualRouterPeering>

Parameters

resourceGroupName

string

The name of the resource group.

virtualRouterName

string

The name of the Virtual Router.

peeringName

string

The name of the Virtual Router Peering.

options

VirtualRouterPeeringsGetOptionalParams

The options parameters.

Returns

Promise<VirtualRouterPeering>

list(string, string, VirtualRouterPeeringsListOptionalParams)

Lists all Virtual Router Peerings in a Virtual Router resource.

function list(resourceGroupName: string, virtualRouterName: string, options?: VirtualRouterPeeringsListOptionalParams): PagedAsyncIterableIterator<VirtualRouterPeering, VirtualRouterPeering[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

virtualRouterName

string

The name of the Virtual Router.

options

VirtualRouterPeeringsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualRouterPeering, VirtualRouterPeering[], PageSettings>