Skip to content

Commit

Permalink
refactor: Update publicIpZones parameter in virtual-network-gateway m…
Browse files Browse the repository at this point in the history
…odule
  • Loading branch information
sebassem committed Sep 29, 2024
1 parent 85b308a commit 9e3a30c
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 34 deletions.
62 changes: 31 additions & 31 deletions avm/res/network/virtual-network-gateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1686,7 +1686,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway:
| [`clusterSettings`](#parameter-clustersettings) | object | Specifies one of the following four configurations: Active-Active with (clusterMode = activeActiveBgp) or without (clusterMode = activeActiveNoBgp) BGP, Active-Passive with (clusterMode = activePassiveBgp) or without (clusterMode = activePassiveNoBgp) BGP. |
| [`gatewayType`](#parameter-gatewaytype) | string | Specifies the gateway type. E.g. VPN, ExpressRoute. |
| [`name`](#parameter-name) | string | Specifies the Virtual Network Gateway name. |
| [`skuName`](#parameter-skuname) | string | The SKU of the Gateway. |
| [`vNetResourceId`](#parameter-vnetresourceid) | string | Virtual Network resource ID. |

**Optional parameters**
Expand All @@ -1713,6 +1712,7 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway:
| [`publicIPPrefixResourceId`](#parameter-publicipprefixresourceid) | string | Resource ID of the Public IP Prefix object. This is only needed if you want your Public IPs created in a PIP Prefix. |
| [`publicIpZones`](#parameter-publicipzones) | array | Specifies the zones of the Public IP address. Basic IP SKU does not support Availability Zones. |
| [`roleAssignments`](#parameter-roleassignments) | array | Array of role assignments to create. |
| [`skuName`](#parameter-skuname) | string | The SKU of the Gateway. |
| [`tags`](#parameter-tags) | object | Tags of the resource. |
| [`vpnClientAadConfiguration`](#parameter-vpnclientaadconfiguration) | object | Configuration for AAD Authentication for P2S Tunnel Type, Cannot be configured if clientRootCertData is provided. |
| [`vpnClientAddressPoolPrefix`](#parameter-vpnclientaddresspoolprefix) | string | The IP address range from which VPN clients will receive an IP address when connected. Range specified must not overlap with on-premise network. |
Expand Down Expand Up @@ -1747,36 +1747,6 @@ Specifies the Virtual Network Gateway name.
- Required: Yes
- Type: string

### Parameter: `skuName`

The SKU of the Gateway.

- Required: No
- Type: string
- Default: `[if(equals(parameters('gatewayType'), 'VPN'), 'VpnGw1AZ', 'ErGw1AZ')]`
- Allowed:
```Bicep
[
'Basic'
'ErGw1AZ'
'ErGw2AZ'
'ErGw3AZ'
'HighPerformance'
'Standard'
'UltraPerformance'
'VpnGw1'
'VpnGw1AZ'
'VpnGw2'
'VpnGw2AZ'
'VpnGw3'
'VpnGw3AZ'
'VpnGw4'
'VpnGw4AZ'
'VpnGw5'
'VpnGw5AZ'
]
```

### Parameter: `vNetResourceId`

Virtual Network resource ID.
Expand Down Expand Up @@ -2351,6 +2321,36 @@ The principal type of the assigned principal ID.
]
```

### Parameter: `skuName`

The SKU of the Gateway.

- Required: No
- Type: string
- Default: `[if(equals(parameters('gatewayType'), 'VPN'), 'VpnGw1AZ', 'ErGw1AZ')]`
- Allowed:
```Bicep
[
'Basic'
'ErGw1AZ'
'ErGw2AZ'
'ErGw3AZ'
'HighPerformance'
'Standard'
'UltraPerformance'
'VpnGw1'
'VpnGw1AZ'
'VpnGw2'
'VpnGw2AZ'
'VpnGw3'
'VpnGw3AZ'
'VpnGw4'
'VpnGw4AZ'
'VpnGw5'
'VpnGw5AZ'
]
```

### Parameter: `tags`

Tags of the resource.
Expand Down
2 changes: 1 addition & 1 deletion avm/res/network/virtual-network-gateway/main.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ param gatewayType string
])
param vpnGatewayGeneration string = 'None'

@description('Required. The SKU of the Gateway.')
@description('Optional. The SKU of the Gateway.')
@allowed([
'Basic'
'VpnGw1'
Expand Down
4 changes: 2 additions & 2 deletions avm/res/network/virtual-network-gateway/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"_generator": {
"name": "bicep",
"version": "0.30.23.60470",
"templateHash": "8486680621170086005"
"templateHash": "6347373659148864152"
},
"name": "Virtual Network Gateways",
"description": "This module deploys a Virtual Network Gateway.",
Expand Down Expand Up @@ -449,7 +449,7 @@
"ErGw3AZ"
],
"metadata": {
"description": "Required. The SKU of the Gateway."
"description": "Optional. The SKU of the Gateway."
}
},
"vpnType": {
Expand Down

0 comments on commit 9e3a30c

Please sign in to comment.