VpnGatewayResource.GetVpnConnectionAsync(String, CancellationToken) Method

Definition

Retrieves the details of a vpn connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}
  • Operation Id: VpnConnections_Get
  • Default Api Version: 2024-03-01
  • Resource: VpnConnectionResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VpnConnectionResource>> GetVpnConnectionAsync (string connectionName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetVpnConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VpnConnectionResource>>
override this.GetVpnConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VpnConnectionResource>>
Public Overridable Function GetVpnConnectionAsync (connectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VpnConnectionResource))

Parameters

connectionName
String

The name of the vpn connection.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

connectionName is null.

connectionName is an empty string, and was expected to be non-empty.

Applies to