# VirtualNetworkGatewayNatRuleProxy

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

## Definition

```typescript
interface VirtualNetworkGatewayNatRuleProxy {
  readonly eTag: BicepValueProxy;
  externalMappings: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfVpnNatRuleMappingProxy;
  readonly id: BicepValueProxy;
  internalMappings: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfVpnNatRuleMappingProxy;
  iPConfigurationId: BicepValueProxy | string;
  mode: BicepValueProxy | VpnNatRuleMode;
  name: BicepValueProxy | string;
  parent: VirtualNetworkGatewayProxy;
  readonly provisioningState: BicepValueProxy | NetworkProvisioningState;
  vpnNatRuleType: BicepValueProxy | VpnNatRuleType;
  addTo(infrastructure: AzureResourceInfrastructure): void;
  clearIPConfigurationId(): void;
  clearMode(): void;
  clearName(): void;
  clearVpnNatRuleType(): void;
}
```

## Properties

- `eTag`: `BicepValueProxy` `get` -- Gets the ETag provisioning property.
- `externalMappings`: [Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfVpnNatRuleMappingProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/aspire-hosting-azure-provisioning-network-generated-listofvpnnatrulemappingproxy.md) `get - set` -- Gets or sets the ExternalMappings provisioning property.
- `id`: `BicepValueProxy` `get` -- Gets the Id provisioning property.
- `internalMappings`: [Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfVpnNatRuleMappingProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/aspire-hosting-azure-provisioning-network-generated-listofvpnnatrulemappingproxy.md) `get - set` -- Gets or sets the InternalMappings provisioning property.
- `iPConfigurationId`: `BicepValueProxy | string` `get - set` -- Gets or sets the IPConfigurationId provisioning property.
- `mode`: `BicepValueProxy | VpnNatRuleMode` `get - set` -- Gets or sets the Mode provisioning property.
- `name`: `BicepValueProxy | string` `get - set` -- Gets or sets the Name provisioning property.
- `parent`: [VirtualNetworkGatewayProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewayproxy.md) `get - set` -- Gets or sets the Parent provisioning property.
- `provisioningState`: `BicepValueProxy | NetworkProvisioningState` `get` -- Gets the ProvisioningState provisioning property.
- `vpnNatRuleType`: `BicepValueProxy | VpnNatRuleType` `get - set` -- Gets or sets the VpnNatRuleType provisioning property.

## Methods

- [addTo](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewaynatruleproxy/addto.md) -- `method` -- Adds this provisioning resource to the Azure resource infrastructure.
    ```typescript
  addTo(infrastructure: AzureResourceInfrastructure): void
  ```
- [clearIPConfigurationId](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewaynatruleproxy/clearipconfigurationid.md) -- `method` -- Clears the IPConfigurationId provisioning property.
    ```typescript
  clearIPConfigurationId(): void
  ```
- [clearMode](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewaynatruleproxy/clearmode.md) -- `method` -- Clears the Mode provisioning property.
    ```typescript
  clearMode(): void
  ```
- [clearName](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewaynatruleproxy/clearname.md) -- `method` -- Clears the Name provisioning property.
    ```typescript
  clearName(): void
  ```
- [clearVpnNatRuleType](/reference/api/typescript/aspire.hosting.azure.provisioning.network/virtualnetworkgatewaynatruleproxy/clearvpnnatruletype.md) -- `method` -- Clears the VpnNatRuleType provisioning property.
    ```typescript
  clearVpnNatRuleType(): void
  ```