Share via


VpnConnectionCollection Class

Definition

A class representing a collection of VpnConnectionResource and their operations. Each VpnConnectionResource in the collection will belong to the same instance of VpnGatewayResource. To get a VpnConnectionCollection instance call the GetVpnConnections method from an instance of VpnGatewayResource.

public class VpnConnectionCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.Network.VpnConnectionResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Network.VpnConnectionResource>
type VpnConnectionCollection = class
    inherit ArmCollection
    interface seq<VpnConnectionResource>
    interface IEnumerable
    interface IAsyncEnumerable<VpnConnectionResource>
Public Class VpnConnectionCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of VpnConnectionResource), IEnumerable(Of VpnConnectionResource)
Inheritance
VpnConnectionCollection
Implements

Constructors

VpnConnectionCollection()

Initializes a new instance of the VpnConnectionCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, VpnConnectionData, CancellationToken)

Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}
  • Operation Id: VpnConnections_CreateOrUpdate
  • Default Api Version: 2024-03-01
  • Resource: VpnConnectionResource
CreateOrUpdateAsync(WaitUntil, String, VpnConnectionData, CancellationToken)

Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}
  • Operation Id: VpnConnections_CreateOrUpdate
  • Default Api Version: 2024-03-01
  • Resource: VpnConnectionResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • 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
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • 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
Get(String, CancellationToken)

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
GetAll(CancellationToken)

Retrieves all vpn connections for a particular virtual wan vpn gateway.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections
  • Operation Id: VpnConnections_ListByVpnGateway
  • Default Api Version: 2024-03-01
  • Resource: VpnConnectionResource
GetAllAsync(CancellationToken)

Retrieves all vpn connections for a particular virtual wan vpn gateway.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections
  • Operation Id: VpnConnections_ListByVpnGateway
  • Default Api Version: 2024-03-01
  • Resource: VpnConnectionResource
GetAsync(String, CancellationToken)

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
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • 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
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • 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
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<VpnConnectionResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<VpnConnectionResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to