VpnConnections interface

Package:

@azure/arm-network

Interface representing a VpnConnections.

Methods

beginCreateOrUpdate(string, string, string, VpnConnection, VpnConnectionsCreateOrUpdateOptionalParams)	Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.
beginCreateOrUpdateAndWait(string, string, string, VpnConnection, VpnConnectionsCreateOrUpdateOptionalParams)	Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.
beginDelete(string, string, string, VpnConnectionsDeleteOptionalParams)	Deletes a vpn connection.
beginDeleteAndWait(string, string, string, VpnConnectionsDeleteOptionalParams)	Deletes a vpn connection.
beginStartPacketCapture(string, string, string, VpnConnectionsStartPacketCaptureOptionalParams)	Starts packet capture on Vpn connection in the specified resource group.
beginStartPacketCaptureAndWait(string, string, string, VpnConnectionsStartPacketCaptureOptionalParams)	Starts packet capture on Vpn connection in the specified resource group.
beginStopPacketCapture(string, string, string, VpnConnectionsStopPacketCaptureOptionalParams)	Stops packet capture on Vpn connection in the specified resource group.
beginStopPacketCaptureAndWait(string, string, string, VpnConnectionsStopPacketCaptureOptionalParams)	Stops packet capture on Vpn connection in the specified resource group.
get(string, string, string, VpnConnectionsGetOptionalParams)	Retrieves the details of a vpn connection.
listByVpnGateway(string, string, VpnConnectionsListByVpnGatewayOptionalParams)	Retrieves all vpn connections for a particular virtual wan vpn gateway.

Method Details

beginCreateOrUpdate(string, string, string, VpnConnection, VpnConnectionsCreateOrUpdateOptionalParams)

Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.

function beginCreateOrUpdate(resourceGroupName: string, gatewayName: string, connectionName: string, vpnConnectionParameters: VpnConnection, options?: VpnConnectionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VpnConnection>, VpnConnection>>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

connectionName

string

The name of the connection.

vpnConnectionParameters

VpnConnection

Parameters supplied to create or Update a VPN Connection.

options

VpnConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, VpnConnection, VpnConnectionsCreateOrUpdateOptionalParams)

Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.

function beginCreateOrUpdateAndWait(resourceGroupName: string, gatewayName: string, connectionName: string, vpnConnectionParameters: VpnConnection, options?: VpnConnectionsCreateOrUpdateOptionalParams): Promise<VpnConnection>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

connectionName

string

The name of the connection.

vpnConnectionParameters

VpnConnection

Parameters supplied to create or Update a VPN Connection.

options

VpnConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VpnConnection>

beginDelete(string, string, string, VpnConnectionsDeleteOptionalParams)

Deletes a vpn connection.

function beginDelete(resourceGroupName: string, gatewayName: string, connectionName: string, options?: VpnConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

connectionName

string

The name of the connection.

options

VpnConnectionsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, VpnConnectionsDeleteOptionalParams)

Deletes a vpn connection.

function beginDeleteAndWait(resourceGroupName: string, gatewayName: string, connectionName: string, options?: VpnConnectionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

connectionName

string

The name of the connection.

options

VpnConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginStartPacketCapture(string, string, string, VpnConnectionsStartPacketCaptureOptionalParams)

Starts packet capture on Vpn connection in the specified resource group.

function beginStartPacketCapture(resourceGroupName: string, gatewayName: string, vpnConnectionName: string, options?: VpnConnectionsStartPacketCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VpnConnectionsStartPacketCaptureResponse>, VpnConnectionsStartPacketCaptureResponse>>

Parameters

resourceGroupName

string

The name of the resource group.

gatewayName

string

The name of the gateway.

vpnConnectionName

string

The name of the vpn connection.

options

VpnConnectionsStartPacketCaptureOptionalParams

The options parameters.

Returns

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

beginStartPacketCaptureAndWait(string, string, string, VpnConnectionsStartPacketCaptureOptionalParams)

Starts packet capture on Vpn connection in the specified resource group.

function beginStartPacketCaptureAndWait(resourceGroupName: string, gatewayName: string, vpnConnectionName: string, options?: VpnConnectionsStartPacketCaptureOptionalParams): Promise<VpnConnectionsStartPacketCaptureResponse>

Parameters

resourceGroupName

string

The name of the resource group.

gatewayName

string

The name of the gateway.

vpnConnectionName

string

The name of the vpn connection.

options

VpnConnectionsStartPacketCaptureOptionalParams

The options parameters.

Returns

Promise<VpnConnectionsStartPacketCaptureResponse>

beginStopPacketCapture(string, string, string, VpnConnectionsStopPacketCaptureOptionalParams)

Stops packet capture on Vpn connection in the specified resource group.

function beginStopPacketCapture(resourceGroupName: string, gatewayName: string, vpnConnectionName: string, options?: VpnConnectionsStopPacketCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VpnConnectionsStopPacketCaptureResponse>, VpnConnectionsStopPacketCaptureResponse>>

Parameters

resourceGroupName

string

The name of the resource group.

gatewayName

string

The name of the gateway.

vpnConnectionName

string

The name of the vpn connection.

options

VpnConnectionsStopPacketCaptureOptionalParams

The options parameters.

Returns

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

beginStopPacketCaptureAndWait(string, string, string, VpnConnectionsStopPacketCaptureOptionalParams)

Stops packet capture on Vpn connection in the specified resource group.

function beginStopPacketCaptureAndWait(resourceGroupName: string, gatewayName: string, vpnConnectionName: string, options?: VpnConnectionsStopPacketCaptureOptionalParams): Promise<VpnConnectionsStopPacketCaptureResponse>

Parameters

resourceGroupName

string

The name of the resource group.

gatewayName

string

The name of the gateway.

vpnConnectionName

string

The name of the vpn connection.

options

VpnConnectionsStopPacketCaptureOptionalParams

The options parameters.

Returns

Promise<VpnConnectionsStopPacketCaptureResponse>

get(string, string, string, VpnConnectionsGetOptionalParams)

Retrieves the details of a vpn connection.

function get(resourceGroupName: string, gatewayName: string, connectionName: string, options?: VpnConnectionsGetOptionalParams): Promise<VpnConnection>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

connectionName

string

The name of the vpn connection.

options

VpnConnectionsGetOptionalParams

The options parameters.

Returns

Promise<VpnConnection>

listByVpnGateway(string, string, VpnConnectionsListByVpnGatewayOptionalParams)

Retrieves all vpn connections for a particular virtual wan vpn gateway.

function listByVpnGateway(resourceGroupName: string, gatewayName: string, options?: VpnConnectionsListByVpnGatewayOptionalParams): PagedAsyncIterableIterator<VpnConnection, VpnConnection[], PageSettings>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

options

VpnConnectionsListByVpnGatewayOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VpnConnection, VpnConnection[], PageSettings>