VirtualNetworkGatewayConnectionsOperations interface

Package:
@azure/arm-network

Interface representing a VirtualNetworkGatewayConnections operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginGetIkeSas
beginGetIkeSasAndWait
beginResetConnection
beginResetConnectionAndWait
beginResetSharedKey
beginResetSharedKeyAndWait
beginSetSharedKey
beginSetSharedKeyAndWait
beginStartPacketCapture
beginStartPacketCaptureAndWait
beginStopPacketCapture
beginStopPacketCaptureAndWait
beginUpdateTags
beginUpdateTagsAndWait
createOrUpdate

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

Deletes the specified virtual network Gateway connection.
get

Gets the specified virtual network gateway connection by resource group.
getIkeSas

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

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

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

Resets the virtual network gateway connection specified.
resetSharedKey

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.
setSharedKey

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.
startPacketCapture

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

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

Updates a virtual network gateway connection tags.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginGetIkeSas

Warning

This API is now deprecated.

use getIkeSas instead

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

Property Value

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

beginGetIkeSasAndWait

Warning

This API is now deprecated.

use getIkeSas instead

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

Property Value

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

beginResetConnection

Warning

This API is now deprecated.

use resetConnection instead

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

Property Value

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

beginResetConnectionAndWait

Warning

This API is now deprecated.

use resetConnection instead

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

Property Value

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

beginResetSharedKey

Warning

This API is now deprecated.

use resetSharedKey instead

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

Property Value

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

beginResetSharedKeyAndWait

Warning

This API is now deprecated.

use resetSharedKey instead

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

Property Value

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

beginSetSharedKey

Warning

This API is now deprecated.

use setSharedKey instead

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

Property Value

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

beginSetSharedKeyAndWait

Warning

This API is now deprecated.

use setSharedKey instead

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

Property Value

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

beginStartPacketCapture

Warning

This API is now deprecated.

use startPacketCapture instead

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

Property Value

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

beginStartPacketCaptureAndWait

Warning

This API is now deprecated.

use startPacketCapture instead

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

Property Value

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

beginStopPacketCapture

Warning

This API is now deprecated.

use stopPacketCapture instead

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

Property Value

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

beginStopPacketCaptureAndWait

Warning

This API is now deprecated.

use stopPacketCapture instead

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

Property Value

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

beginUpdateTags

Warning

This API is now deprecated.

use updateTags instead

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

Property Value

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

beginUpdateTagsAndWait

Warning

This API is now deprecated.

use updateTags instead

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

Property Value

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

createOrUpdate

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

createOrUpdate: (resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VirtualNetworkGatewayConnection, options?: VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewayConnection>, VirtualNetworkGatewayConnection>

Property Value

(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VirtualNetworkGatewayConnection, options?: VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewayConnection>, VirtualNetworkGatewayConnection>

delete

Deletes the specified virtual network Gateway connection.

delete: (resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the specified virtual network gateway connection by resource group.

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

Property Value

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

getIkeSas

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

getIkeSas: (resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsGetIkeSasOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewayConnectionsGetIkeSasResponse>, VirtualNetworkGatewayConnectionsGetIkeSasResponse>

Property Value

(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsGetIkeSasOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewayConnectionsGetIkeSasResponse>, VirtualNetworkGatewayConnectionsGetIkeSasResponse>

getSharedKey

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

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

Property Value

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

list

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

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

Property Value

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

resetConnection

Resets the virtual network gateway connection specified.

resetConnection: (resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsResetConnectionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsResetConnectionOptionalParams) => PollerLike<OperationState<void>, void>

resetSharedKey

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.

resetSharedKey: (resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: ConnectionResetSharedKey, options?: VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams) => PollerLike<OperationState<ConnectionResetSharedKey>, ConnectionResetSharedKey>

Property Value

(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: ConnectionResetSharedKey, options?: VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams) => PollerLike<OperationState<ConnectionResetSharedKey>, ConnectionResetSharedKey>

setSharedKey

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.

setSharedKey: (resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: ConnectionSharedKey, options?: VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams) => PollerLike<OperationState<ConnectionSharedKey>, ConnectionSharedKey>

Property Value

(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: ConnectionSharedKey, options?: VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams) => PollerLike<OperationState<ConnectionSharedKey>, ConnectionSharedKey>

startPacketCapture

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

startPacketCapture: (resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsStartPacketCaptureOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewayConnectionsStartPacketCaptureResponse>, VirtualNetworkGatewayConnectionsStartPacketCaptureResponse>

Property Value

(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: VirtualNetworkGatewayConnectionsStartPacketCaptureOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewayConnectionsStartPacketCaptureResponse>, VirtualNetworkGatewayConnectionsStartPacketCaptureResponse>

stopPacketCapture

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

stopPacketCapture: (resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewayConnectionsStopPacketCaptureOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewayConnectionsStopPacketCaptureResponse>, VirtualNetworkGatewayConnectionsStopPacketCaptureResponse>

Property Value

(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewayConnectionsStopPacketCaptureOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewayConnectionsStopPacketCaptureResponse>, VirtualNetworkGatewayConnectionsStopPacketCaptureResponse>

updateTags

Updates a virtual network gateway connection tags.

updateTags: (resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: TagsObject, options?: VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewayConnection>, VirtualNetworkGatewayConnection>

Property Value

(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: TagsObject, options?: VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewayConnection>, VirtualNetworkGatewayConnection>