Merge pull request #1155 from tanmay-j/RTSupportForSubnet

Added route table support for subnets

RELEASE_NOTES.md

@@ -5,6 +5,7 @@ Release Notes
 
 ## 1.9.4
 * Network Security Groups: Use a common protocol in security rules with multiple sources. Defaults to Any if sources use different protocols.
+* Virtual Network: Specify the route table for a subnet.
 
 ## 1.9.3
 * Deployments: Default to resource group location rather than West Europe.
@@ -14,6 +15,7 @@ Release Notes
 * Az: Update `ad` commands to work with latest (breaking) structure.
 * PostgreSQL: Fix a number of issues around the introduction of Flexible Servers.
 
+
 ## 1.9.2
 * Container Apps: Fix to container registry credential to not emit a secret for a managed identity.
 * Container Groups: followup to #ff78f202dc - expand DNS config validation for profile-less vnet.

docs/content/api-overview/resources/vnet.md

@@ -45,6 +45,8 @@ The Virtual Network module contains four builders
 | link_to_nat_gateway                  | Specify an existing NAT gateway for the subnet.                                           |
 | network_security_group               | Specify the network security group from the same deployment.                              |
 | link_to_network_security_group       | Specify an existing network security group for this subnet.                               |
+| route_table                          | Specify the route table from the same deployment.                                         |
+| link_to_route_table                  | Specify an existing route table for this subnet.                                          |
 | link_to_vnet                         | Link a standalone subnet to a vnet in the same template.                                  |
 | link_to_unmanaged_vnet               | Link a standalone subnet to an existing vnet that is already deployed.                    |
 | add_delegations                      | Adds one or more delegations to this subnet.                                              |
@@ -72,6 +74,8 @@ The Virtual Network module contains four builders
 | link_to_nat_gateway                   | Specify an existing NAT gateway for the subnet.                                           |
 | network_security_group                  | Specify the network security group from the same deployment.           |
 | link_to_network_security_group          | Specify an existing network security group for the subnet.             |
+| route_table                           | Specify the route table from the same deployment.                                         |
+| link_to_route_table                   | Specify an existing route table for the subnet.                                           |
 | add_delegations                         | Adds service delegations for the subnet.                               |
 | add_service_endpoints                   | Adds service endpoints for the subnet.                                 |
 | add_service_endpoint_policies           | Associates the service endpoint policies with the subnet.              |

src/Farmer/Arm/Network.fs

