VirtualNetworkGatewayConnections interface

Package:

@azure/arm-network

Interface representing a VirtualNetworkGatewayConnections.

Methods

beginCreateOrUpdate(string, string, VirtualNetworkGatewayConnection, VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams)	Creates or updates a virtual network gateway connection in the specified resource group.
beginCreateOrUpdateAndWait(string, string, VirtualNetworkGatewayConnection, VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams)	Creates or updates a virtual network gateway connection in the specified resource group.
beginDelete(string, string, VirtualNetworkGatewayConnectionsDeleteOptionalParams)	Deletes the specified virtual network Gateway connection.
beginDeleteAndWait(string, string, VirtualNetworkGatewayConnectionsDeleteOptionalParams)	Deletes the specified virtual network Gateway connection.
beginGetIkeSas(string, string, VirtualNetworkGatewayConnectionsGetIkeSasOptionalParams)	Lists IKE Security Associations for the virtual network gateway connection in the specified resource group.
beginGetIkeSasAndWait(string, string, VirtualNetworkGatewayConnectionsGetIkeSasOptionalParams)	Lists IKE Security Associations for the virtual network gateway connection in the specified resource group.
beginResetConnection(string, string, VirtualNetworkGatewayConnectionsResetConnectionOptionalParams)	Resets the virtual network gateway connection specified.
beginResetConnectionAndWait(string, string, VirtualNetworkGatewayConnectionsResetConnectionOptionalParams)	Resets the virtual network gateway connection specified.
beginResetSharedKey(string, string, ConnectionResetSharedKey, VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams)	The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.
beginResetSharedKeyAndWait(string, string, ConnectionResetSharedKey, VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams)	The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.
beginSetSharedKey(string, string, ConnectionSharedKey, VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams)	The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.
beginSetSharedKeyAndWait(string, string, ConnectionSharedKey, VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams)	The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.
beginStartPacketCapture(string, string, VirtualNetworkGatewayConnectionsStartPacketCaptureOptionalParams)	Starts packet capture on virtual network gateway connection in the specified resource group.
beginStartPacketCaptureAndWait(string, string, VirtualNetworkGatewayConnectionsStartPacketCaptureOptionalParams)	Starts packet capture on virtual network gateway connection in the specified resource group.
beginStopPacketCapture(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewayConnectionsStopPacketCaptureOptionalParams)	Stops packet capture on virtual network gateway connection in the specified resource group.
beginStopPacketCaptureAndWait(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewayConnectionsStopPacketCaptureOptionalParams)	Stops packet capture on virtual network gateway connection in the specified resource group.
beginUpdateTags(string, string, TagsObject, VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams)	Updates a virtual network gateway connection tags.
beginUpdateTagsAndWait(string, string, TagsObject, VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams)	Updates a virtual network gateway connection tags.
get(string, string, VirtualNetworkGatewayConnectionsGetOptionalParams)	Gets the specified virtual network gateway connection by resource group.
getSharedKey(string, string, VirtualNetworkGatewayConnectionsGetSharedKeyOptionalParams)	The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.
list(string, VirtualNetworkGatewayConnectionsListOptionalParams)	The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.

Method Details

beginCreateOrUpdate(string, string, VirtualNetworkGatewayConnection, VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams)

Creates or updates a virtual network gateway connection in the specified resource group.

function beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VirtualNetworkGatewayConnection, options?: VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewayConnection>, VirtualNetworkGatewayConnection>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway connection.

parameters

VirtualNetworkGatewayConnection

Parameters supplied to the create or update virtual network gateway connection operation.

options

VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, VirtualNetworkGatewayConnection, VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams)

Creates or updates a virtual network gateway connection in the specified resource group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VirtualNetworkGatewayConnection, options?: VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams): Promise<VirtualNetworkGatewayConnection>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway connection.

parameters

VirtualNetworkGatewayConnection

Parameters supplied to the create or update virtual network gateway connection operation.

options

VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualNetworkGatewayConnection>

beginDelete(string, string, VirtualNetworkGatewayConnectionsDeleteOptionalParams)

