VpnGatewayCollection Class

Definition

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

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

Constructors

VpnGatewayCollection()

Initializes a new instance of the VpnGatewayCollection 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, VpnGatewayData, CancellationToken)

Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.

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

Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.

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

Checks to see if the resource exists in azure.

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

Checks to see if the resource exists in azure.

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

Retrieves the details of a virtual wan vpn gateway.

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

Lists all the VpnGateways in a resource group.

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

Lists all the VpnGateways in a resource group.

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

Retrieves the details of a virtual wan vpn gateway.

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

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

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
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<VpnGatewayResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<VpnGatewayResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to