VirtualNetworkPeerings interface

Package:

@azure/arm-network-profile-2020-09-01-hybrid

Interface representing a VirtualNetworkPeerings.

Methods

beginCreateOrUpdate(string, string, string, VirtualNetworkPeering, VirtualNetworkPeeringsCreateOrUpdateOptionalParams)	Creates or updates a peering in the specified virtual network.
beginCreateOrUpdateAndWait(string, string, string, VirtualNetworkPeering, VirtualNetworkPeeringsCreateOrUpdateOptionalParams)	Creates or updates a peering in the specified virtual network.
beginDelete(string, string, string, VirtualNetworkPeeringsDeleteOptionalParams)	Deletes the specified virtual network peering.
beginDeleteAndWait(string, string, string, VirtualNetworkPeeringsDeleteOptionalParams)	Deletes the specified virtual network peering.
get(string, string, string, VirtualNetworkPeeringsGetOptionalParams)	Gets the specified virtual network peering.
list(string, string, VirtualNetworkPeeringsListOptionalParams)	Gets all virtual network peerings in a virtual network.

Method Details

beginCreateOrUpdate(string, string, string, VirtualNetworkPeering, VirtualNetworkPeeringsCreateOrUpdateOptionalParams)

Creates or updates a peering in the specified virtual network.

function beginCreateOrUpdate(resourceGroupName: string, virtualNetworkName: string, virtualNetworkPeeringName: string, virtualNetworkPeeringParameters: VirtualNetworkPeering, options?: VirtualNetworkPeeringsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkPeering>, VirtualNetworkPeering>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

virtualNetworkPeeringName

string

The name of the peering.

virtualNetworkPeeringParameters

VirtualNetworkPeering

Parameters supplied to the create or update virtual network peering operation.

options

VirtualNetworkPeeringsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualNetworkPeering>, VirtualNetworkPeering>>

beginCreateOrUpdateAndWait(string, string, string, VirtualNetworkPeering, VirtualNetworkPeeringsCreateOrUpdateOptionalParams)

Creates or updates a peering in the specified virtual network.

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualNetworkName: string, virtualNetworkPeeringName: string, virtualNetworkPeeringParameters: VirtualNetworkPeering, options?: VirtualNetworkPeeringsCreateOrUpdateOptionalParams): Promise<VirtualNetworkPeering>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

virtualNetworkPeeringName

string

The name of the peering.

virtualNetworkPeeringParameters

VirtualNetworkPeering

Parameters supplied to the create or update virtual network peering operation.

options

VirtualNetworkPeeringsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualNetworkPeering>

beginDelete(string, string, string, VirtualNetworkPeeringsDeleteOptionalParams)

Deletes the specified virtual network peering.

function beginDelete(resourceGroupName: string, virtualNetworkName: string, virtualNetworkPeeringName: string, options?: VirtualNetworkPeeringsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

virtualNetworkPeeringName

string

The name of the virtual network peering.

options

VirtualNetworkPeeringsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, VirtualNetworkPeeringsDeleteOptionalParams)

Deletes the specified virtual network peering.

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

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

virtualNetworkPeeringName

string

The name of the virtual network peering.

options

VirtualNetworkPeeringsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, VirtualNetworkPeeringsGetOptionalParams)

Gets the specified virtual network peering.

function get(resourceGroupName: string, virtualNetworkName: string, virtualNetworkPeeringName: string, options?: VirtualNetworkPeeringsGetOptionalParams): Promise<VirtualNetworkPeering>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

virtualNetworkPeeringName

string

The name of the virtual network peering.

options

VirtualNetworkPeeringsGetOptionalParams

The options parameters.

Returns

Promise<VirtualNetworkPeering>

list(string, string, VirtualNetworkPeeringsListOptionalParams)

Gets all virtual network peerings in a virtual network.

function list(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworkPeeringsListOptionalParams): PagedAsyncIterableIterator<VirtualNetworkPeering, VirtualNetworkPeering[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

options

VirtualNetworkPeeringsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualNetworkPeering, VirtualNetworkPeering[], PageSettings>