VpnGatewayCollection.GetIfExistsAsync(String, CancellationToken) Method

Definition

Tries to get details for this resource from the service.

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

Parameters

gatewayName
String

The name of the gateway.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

gatewayName is null.

Applies to