# VirtualNetworkGatewayConnectionProxy

- 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 VirtualNetworkGatewayConnection Azure Provisioning model.

## Definition

```typescript
interface VirtualNetworkGatewayConnectionProxy {
  authenticationType: BicepValueProxy | ConnectionAuthenticationType;
  authorizationKey: BicepValueProxy | string;
  certificateAuthentication: CertificateAuthenticationProxy;
  connectionMode: BicepValueProxy | VirtualNetworkGatewayConnectionMode;
  connectionProtocol: BicepValueProxy | VirtualNetworkGatewayConnectionProtocol;
  readonly connectionStatus: BicepValueProxy | VirtualNetworkGatewayConnectionStatus;
  connectionType: BicepValueProxy | VirtualNetworkGatewayConnectionType;
  dpdTimeoutSeconds: BicepValueProxy | number;
  readonly egressBytesTransferred: BicepValueProxy | number;
  egressNatRules: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfWritableSubResourceProxy;
  enableBgp: BicepValueProxy | boolean;
  enablePrivateLinkFastPath: BicepValueProxy | boolean;
  readonly eTag: BicepValueProxy;
  expressRouteGatewayBypass: BicepValueProxy | boolean;
  gatewayCustomBgpIPAddresses: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfGatewayCustomBgpIPAddressIPConfigurationProxy;
  readonly id: BicepValueProxy;
  readonly ingressBytesTransferred: BicepValueProxy | number;
  ingressNatRules: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfWritableSubResourceProxy;
  iPsecPolicies: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfIPsecPolicyProxy;
  localNetworkGateway2: LocalNetworkGatewayProxy;
  location: BicepValueProxy;
  name: BicepValueProxy | string;
  peerId: BicepValueProxy;
  readonly provisioningState: BicepValueProxy | NetworkProvisioningState;
  readonly resourceGuid: BicepValueProxy | guid;
  routingWeight: BicepValueProxy | number;
  sharedKey: BicepValueProxy | string;
  tags: Aspire_Hosting_Azure_Provisioning_Network_Generated_DictionaryOfStringProxy;
  trafficSelectorPolicies: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfTrafficSelectorPolicyProxy;
  readonly tunnelConnectionStatus: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfTunnelConnectionHealthProxy;
  tunnelProperties: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfVirtualNetworkGatewayConnectionTunnelPropertiesProxy;
  useLocalAzureIPAddress: BicepValueProxy | boolean;
  usePolicyBasedTrafficSelectors: BicepValueProxy | boolean;
  virtualNetworkGateway1: VirtualNetworkGatewayProxy;
  virtualNetworkGateway2: VirtualNetworkGatewayProxy;
  addTo(infrastructure: AzureResourceInfrastructure): void;
  clearAuthenticationType(): void;
  clearAuthorizationKey(): void;
  clearConnectionMode(): void;
  clearConnectionProtocol(): void;
  clearConnectionType(): void;
  clearDpdTimeoutSeconds(): void;
  clearEnableBgp(): void;
  clearEnablePrivateLinkFastPath(): void;
  clearExpressRouteGatewayBypass(): void;
  clearLocation(): void;
  clearName(): void;
  clearPeerId(): void;
  clearRoutingWeight(): void;
  clearSharedKey(): void;
  clearUseLocalAzureIPAddress(): void;
  clearUsePolicyBasedTrafficSelectors(): void;
}
```

## Properties

