# VpnConnectionProxy

- Module: [Aspire.Hosting.Azure.Provisioning.Network](/reference/api/typescript/aspire.hosting.azure.provisioning.network.md)
- Version: `13.6.0-preview.1.26478.8`
- Kind: `handle`
- Source: [GitHub](https://github.com/microsoft/aspire/tree/f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62)

Represents the VpnConnection Azure Provisioning model.

## Definition

```typescript
interface VpnConnectionProxy {
  connectionBandwidth: BicepValueProxy | number;
  readonly connectionStatus: BicepValueProxy | VpnConnectionStatus;
  dpdTimeoutSeconds: BicepValueProxy | number;
  readonly egressBytesTransferred: BicepValueProxy | number;
  enableBgp: BicepValueProxy | boolean;
  enableInternetSecurity: BicepValueProxy | boolean;
  enableRateLimiting: BicepValueProxy | boolean;
  readonly eTag: BicepValueProxy;
  readonly id: BicepValueProxy;
  readonly ingressBytesTransferred: BicepValueProxy | number;
  iPsecPolicies: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfIPsecPolicyProxy;
  name: BicepValueProxy | string;
  parent: VpnGatewayProxy;
  readonly provisioningState: BicepValueProxy | NetworkProvisioningState;
  remoteVpnSiteId: BicepValueProxy;
  routingConfiguration: RoutingConfigurationProxy;
  routingWeight: BicepValueProxy | number;
  sharedKey: BicepValueProxy | string;
  trafficSelectorPolicies: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfTrafficSelectorPolicyProxy;
  useLocalAzureIPAddress: BicepValueProxy | boolean;
  usePolicyBasedTrafficSelectors: BicepValueProxy | boolean;
  vpnConnectionProtocolType: BicepValueProxy | VirtualNetworkGatewayConnectionProtocol;
  vpnLinkConnections: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfVpnSiteLinkConnectionDataProxy;
  addTo(infrastructure: AzureResourceInfrastructure): void;
  clearConnectionBandwidth(): void;
  clearDpdTimeoutSeconds(): void;
  clearEnableBgp(): void;
  clearEnableInternetSecurity(): void;
  clearEnableRateLimiting(): void;
  clearName(): void;
  clearRemoteVpnSiteId(): void;
  clearRoutingWeight(): void;
  clearSharedKey(): void;
  clearUseLocalAzureIPAddress(): void;
  clearUsePolicyBasedTrafficSelectors(): void;
  clearVpnConnectionProtocolType(): void;
}
```

## Properties

- `connectionBandwidth`: `BicepValueProxy | number` `get - set` -- Gets or sets the ConnectionBandwidth provisioning property.
- `connectionStatus`: `BicepValueProxy | VpnConnectionStatus` `get` -- Gets the ConnectionStatus provisioning property.
- `dpdTimeoutSeconds`: `BicepValueProxy | number` `get - set` -- Gets or sets the DpdTimeoutSeconds provisioning property.
- `egressBytesTransferred`: `BicepValueProxy | number` `get` -- Gets the EgressBytesTransferred provisioning property.
- `enableBgp`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the EnableBgp provisioning property.
- `enableInternetSecurity`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the EnableInternetSecurity provisioning property.
- `enableRateLimiting`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the EnableRateLimiting provisioning property.
- `eTag`: `BicepValueProxy` `get` -- Gets the ETag provisioning property.
- `id`: `BicepValueProxy` `get` -- Gets the Id provisioning property.
- `ingressBytesTransferred`: `BicepValueProxy | number` `get` -- Gets the IngressBytesTransferred provisioning property.
- `iPsecPolicies`: [Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfIPsecPolicyProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/aspire-hosting-azure-provisioning-network-generated-listofipsecpolicyproxy.md) `get - set` -- Gets or sets the IPsecPolicies provisioning property.
- `name`: `BicepValueProxy | string` `get - set` -- Gets or sets the Name provisioning property.
- `parent`: [VpnGatewayProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpngatewayproxy.md) `get - set` -- Gets or sets the Parent provisioning property.
- `provisioningState`: `BicepValueProxy | NetworkProvisioningState` `get` -- Gets the ProvisioningState provisioning property.
- `remoteVpnSiteId`: `BicepValueProxy` `get - set` -- Gets or sets the RemoteVpnSiteId provisioning property.
- `routingConfiguration`: [RoutingConfigurationProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/routingconfigurationproxy.md) `get - set` -- Gets or sets the RoutingConfiguration provisioning property.
- `routingWeight`: `BicepValueProxy | number` `get - set` -- Gets or sets the RoutingWeight provisioning property.
- `sharedKey`: `BicepValueProxy | string` `get - set` -- Gets or sets the SharedKey provisioning property.
- `trafficSelectorPolicies`: [Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfTrafficSelectorPolicyProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/aspire-hosting-azure-provisioning-network-generated-listoftrafficselectorpolicyproxy.md) `get - set` -- Gets or sets the TrafficSelectorPolicies provisioning property.
- `useLocalAzureIPAddress`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the UseLocalAzureIPAddress provisioning property.
- `usePolicyBasedTrafficSelectors`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the UsePolicyBasedTrafficSelectors provisioning property.
- `vpnConnectionProtocolType`: `BicepValueProxy | VirtualNetworkGatewayConnectionProtocol` `get - set` -- Gets or sets the VpnConnectionProtocolType provisioning property.
- `vpnLinkConnections`: [Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfVpnSiteLinkConnectionDataProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/aspire-hosting-azure-provisioning-network-generated-listofvpnsitelinkconnectiondataproxy.md) `get - set` -- Gets or sets the VpnLinkConnections provisioning property.

## Methods

- [addTo](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/addto.md) -- `method` -- Adds this provisioning resource to the Azure resource infrastructure.
    ```typescript
  addTo(infrastructure: AzureResourceInfrastructure): void
  ```
- [clearConnectionBandwidth](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/clearconnectionbandwidth.md) -- `method` -- Clears the ConnectionBandwidth provisioning property.
    ```typescript
  clearConnectionBandwidth(): void
  ```
- [clearDpdTimeoutSeconds](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/cleardpdtimeoutseconds.md) -- `method` -- Clears the DpdTimeoutSeconds provisioning property.
    ```typescript
  clearDpdTimeoutSeconds(): void
  ```
- [clearEnableBgp](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/clearenablebgp.md) -- `method` -- Clears the EnableBgp provisioning property.
    ```typescript
  clearEnableBgp(): void
  ```
- [clearEnableInternetSecurity](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/clearenableinternetsecurity.md) -- `method` -- Clears the EnableInternetSecurity provisioning property.
    ```typescript
  clearEnableInternetSecurity(): void
  ```
- [clearEnableRateLimiting](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/clearenableratelimiting.md) -- `method` -- Clears the EnableRateLimiting provisioning property.
    ```typescript
  clearEnableRateLimiting(): void
  ```
- [clearName](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/clearname.md) -- `method` -- Clears the Name provisioning property.
    ```typescript
  clearName(): void
  ```
- [clearRemoteVpnSiteId](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/clearremotevpnsiteid.md) -- `method` -- Clears the RemoteVpnSiteId provisioning property.
    ```typescript
  clearRemoteVpnSiteId(): void
  ```
- [clearRoutingWeight](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/clearroutingweight.md) -- `method` -- Clears the RoutingWeight provisioning property.
    ```typescript
  clearRoutingWeight(): void
  ```
- [clearSharedKey](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/clearsharedkey.md) -- `method` -- Clears the SharedKey provisioning property.
    ```typescript
  clearSharedKey(): void
  ```
- [clearUseLocalAzureIPAddress](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/clearuselocalazureipaddress.md) -- `method` -- Clears the UseLocalAzureIPAddress provisioning property.
    ```typescript
  clearUseLocalAzureIPAddress(): void
  ```
- [clearUsePolicyBasedTrafficSelectors](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/clearusepolicybasedtrafficselectors.md) -- `method` -- Clears the UsePolicyBasedTrafficSelectors provisioning property.
    ```typescript
  clearUsePolicyBasedTrafficSelectors(): void
  ```
- [clearVpnConnectionProtocolType](/reference/api/typescript/aspire.hosting.azure.provisioning.network/vpnconnectionproxy/clearvpnconnectionprotocoltype.md) -- `method` -- Clears the VpnConnectionProtocolType provisioning property.
    ```typescript
  clearVpnConnectionProtocolType(): void
  ```