VpnLinkConnectionsOperations interface

Package:
@azure/arm-network

Interface representing a VpnLinkConnections operations.

Properties

beginGetIkeSas
beginGetIkeSasAndWait
beginResetConnection
beginResetConnectionAndWait
beginSetOrInitDefaultSharedKey
beginSetOrInitDefaultSharedKeyAndWait
getDefaultSharedKey

Gets the shared key of VpnLink connection specified.
getIkeSas

Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group.
listAllSharedKeys

Lists all shared keys of VpnLink connection specified.
listByVpnConnection

Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.
listDefaultSharedKey

Gets the value of the shared key of VpnLink connection specified.
resetConnection

Resets the VpnLink connection specified.
setOrInitDefaultSharedKey

Sets or auto generates the shared key based on the user input. If users give a shared key value, it does the set operation. If key length is given, the operation creates a random key of the pre-defined length.

Property Details

beginGetIkeSas

Warning

This API is now deprecated.

use getIkeSas instead

beginGetIkeSas: (resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsGetIkeSasOptionalParams) => Promise<SimplePollerLike<OperationState<VpnLinkConnectionsGetIkeSasResponse>, VpnLinkConnectionsGetIkeSasResponse>>

Property Value

(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsGetIkeSasOptionalParams) => Promise<SimplePollerLike<OperationState<VpnLinkConnectionsGetIkeSasResponse>, VpnLinkConnectionsGetIkeSasResponse>>

beginGetIkeSasAndWait

Warning

This API is now deprecated.

use getIkeSas instead

beginGetIkeSasAndWait: (resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsGetIkeSasOptionalParams) => Promise<VpnLinkConnectionsGetIkeSasResponse>

Property Value

(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsGetIkeSasOptionalParams) => Promise<VpnLinkConnectionsGetIkeSasResponse>

beginResetConnection

Warning

This API is now deprecated.

use resetConnection instead

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

Property Value

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

beginResetConnectionAndWait

Warning

This API is now deprecated.

use resetConnection instead

beginResetConnectionAndWait: (resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsResetConnectionOptionalParams) => Promise<void>

Property Value

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

beginSetOrInitDefaultSharedKey

Warning

This API is now deprecated.

use setOrInitDefaultSharedKey instead

beginSetOrInitDefaultSharedKey: (resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, connectionSharedKeyParameters: ConnectionSharedKeyResult, options?: VpnLinkConnectionsSetOrInitDefaultSharedKeyOptionalParams) => Promise<SimplePollerLike<OperationState<ConnectionSharedKeyResult>, ConnectionSharedKeyResult>>

Property Value

(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, connectionSharedKeyParameters: ConnectionSharedKeyResult, options?: VpnLinkConnectionsSetOrInitDefaultSharedKeyOptionalParams) => Promise<SimplePollerLike<OperationState<ConnectionSharedKeyResult>, ConnectionSharedKeyResult>>

beginSetOrInitDefaultSharedKeyAndWait

Warning

This API is now deprecated.

use setOrInitDefaultSharedKey instead

beginSetOrInitDefaultSharedKeyAndWait: (resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, connectionSharedKeyParameters: ConnectionSharedKeyResult, options?: VpnLinkConnectionsSetOrInitDefaultSharedKeyOptionalParams) => Promise<ConnectionSharedKeyResult>

Property Value

(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, connectionSharedKeyParameters: ConnectionSharedKeyResult, options?: VpnLinkConnectionsSetOrInitDefaultSharedKeyOptionalParams) => Promise<ConnectionSharedKeyResult>

getDefaultSharedKey

Gets the shared key of VpnLink connection specified.

getDefaultSharedKey: (resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsGetDefaultSharedKeyOptionalParams) => Promise<ConnectionSharedKeyResult>

Property Value

(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsGetDefaultSharedKeyOptionalParams) => Promise<ConnectionSharedKeyResult>

getIkeSas

Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group.

getIkeSas: (resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsGetIkeSasOptionalParams) => PollerLike<OperationState<VpnLinkConnectionsGetIkeSasResponse>, VpnLinkConnectionsGetIkeSasResponse>

Property Value

(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsGetIkeSasOptionalParams) => PollerLike<OperationState<VpnLinkConnectionsGetIkeSasResponse>, VpnLinkConnectionsGetIkeSasResponse>

listAllSharedKeys

Lists all shared keys of VpnLink connection specified.

listAllSharedKeys: (resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsListAllSharedKeysOptionalParams) => PagedAsyncIterableIterator<ConnectionSharedKeyResult, ConnectionSharedKeyResult[], PageSettings>

Property Value

(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsListAllSharedKeysOptionalParams) => PagedAsyncIterableIterator<ConnectionSharedKeyResult, ConnectionSharedKeyResult[], PageSettings>

listByVpnConnection

Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.

listByVpnConnection: (resourceGroupName: string, gatewayName: string, connectionName: string, options?: VpnLinkConnectionsListByVpnConnectionOptionalParams) => PagedAsyncIterableIterator<VpnSiteLinkConnection, VpnSiteLinkConnection[], PageSettings>

Property Value

(resourceGroupName: string, gatewayName: string, connectionName: string, options?: VpnLinkConnectionsListByVpnConnectionOptionalParams) => PagedAsyncIterableIterator<VpnSiteLinkConnection, VpnSiteLinkConnection[], PageSettings>

listDefaultSharedKey

Gets the value of the shared key of VpnLink connection specified.

listDefaultSharedKey: (resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsListDefaultSharedKeyOptionalParams) => Promise<ConnectionSharedKeyResult>

Property Value

(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsListDefaultSharedKeyOptionalParams) => Promise<ConnectionSharedKeyResult>

resetConnection

Resets the VpnLink connection specified.

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

Property Value

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

setOrInitDefaultSharedKey

Sets or auto generates the shared key based on the user input. If users give a shared key value, it does the set operation. If key length is given, the operation creates a random key of the pre-defined length.

setOrInitDefaultSharedKey: (resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, connectionSharedKeyParameters: ConnectionSharedKeyResult, options?: VpnLinkConnectionsSetOrInitDefaultSharedKeyOptionalParams) => PollerLike<OperationState<ConnectionSharedKeyResult>, ConnectionSharedKeyResult>

Property Value

(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, connectionSharedKeyParameters: ConnectionSharedKeyResult, options?: VpnLinkConnectionsSetOrInitDefaultSharedKeyOptionalParams) => PollerLike<OperationState<ConnectionSharedKeyResult>, ConnectionSharedKeyResult>