VpnGateways interface

Package:

@azure/arm-network

Interface representing a VpnGateways.

Methods

beginCreateOrUpdate(string, string, VpnGateway, VpnGatewaysCreateOrUpdateOptionalParams)	Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.
beginCreateOrUpdateAndWait(string, string, VpnGateway, VpnGatewaysCreateOrUpdateOptionalParams)	Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.
beginDelete(string, string, VpnGatewaysDeleteOptionalParams)	Deletes a virtual wan vpn gateway.
beginDeleteAndWait(string, string, VpnGatewaysDeleteOptionalParams)	Deletes a virtual wan vpn gateway.
beginReset(string, string, VpnGatewaysResetOptionalParams)	Resets the primary of the vpn gateway in the specified resource group.
beginResetAndWait(string, string, VpnGatewaysResetOptionalParams)	Resets the primary of the vpn gateway in the specified resource group.
beginStartPacketCapture(string, string, VpnGatewaysStartPacketCaptureOptionalParams)	Starts packet capture on vpn gateway in the specified resource group.
beginStartPacketCaptureAndWait(string, string, VpnGatewaysStartPacketCaptureOptionalParams)	Starts packet capture on vpn gateway in the specified resource group.
beginStopPacketCapture(string, string, VpnGatewaysStopPacketCaptureOptionalParams)	Stops packet capture on vpn gateway in the specified resource group.
beginStopPacketCaptureAndWait(string, string, VpnGatewaysStopPacketCaptureOptionalParams)	Stops packet capture on vpn gateway in the specified resource group.
beginUpdateTags(string, string, TagsObject, VpnGatewaysUpdateTagsOptionalParams)	Updates virtual wan vpn gateway tags.
beginUpdateTagsAndWait(string, string, TagsObject, VpnGatewaysUpdateTagsOptionalParams)	Updates virtual wan vpn gateway tags.
get(string, string, VpnGatewaysGetOptionalParams)	Retrieves the details of a virtual wan vpn gateway.
list(VpnGatewaysListOptionalParams)	Lists all the VpnGateways in a subscription.
listByResourceGroup(string, VpnGatewaysListByResourceGroupOptionalParams)	Lists all the VpnGateways in a resource group.

Method Details

beginCreateOrUpdate(string, string, VpnGateway, VpnGatewaysCreateOrUpdateOptionalParams)

Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.

function beginCreateOrUpdate(resourceGroupName: string, gatewayName: string, vpnGatewayParameters: VpnGateway, options?: VpnGatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VpnGateway>, VpnGateway>>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

vpnGatewayParameters

VpnGateway

Parameters supplied to create or Update a virtual wan vpn gateway.

options

VpnGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, VpnGateway, VpnGatewaysCreateOrUpdateOptionalParams)

Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.

function beginCreateOrUpdateAndWait(resourceGroupName: string, gatewayName: string, vpnGatewayParameters: VpnGateway, options?: VpnGatewaysCreateOrUpdateOptionalParams): Promise<VpnGateway>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

vpnGatewayParameters

VpnGateway

Parameters supplied to create or Update a virtual wan vpn gateway.

options

VpnGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VpnGateway>

beginDelete(string, string, VpnGatewaysDeleteOptionalParams)

Deletes a virtual wan vpn gateway.

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

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

options

VpnGatewaysDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, VpnGatewaysDeleteOptionalParams)

Deletes a virtual wan vpn gateway.

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

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

options

VpnGatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginReset(string, string, VpnGatewaysResetOptionalParams)

Resets the primary of the vpn gateway in the specified resource group.

function beginReset(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysResetOptionalParams): Promise<SimplePollerLike<OperationState<VpnGateway>, VpnGateway>>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

options

VpnGatewaysResetOptionalParams

The options parameters.

Returns

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

beginResetAndWait(string, string, VpnGatewaysResetOptionalParams)

Resets the primary of the vpn gateway in the specified resource group.

function beginResetAndWait(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysResetOptionalParams): Promise<VpnGateway>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

