VpnLinkConnections interface
Interface representing a VpnLinkConnections.
Methods
Method Details
beginGetIkeSas(string, string, string, string, VpnLinkConnectionsGetIkeSasOptionalParams)
Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group.
function beginGetIkeSas(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsGetIkeSasOptionalParams): Promise<SimplePollerLike<OperationState<VpnLinkConnectionsGetIkeSasResponse>, VpnLinkConnectionsGetIkeSasResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the gateway.
- connectionName
-
string
The name of the vpn connection.
- linkConnectionName
-
string
The name of the vpn link connection.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<VpnLinkConnectionsGetIkeSasResponse>, VpnLinkConnectionsGetIkeSasResponse>>
beginGetIkeSasAndWait(string, string, string, string, VpnLinkConnectionsGetIkeSasOptionalParams)
Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group.
function beginGetIkeSasAndWait(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsGetIkeSasOptionalParams): Promise<VpnLinkConnectionsGetIkeSasResponse>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the gateway.
- connectionName
-
string
The name of the vpn connection.
- linkConnectionName
-
string
The name of the vpn link connection.
The options parameters.
Returns
Promise<VpnLinkConnectionsGetIkeSasResponse>
beginResetConnection(string, string, string, string, VpnLinkConnectionsResetConnectionOptionalParams)
Resets the VpnLink connection specified.
function beginResetConnection(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsResetConnectionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the gateway.
- connectionName
-
string
The name of the vpn connection.
- linkConnectionName
-
string
The name of the vpn link connection.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginResetConnectionAndWait(string, string, string, string, VpnLinkConnectionsResetConnectionOptionalParams)
Resets the VpnLink connection specified.
function beginResetConnectionAndWait(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsResetConnectionOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the gateway.
- connectionName
-
string
The name of the vpn connection.
- linkConnectionName
-
string
The name of the vpn link connection.
The options parameters.
Returns
Promise<void>
beginSetOrInitDefaultSharedKey(string, string, string, string, ConnectionSharedKeyResult, VpnLinkConnectionsSetOrInitDefaultSharedKeyOptionalParams)
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.
function beginSetOrInitDefaultSharedKey(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, connectionSharedKeyParameters: ConnectionSharedKeyResult, options?: VpnLinkConnectionsSetOrInitDefaultSharedKeyOptionalParams): Promise<SimplePollerLike<OperationState<ConnectionSharedKeyResult>, ConnectionSharedKeyResult>>Parameters
- resourceGroupName
-
string
The resource group name of the VpnGateway.
- gatewayName
-
string
The name of the gateway.
- connectionName
-
string
The name of the connection.
- linkConnectionName
-
string
The name of the vpn link connection.
- connectionSharedKeyParameters
- ConnectionSharedKeyResult
Parameters supplied to set or auto generate the shared key for the vpn link connection.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ConnectionSharedKeyResult>, ConnectionSharedKeyResult>>
beginSetOrInitDefaultSharedKeyAndWait(string, string, string, string, ConnectionSharedKeyResult, VpnLinkConnectionsSetOrInitDefaultSharedKeyOptionalParams)
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.
function beginSetOrInitDefaultSharedKeyAndWait(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, connectionSharedKeyParameters: ConnectionSharedKeyResult, options?: VpnLinkConnectionsSetOrInitDefaultSharedKeyOptionalParams): Promise<ConnectionSharedKeyResult>Parameters
- resourceGroupName
-
string
The resource group name of the VpnGateway.
- gatewayName
-
string
The name of the gateway.
- connectionName
-
string
The name of the connection.
- linkConnectionName
-
string
The name of the vpn link connection.
- connectionSharedKeyParameters
- ConnectionSharedKeyResult
Parameters supplied to set or auto generate the shared key for the vpn link connection.
The options parameters.
Returns
Promise<ConnectionSharedKeyResult>
getDefaultSharedKey(string, string, string, string, VpnLinkConnectionsGetDefaultSharedKeyOptionalParams)
Gets the shared key of VpnLink connection specified.
function getDefaultSharedKey(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsGetDefaultSharedKeyOptionalParams): Promise<ConnectionSharedKeyResult>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the gateway.
- connectionName
-
string
The name of the vpn connection.
- linkConnectionName
-
string
The name of the vpn link connection.
The options parameters.
Returns
Promise<ConnectionSharedKeyResult>
listAllSharedKeys(string, string, string, string, VpnLinkConnectionsGetAllSharedKeysOptionalParams)
Lists all shared keys of VpnLink connection specified.
function listAllSharedKeys(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsGetAllSharedKeysOptionalParams): PagedAsyncIterableIterator<ConnectionSharedKeyResult, ConnectionSharedKeyResult[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the gateway.
- connectionName
-
string
The name of the vpn connection.
- linkConnectionName
-
string
The name of the vpn link connection.
The options parameters.
Returns
listByVpnConnection(string, string, string, VpnLinkConnectionsListByVpnConnectionOptionalParams)
Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.
function listByVpnConnection(resourceGroupName: string, gatewayName: string, connectionName: string, options?: VpnLinkConnectionsListByVpnConnectionOptionalParams): PagedAsyncIterableIterator<VpnSiteLinkConnection, VpnSiteLinkConnection[], PageSettings>Parameters
- resourceGroupName
-
string
The resource group name of the vpn gateway.
- gatewayName
-
string
The name of the gateway.
- connectionName
-
string
The name of the vpn connection.
The options parameters.
Returns
listDefaultSharedKey(string, string, string, string, VpnLinkConnectionsListDefaultSharedKeyOptionalParams)
Gets the value of the shared key of VpnLink connection specified.
function listDefaultSharedKey(resourceGroupName: string, gatewayName: string, connectionName: string, linkConnectionName: string, options?: VpnLinkConnectionsListDefaultSharedKeyOptionalParams): Promise<ConnectionSharedKeyResult>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the gateway.
- connectionName
-
string
The name of the vpn connection.
- linkConnectionName
-
string
The name of the vpn link connection.
The options parameters.
Returns
Promise<ConnectionSharedKeyResult>