Deletes the specified virtual network Gateway connection.

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

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway connection.

options

VirtualNetworkGatewayConnectionsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, VirtualNetworkGatewayConnectionsDeleteOptionalParams)

Deletes the specified virtual network Gateway connection.

function beginDeleteAndWait(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway connection.

options

VirtualNetworkGatewayConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginGetIkeSas(string, string, VirtualNetworkGatewayConnectionsGetIkeSasOptionalParams)

Lists IKE Security Associations for the virtual network gateway connection in the specified resource group.

function beginGetIkeSas(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsGetIkeSasOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewayConnectionsGetIkeSasResponse>, VirtualNetworkGatewayConnectionsGetIkeSasResponse>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway Connection.

options

VirtualNetworkGatewayConnectionsGetIkeSasOptionalParams

The options parameters.

Returns

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

beginGetIkeSasAndWait(string, string, VirtualNetworkGatewayConnectionsGetIkeSasOptionalParams)

Lists IKE Security Associations for the virtual network gateway connection in the specified resource group.

function beginGetIkeSasAndWait(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsGetIkeSasOptionalParams): Promise<VirtualNetworkGatewayConnectionsGetIkeSasResponse>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway Connection.

options

VirtualNetworkGatewayConnectionsGetIkeSasOptionalParams

The options parameters.

Returns

Promise<VirtualNetworkGatewayConnectionsGetIkeSasResponse>

beginResetConnection(string, string, VirtualNetworkGatewayConnectionsResetConnectionOptionalParams)

Resets the virtual network gateway connection specified.

function beginResetConnection(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsResetConnectionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway Connection.

options

VirtualNetworkGatewayConnectionsResetConnectionOptionalParams

The options parameters.

Returns

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

beginResetConnectionAndWait(string, string, VirtualNetworkGatewayConnectionsResetConnectionOptionalParams)

Resets the virtual network gateway connection specified.

function beginResetConnectionAndWait(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsResetConnectionOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway Connection.

options

VirtualNetworkGatewayConnectionsResetConnectionOptionalParams

The options parameters.

Returns

Promise<void>

beginResetSharedKey(string, string, ConnectionResetSharedKey, VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams)

The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

function beginResetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: ConnectionResetSharedKey, options?: VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams): Promise<SimplePollerLike<OperationState<ConnectionResetSharedKey>, ConnectionResetSharedKey>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The virtual network gateway connection reset shared key Name.

parameters

ConnectionResetSharedKey

Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider.

options

VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams

The options parameters.

Returns

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

beginResetSharedKeyAndWait(string, string, ConnectionResetSharedKey, VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams)

The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

function beginResetSharedKeyAndWait(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: ConnectionResetSharedKey, options?: VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams): Promise<ConnectionResetSharedKey>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The virtual network gateway connection reset shared key Name.

parameters

ConnectionResetSharedKey

Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider.

options

VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams

The options parameters.

Returns

Promise<ConnectionResetSharedKey>

beginSetSharedKey(string, string, ConnectionSharedKey, VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams)

The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

function beginSetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: ConnectionSharedKey, options?: VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams): Promise<SimplePollerLike<OperationState<ConnectionSharedKey>, ConnectionSharedKey>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The virtual network gateway connection name.

parameters

ConnectionSharedKey

Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider.

options

VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams

The options parameters.

Returns

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

beginSetSharedKeyAndWait(string, string, ConnectionSharedKey, VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams)

The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

function beginSetSharedKeyAndWait(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: ConnectionSharedKey, options?: VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams): Promise<ConnectionSharedKey>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The virtual network gateway connection name.

parameters

ConnectionSharedKey

Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider.

options

VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams

The options parameters.

Returns

Promise<ConnectionSharedKey>

beginStartPacketCapture(string, string, VirtualNetworkGatewayConnectionsStartPacketCaptureOptionalParams)

Starts packet capture on virtual network gateway connection in the specified resource group.

function beginStartPacketCapture(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsStartPacketCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewayConnectionsStartPacketCaptureResponse>, VirtualNetworkGatewayConnectionsStartPacketCaptureResponse>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway connection.

options

VirtualNetworkGatewayConnectionsStartPacketCaptureOptionalParams

The options parameters.

Returns

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

beginStartPacketCaptureAndWait(string, string, VirtualNetworkGatewayConnectionsStartPacketCaptureOptionalParams)

Starts packet capture on virtual network gateway connection in the specified resource group.

function beginStartPacketCaptureAndWait(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsStartPacketCaptureOptionalParams): Promise<VirtualNetworkGatewayConnectionsStartPacketCaptureResponse>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway connection.

options

VirtualNetworkGatewayConnectionsStartPacketCaptureOptionalParams

The options parameters.

Returns

Promise<VirtualNetworkGatewayConnectionsStartPacketCaptureResponse>

beginStopPacketCapture(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewayConnectionsStopPacketCaptureOptionalParams)

Stops packet capture on virtual network gateway connection in the specified resource group.

function beginStopPacketCapture(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewayConnectionsStopPacketCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewayConnectionsStopPacketCaptureResponse>, VirtualNetworkGatewayConnectionsStopPacketCaptureResponse>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway Connection.

parameters

VpnPacketCaptureStopParameters

Virtual network gateway packet capture parameters supplied to stop packet capture on gateway connection.

options

VirtualNetworkGatewayConnectionsStopPacketCaptureOptionalParams

The options parameters.

Returns

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

beginStopPacketCaptureAndWait(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewayConnectionsStopPacketCaptureOptionalParams)

Stops packet capture on virtual network gateway connection in the specified resource group.

function beginStopPacketCaptureAndWait(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewayConnectionsStopPacketCaptureOptionalParams): Promise<VirtualNetworkGatewayConnectionsStopPacketCaptureResponse>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway Connection.

parameters

VpnPacketCaptureStopParameters

Virtual network gateway packet capture parameters supplied to stop packet capture on gateway connection.

options

VirtualNetworkGatewayConnectionsStopPacketCaptureOptionalParams

The options parameters.

Returns

Promise<VirtualNetworkGatewayConnectionsStopPacketCaptureResponse>

beginUpdateTags(string, string, TagsObject, VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams)

Updates a virtual network gateway connection tags.

function beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: TagsObject, options?: VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewayConnection>, VirtualNetworkGatewayConnection>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway connection.

parameters

TagsObject

Parameters supplied to update virtual network gateway connection tags.

options

VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams

The options parameters.

Returns

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

beginUpdateTagsAndWait(string, string, TagsObject, VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams)

Updates a virtual network gateway connection tags.

function beginUpdateTagsAndWait(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: TagsObject, options?: VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams): Promise<VirtualNetworkGatewayConnection>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway connection.

parameters

TagsObject

Parameters supplied to update virtual network gateway connection tags.

options

VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams

The options parameters.

Returns

Promise<VirtualNetworkGatewayConnection>

get(string, string, VirtualNetworkGatewayConnectionsGetOptionalParams)

Gets the specified virtual network gateway connection by resource group.

function get(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsGetOptionalParams): Promise<VirtualNetworkGatewayConnection>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway connection.

options

VirtualNetworkGatewayConnectionsGetOptionalParams

The options parameters.

Returns

Promise<VirtualNetworkGatewayConnection>

getSharedKey(string, string, VirtualNetworkGatewayConnectionsGetSharedKeyOptionalParams)

The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.

function getSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsGetSharedKeyOptionalParams): Promise<ConnectionSharedKey>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The virtual network gateway connection shared key name.

options

VirtualNetworkGatewayConnectionsGetSharedKeyOptionalParams

The options parameters.

Returns

Promise<ConnectionSharedKey>

list(string, VirtualNetworkGatewayConnectionsListOptionalParams)

The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.

function list(resourceGroupName: string, options?: VirtualNetworkGatewayConnectionsListOptionalParams): PagedAsyncIterableIterator<VirtualNetworkGatewayConnection, VirtualNetworkGatewayConnection[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options

VirtualNetworkGatewayConnectionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualNetworkGatewayConnection, VirtualNetworkGatewayConnection[], PageSettings>