options

VpnGatewaysResetOptionalParams

The options parameters.

Returns

Promise<VpnGateway>

beginStartPacketCapture(string, string, VpnGatewaysStartPacketCaptureOptionalParams)

Starts packet capture on vpn gateway in the specified resource group.

function beginStartPacketCapture(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStartPacketCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VpnGatewaysStartPacketCaptureResponse>, VpnGatewaysStartPacketCaptureResponse>>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

options

VpnGatewaysStartPacketCaptureOptionalParams

The options parameters.

Returns

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

beginStartPacketCaptureAndWait(string, string, VpnGatewaysStartPacketCaptureOptionalParams)

Starts packet capture on vpn gateway in the specified resource group.

function beginStartPacketCaptureAndWait(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStartPacketCaptureOptionalParams): Promise<VpnGatewaysStartPacketCaptureResponse>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

options

VpnGatewaysStartPacketCaptureOptionalParams

The options parameters.

Returns

Promise<VpnGatewaysStartPacketCaptureResponse>

beginStopPacketCapture(string, string, VpnGatewaysStopPacketCaptureOptionalParams)

Stops packet capture on vpn gateway in the specified resource group.

function beginStopPacketCapture(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStopPacketCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VpnGatewaysStopPacketCaptureResponse>, VpnGatewaysStopPacketCaptureResponse>>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

options

VpnGatewaysStopPacketCaptureOptionalParams

The options parameters.

Returns

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

beginStopPacketCaptureAndWait(string, string, VpnGatewaysStopPacketCaptureOptionalParams)

Stops packet capture on vpn gateway in the specified resource group.

function beginStopPacketCaptureAndWait(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStopPacketCaptureOptionalParams): Promise<VpnGatewaysStopPacketCaptureResponse>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

options

VpnGatewaysStopPacketCaptureOptionalParams

The options parameters.

Returns

Promise<VpnGatewaysStopPacketCaptureResponse>

beginUpdateTags(string, string, TagsObject, VpnGatewaysUpdateTagsOptionalParams)

Updates virtual wan vpn gateway tags.

function beginUpdateTags(resourceGroupName: string, gatewayName: string, vpnGatewayParameters: TagsObject, options?: VpnGatewaysUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<VpnGateway>, VpnGateway>>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

vpnGatewayParameters

TagsObject

Parameters supplied to update a virtual wan vpn gateway tags.

options

VpnGatewaysUpdateTagsOptionalParams

The options parameters.

Returns

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

beginUpdateTagsAndWait(string, string, TagsObject, VpnGatewaysUpdateTagsOptionalParams)

Updates virtual wan vpn gateway tags.

function beginUpdateTagsAndWait(resourceGroupName: string, gatewayName: string, vpnGatewayParameters: TagsObject, options?: VpnGatewaysUpdateTagsOptionalParams): Promise<VpnGateway>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

vpnGatewayParameters

TagsObject

Parameters supplied to update a virtual wan vpn gateway tags.

options

VpnGatewaysUpdateTagsOptionalParams

The options parameters.

Returns

Promise<VpnGateway>

get(string, string, VpnGatewaysGetOptionalParams)

Retrieves the details of a virtual wan vpn gateway.

function get(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysGetOptionalParams): Promise<VpnGateway>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

options

VpnGatewaysGetOptionalParams

The options parameters.

Returns

Promise<VpnGateway>

list(VpnGatewaysListOptionalParams)

Lists all the VpnGateways in a subscription.

function list(options?: VpnGatewaysListOptionalParams): PagedAsyncIterableIterator<VpnGateway, VpnGateway[], PageSettings>

Parameters

options

VpnGatewaysListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VpnGateway, VpnGateway[], PageSettings>

listByResourceGroup(string, VpnGatewaysListByResourceGroupOptionalParams)

Lists all the VpnGateways in a resource group.

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

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

options

VpnGatewaysListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VpnGateway, VpnGateway[], PageSettings>