@@ -327,6 +327,7 @@ type Subnet = {
     Name: ResourceName
     Prefixes: string list
     VirtualNetwork: LinkedResource option
+    RouteTable: LinkedResource option
     NetworkSecurityGroup: LinkedResource option
     Delegations: SubnetDelegation list
     NatGateway: LinkedResource option
@@ -351,6 +352,10 @@ type Subnet = {
                 this.NatGateway
                 |> Option.map LinkedResource.AsIdObject
                 |> Option.defaultValue Unchecked.defaultof<_>
+            routeTable =
+                this.RouteTable
+                |> Option.map (fun rt -> {| id = rt.ResourceId.Eval() |})
+                |> Option.defaultValue Unchecked.defaultof<_>
             networkSecurityGroup =
                 this.NetworkSecurityGroup
                 |> Option.map (fun nsg -> {|
@@ -431,6 +436,10 @@ type VirtualNetwork = {
                         match subnet.NatGateway with
                         | Some(Managed id) -> id
                         | _ -> ()
+
+                        match subnet.RouteTable with
+                        | Some(Managed id) -> id
+                        | _ -> ()
                 }
                 |> Set
 

src/Farmer/Builders/Builders.NetworkInterface.fs

@@ -68,6 +68,7 @@ type NetworkInterfaceConfig = {
                         Subnet.Name = ResourceName subnetName
                         Prefixes = [ IPAddressCidr.format subnetPrefix ]
                         VirtualNetwork = Some(vnetId)
+                        RouteTable = None
                         NetworkSecurityGroup = None
                         Delegations = []
                         NatGateway = None

src/Farmer/Builders/Builders.RouteServer.fs

@@ -83,6 +83,7 @@ type RouteServerConfig = {
                 Subnet.Name = ResourceName "RouteServerSubnet"
                 Prefixes = [ IPAddressCidr.format this.SubnetPrefix ]
                 VirtualNetwork = Some(vnetId)
+                RouteTable = None
                 NetworkSecurityGroup = None
                 Delegations = []
                 NatGateway = None

src/Farmer/Builders/Builders.VirtualNetwork.fs

@@ -15,6 +15,7 @@ type SubnetConfig = {
     Name: ResourceName
     Prefixes: IPAddressCidr list
     VirtualNetwork: LinkedResource option
+    RouteTable: LinkedResource option
     NetworkSecurityGroup: LinkedResource option
     Delegations: SubnetDelegationService list
     NatGateway: LinkedResource option
@@ -29,6 +30,7 @@ type SubnetConfig = {
         Name = this.Name
         Prefixes = this.Prefixes |> List.map IPAddressCidr.format
         VirtualNetwork = this.VirtualNetwork
+        RouteTable = this.RouteTable
         NetworkSecurityGroup = this.NetworkSecurityGroup
         Delegations =
             this.Delegations
@@ -59,6 +61,7 @@ type SubnetBuilder() =
         Name = ResourceName.Empty
         Prefixes = []
         VirtualNetwork = None
+        RouteTable = None
         NetworkSecurityGroup = None
         Delegations = []
         NatGateway = None
@@ -164,6 +167,40 @@ type SubnetBuilder() =
             NetworkSecurityGroup = Some(Unmanaged (nsg :> IBuilder).ResourceId)
     }
 
+    /// Sets the route table for subnet
+    [<CustomOperation "route_table">]
+    member _.RouteTable(state: SubnetConfig, rt: IArmResource) = {
+        state with
+            RouteTable = Some(Managed rt.ResourceId)
+    }
+
+    member _.RouteTable(state: SubnetConfig, rt: ResourceId) = {
+        state with
+            RouteTable = Some(Managed rt)
+    }
+
+    member _.RouteTable(state: SubnetConfig, rt: RouteTableConfig) = {
+        state with
+            RouteTable = Some(Managed (rt :> IBuilder).ResourceId)
+    }
+
+    /// Links the subnet to an existing route table.
+    [<CustomOperation "link_to_route_table">]
+    member _.LinkToRouteTable(state: SubnetConfig, rt: IArmResource) = {
+        state with
+            RouteTable = Some(Unmanaged(rt.ResourceId))
+    }
+
+    member _.LinkToRouteTable(state: SubnetConfig, rt: ResourceId) = {
+        state with
+            RouteTable = Some(Unmanaged rt)
+    }
+
+    member _.LinkToRouteTable(state: SubnetConfig, rt: RouteTableConfig) = {
+        state with
+            RouteTable = Some(Unmanaged (rt :> IBuilder).ResourceId)
+    }
+
     /// Links the subnet to an managed virtual network.
     [<CustomOperation "link_to_vnet">]
     member _.LinkToVirtualNetwork(state: SubnetConfig, vnet: IArmResource) = {
@@ -246,6 +283,7 @@ type SubnetBuildSpec = {
     Name: string
     Size: int
     NetworkSecurityGroup: LinkedResource option
+    RouteTable: LinkedResource option
     Delegations: SubnetDelegationService list
     NatGateway: LinkedResource option
     ServiceEndpoints: (EndpointServiceType * Location list) list
@@ -259,6 +297,7 @@ let buildSubnet name size = {
     Name = name
     Size = size
     NetworkSecurityGroup = None
+    RouteTable = None
     Delegations = []
     NatGateway = None
     ServiceEndpoints = []
@@ -272,6 +311,7 @@ let buildSubnetDelegations name size delegations = {
     Name = name
     Size = size
     NetworkSecurityGroup = None
+    RouteTable = None
     Delegations = delegations
     NatGateway = None
     ServiceEndpoints = []
@@ -284,6 +324,7 @@ let buildSubnetAllowPrivateEndpoints name size = {
     Name = name
     Size = size
     NetworkSecurityGroup = None
+    RouteTable = None
     Delegations = []
     NatGateway = None
     ServiceEndpoints = []
@@ -297,6 +338,7 @@ type SubnetSpecBuilder() =
         Name = ""
         Size = 24
         NetworkSecurityGroup = None
+        RouteTable = None
         Delegations = []
         NatGateway = None
         ServiceEndpoints = []
@@ -379,6 +421,40 @@ type SubnetSpecBuilder() =
             NetworkSecurityGroup = Some(Unmanaged (nsg :> IBuilder).ResourceId)
     }
 
+    /// Sets the route table for subnet
+    [<CustomOperation "route_table">]
+    member _.RouteTable(state: SubnetBuildSpec, rt: IArmResource) = {
+        state with
+            RouteTable = Some(Managed rt.ResourceId)
+    }
+
+    member _.RouteTable(state: SubnetBuildSpec, rt: ResourceId) = {
+        state with
+            RouteTable = Some(Managed rt)
+    }
+
+    member _.RouteTable(state: SubnetBuildSpec, rt: RouteTableConfig) = {
+        state with
+            RouteTable = Some(Managed (rt :> IBuilder).ResourceId)
+    }
+
+    /// Links the subnet to an existing route table.
+    [<CustomOperation "link_to_route_table">]
+    member _.LinkToRouteTable(state: SubnetBuildSpec, rt: IArmResource) = {
+        state with
+            RouteTable = Some(Unmanaged(rt.ResourceId))
+    }
+
+    member _.LinkToRouteTable(state: SubnetBuildSpec, rt: ResourceId) = {
+        state with
+            RouteTable = Some(Unmanaged(rt))
+    }
+
+    member _.LinkToRouteTable(state: SubnetBuildSpec, rt: RouteTableConfig) = {
+        state with
+            RouteTable = Some(Unmanaged (rt :> IBuilder).ResourceId)
+    }
+
     /// Adds any services to delegate this subnet
     [<CustomOperation "add_delegations">]
     member _.AddDelegations(state: SubnetBuildSpec, delegations) = {
@@ -447,12 +523,14 @@ type AddressSpaceBuilder() =
             ?associatedServiceEndpointPolicies: ResourceId list,
             ?allowPrivateEndpoints: FeatureFlag,
             ?privateLinkServiceNetworkPolicies: FeatureFlag,
-            ?nsg: LinkedResource
+            ?nsg: LinkedResource,
+            ?rt: LinkedResource
         ) =
         let subnetBuildSpec = {
             Name = name
             Size = size
             NetworkSecurityGroup = nsg
+            RouteTable = rt
             Delegations = delegations |> Option.defaultValue []
             NatGateway = None
             ServiceEndpoints = serviceEndpoints |> Option.defaultValue []
@@ -643,7 +721,8 @@ type VirtualNetworkBuilder() =
                         s.AllowPrivateEndpoints,
                         s.PrivateLinkServiceNetworkPolicies,
                         s.NatGateway,
-                        s.NetworkSecurityGroup)
+                        s.NetworkSecurityGroup,
+                        s.RouteTable)
                 )
                 |> List.map
                     (fun
@@ -654,12 +733,14 @@ type VirtualNetworkBuilder() =
                           allowPrivateEndpoints,
                           privateLinkServiceNetworkPolicies,
                           natGateway,
-                          nsg),
+                          nsg,
+                          rt),
                          cidr) -> {
                         Name = ResourceName name
                         Prefixes = [ cidr ]
                         VirtualNetwork = Some(Managed(virtualNetworks.resourceId state.Name))
                         NetworkSecurityGroup = nsg
+                        RouteTable = rt
                         Delegations = delegations
                         NatGateway = natGateway
                         ServiceEndpoints = serviceEndpoints

src/Farmer/Builders/Builders.Vm.fs

@@ -155,6 +155,7 @@ type VmConfig = {
                         Name = subnetId.Name
                         Prefixes = [ this.SubnetPrefix ]
                         VirtualNetwork = Some(Managed vnet)
+                        RouteTable = None
                         NetworkSecurityGroup = nsgId |> Option.map Managed
                         Delegations = []
                         NatGateway = None

src/Farmer/Farmer.fsproj

@@ -152,6 +152,7 @@
         <Compile Include="Builders/Builders.Bastion.fs" />
         <Compile Include="Builders\Builders.NatGateway.fs" />
         <Compile Include="Builders\Builders.NetworkSecurityGroup.fs" />
+        <Compile Include="Builders\Builders.RouteTable.fs" />
         <Compile Include="Builders/Builders.VirtualNetwork.fs" />
         <Compile Include="Builders\Builders.LoadBalancer.fs" />
         <Compile Include="Builders/Builders.Vm.fs" />
@@ -187,7 +188,6 @@
         <Compile Include="Builders/Builders.OperationsManagement.fs" />
         <Compile Include="Builders\Builders.PrivateLink.fs" />
         <Compile Include="Builders\Builders.PrivateEndpoint.fs" />
-        <Compile Include="Builders\Builders.RouteTable.fs" />
         <Compile Include="Builders\Builders.HostGroup.fs" />
         <Compile Include="Builders\Builders.NetworkInterface.fs" />
         <Compile Include="Builders\Builders.RouteServer.fs" />