VpnConnectionsOperations interface

Interface representing a VpnConnections operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginStartPacketCapture
beginStartPacketCaptureAndWait
beginStopPacketCapture
beginStopPacketCaptureAndWait
createOrUpdate

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

delete

Deletes a vpn connection.

get

Retrieves the details of a vpn connection.

listByVpnGateway

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

startPacketCapture

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

stopPacketCapture

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

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginStartPacketCapture

Warning

This API is now deprecated.

use startPacketCapture instead

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

Property Value

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

beginStartPacketCaptureAndWait

Warning

This API is now deprecated.

use startPacketCapture instead

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

Property Value

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

beginStopPacketCapture

Warning

This API is now deprecated.

use stopPacketCapture instead

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

Property Value

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

beginStopPacketCaptureAndWait

Warning

This API is now deprecated.

use stopPacketCapture instead

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

Property Value

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

createOrUpdate

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

createOrUpdate: (resourceGroupName: string, gatewayName: string, connectionName: string, vpnConnectionParameters: VpnConnection, options?: VpnConnectionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<VpnConnection>, VpnConnection>

Property Value

(resourceGroupName: string, gatewayName: string, connectionName: string, vpnConnectionParameters: VpnConnection, options?: VpnConnectionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<VpnConnection>, VpnConnection>

delete

Deletes a vpn connection.

delete: (resourceGroupName: string, gatewayName: string, connectionName: string, options?: VpnConnectionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, gatewayName: string, connectionName: string, options?: VpnConnectionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Retrieves the details of a vpn connection.

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

Property Value

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

listByVpnGateway

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

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

Property Value

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

startPacketCapture

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

startPacketCapture: (resourceGroupName: string, gatewayName: string, vpnConnectionName: string, options?: VpnConnectionsStartPacketCaptureOptionalParams) => PollerLike<OperationState<VpnConnectionsStartPacketCaptureResponse>, VpnConnectionsStartPacketCaptureResponse>

Property Value

(resourceGroupName: string, gatewayName: string, vpnConnectionName: string, options?: VpnConnectionsStartPacketCaptureOptionalParams) => PollerLike<OperationState<VpnConnectionsStartPacketCaptureResponse>, VpnConnectionsStartPacketCaptureResponse>

stopPacketCapture

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

stopPacketCapture: (resourceGroupName: string, gatewayName: string, vpnConnectionName: string, options?: VpnConnectionsStopPacketCaptureOptionalParams) => PollerLike<OperationState<VpnConnectionsStopPacketCaptureResponse>, VpnConnectionsStopPacketCaptureResponse>

Property Value

(resourceGroupName: string, gatewayName: string, vpnConnectionName: string, options?: VpnConnectionsStopPacketCaptureOptionalParams) => PollerLike<OperationState<VpnConnectionsStopPacketCaptureResponse>, VpnConnectionsStopPacketCaptureResponse>