- `authenticationType`: `BicepValueProxy | ConnectionAuthenticationType` `get - set` -- Gets or sets the AuthenticationType provisioning property.
- `authorizationKey`: `BicepValueProxy | string` `get - set` -- Gets or sets the AuthorizationKey provisioning property.
- `certificateAuthentication`: [CertificateAuthenticationProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/certificateauthenticationproxy.md) `get - set` -- Gets or sets the CertificateAuthentication provisioning property.
- `connectionMode`: `BicepValueProxy | VirtualNetworkGatewayConnectionMode` `get - set` -- Gets or sets the ConnectionMode provisioning property.
- `connectionProtocol`: `BicepValueProxy | VirtualNetworkGatewayConnectionProtocol` `get - set` -- Gets or sets the ConnectionProtocol provisioning property.
- `connectionStatus`: `BicepValueProxy | VirtualNetworkGatewayConnectionStatus` `get` -- Gets the ConnectionStatus provisioning property.
- `connectionType`: `BicepValueProxy | VirtualNetworkGatewayConnectionType` `get - set` -- Gets or sets the ConnectionType provisioning property.
- `dpdTimeoutSeconds`: `BicepValueProxy | number` `get - set` -- Gets or sets the DpdTimeoutSeconds provisioning property.
- `egressBytesTransferred`: `BicepValueProxy | number` `get` -- Gets the EgressBytesTransferred provisioning property.
- `egressNatRules`: [Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfWritableSubResourceProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/aspire-hosting-azure-provisioning-network-generated-listofwritablesubresourceproxy.md) `get - set` -- Gets or sets the EgressNatRules provisioning property.
- `enableBgp`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the EnableBgp provisioning property.
- `enablePrivateLinkFastPath`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the EnablePrivateLinkFastPath provisioning property.
- `eTag`: `BicepValueProxy` `get` -- Gets the ETag provisioning property.
- `expressRouteGatewayBypass`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the ExpressRouteGatewayBypass provisioning property.
- `gatewayCustomBgpIPAddresses`: [Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfGatewayCustomBgpIPAddressIPConfigurationProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/aspire-hosting-azure-provisioning-network-generated-listofgatewaycustombgpipaddressipconfigurationproxy.md) `get - set` -- Gets or sets the GatewayCustomBgpIPAddresses provisioning property.
- `id`: `BicepValueProxy` `get` -- Gets the Id provisioning property.
- `ingressBytesTransferred`: `BicepValueProxy | number` `get` -- Gets the IngressBytesTransferred provisioning property.
- `ingressNatRules`: [Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfWritableSubResourceProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/aspire-hosting-azure-provisioning-network-generated-listofwritablesubresourceproxy.md) `get - set` -- Gets or sets the IngressNatRules 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.
- `localNetworkGateway2`: [LocalNetworkGatewayProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/localnetworkgatewayproxy.md) `get - set` -- Gets or sets the LocalNetworkGateway2 provisioning property.
- `location`: `BicepValueProxy` `get - set` -- Gets or sets the Location provisioning property.
- `name`: `BicepValueProxy | string` `get - set` -- Gets or sets the Name provisioning property.
- `peerId`: `BicepValueProxy` `get - set` -- Gets or sets the PeerId provisioning property.
- `provisioningState`: `BicepValueProxy | NetworkProvisioningState` `get` -- Gets the ProvisioningState provisioning property.
- `resourceGuid`: `BicepValueProxy | guid` `get` -- Gets the ResourceGuid 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.
- `tags`: [Aspire_Hosting_Azure_Provisioning_Network_Generated_DictionaryOfStringProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/aspire-hosting-azure-provisioning-network-generated-dictionaryofstringproxy.md) `get - set` -- Gets or sets the Tags 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.
- `tunnelConnectionStatus`: [Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfTunnelConnectionHealthProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/aspire-hosting-azure-provisioning-network-generated-listoftunnelconnectionhealthproxy.md) `get` -- Gets the TunnelConnectionStatus provisioning property.
- `tunnelProperties`: [Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfVirtualNetworkGatewayConnectionTunnelPropertiesProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/aspire-hosting-azure-provisioning-network-generated-listofvirtualnetworkgatewayconnectiontunnelpropertiesproxy.md) `get - set` -- Gets or sets the TunnelProperties 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.
- `virtualNetworkGateway1`: [VirtualNetworkGatewayProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayproxy.md) `get - set` -- Gets or sets the VirtualNetworkGateway1 provisioning property.
- `virtualNetworkGateway2`: [VirtualNetworkGatewayProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayproxy.md) `get - set` -- Gets or sets the VirtualNetworkGateway2 provisioning property.

## Methods

- [addTo](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/addto.md) -- `method` -- Adds this provisioning resource to the Azure resource infrastructure.
    ```typescript
  addTo(infrastructure: AzureResourceInfrastructure): void
  ```
- [clearAuthenticationType](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearauthenticationtype.md) -- `method` -- Clears the AuthenticationType provisioning property.
    ```typescript
  clearAuthenticationType(): void
  ```
- [clearAuthorizationKey](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearauthorizationkey.md) -- `method` -- Clears the AuthorizationKey provisioning property.
    ```typescript
  clearAuthorizationKey(): void
  ```
- [clearConnectionMode](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearconnectionmode.md) -- `method` -- Clears the ConnectionMode provisioning property.
    ```typescript
  clearConnectionMode(): void
  ```
- [clearConnectionProtocol](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearconnectionprotocol.md) -- `method` -- Clears the ConnectionProtocol provisioning property.
    ```typescript
  clearConnectionProtocol(): void
  ```
- [clearConnectionType](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearconnectiontype.md) -- `method` -- Clears the ConnectionType provisioning property.
    ```typescript
  clearConnectionType(): void
  ```
- [clearDpdTimeoutSeconds](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/cleardpdtimeoutseconds.md) -- `method` -- Clears the DpdTimeoutSeconds provisioning property.
    ```typescript
  clearDpdTimeoutSeconds(): void
  ```
- [clearEnableBgp](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearenablebgp.md) -- `method` -- Clears the EnableBgp provisioning property.
    ```typescript
  clearEnableBgp(): void
  ```
- [clearEnablePrivateLinkFastPath](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearenableprivatelinkfastpath.md) -- `method` -- Clears the EnablePrivateLinkFastPath provisioning property.
    ```typescript
  clearEnablePrivateLinkFastPath(): void
  ```
- [clearExpressRouteGatewayBypass](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearexpressroutegatewaybypass.md) -- `method` -- Clears the ExpressRouteGatewayBypass provisioning property.
    ```typescript
  clearExpressRouteGatewayBypass(): void
  ```
- [clearLocation](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearlocation.md) -- `method` -- Clears the Location provisioning property.
    ```typescript
  clearLocation(): void
  ```
- [clearName](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearname.md) -- `method` -- Clears the Name provisioning property.
    ```typescript
  clearName(): void
  ```
- [clearPeerId](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearpeerid.md) -- `method` -- Clears the PeerId provisioning property.
    ```typescript
  clearPeerId(): void
  ```
- [clearRoutingWeight](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearroutingweight.md) -- `method` -- Clears the RoutingWeight provisioning property.
    ```typescript
  clearRoutingWeight(): void
  ```
- [clearSharedKey](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearsharedkey.md) -- `method` -- Clears the SharedKey provisioning property.
    ```typescript
  clearSharedKey(): void
  ```
- [clearUseLocalAzureIPAddress](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearuselocalazureipaddress.md) -- `method` -- Clears the UseLocalAzureIPAddress provisioning property.
    ```typescript
  clearUseLocalAzureIPAddress(): void
  ```
- [clearUsePolicyBasedTrafficSelectors](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayconnectionproxy/clearusepolicybasedtrafficselectors.md) -- `method` -- Clears the UsePolicyBasedTrafficSelectors provisioning property.
    ```typescript
  clearUsePolicyBasedTrafficSelectors(): void
  ```