Add-AzRouteConfig

Module:

Az.Network Module

Adds a route to a route table.

Add-AzRouteConfig
 -RouteTable <PSRouteTable>
 [-Name <String>]
 [-AddressPrefix <String>]
 [-NextHopType <String>]
 [-NextHopIpAddress <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

The Add-AzRouteConfig cmdlet adds a route to an Azure route table.

$RouteTable = Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01"
Add-AzRouteConfig -Name "Route13" -AddressPrefix 10.3.0.0/16 -NextHopType "VnetLocal" -RouteTable $RouteTable

The first command gets a route table named RouteTable01 by using the Get-AzRouteTable cmdlet. The command stores the table in the $RouteTable variable. The second command adds a route named Route13 to the route table stored in $RouteTable. This route forwards packets to the local virtual network.

Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Add-AzRouteConfig -Name "Route02" -AddressPrefix 10.2.0.0/16 -NextHopType VnetLocal | Set-AzRouteTable

Name : routetable01
ResourceGroupName : ResourceGroup11
Location : eastus
Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ
 k/routeTables/routetable01
Etag : W/"f13e1bc8-d41f-44d0-882d-b8b5a1134f59"
ProvisioningState : Succeeded
Tags :
Routes : [
 {
 "Name": "route07",
 "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"",
 "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro
 soft.Network/routeTables/routetable01/routes/route07",
 "AddressPrefix": "10.1.0.0/16",
 "NextHopType": "VnetLocal",
 "NextHopIpAddress": null,
 "ProvisioningState": "Succeeded"
 },
 {
 "Name": "route02",
 "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"",
 "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro
 soft.Network/routeTables/routetable01/routes/route02",
 "AddressPrefix": "10.2.0.0/16",
 "NextHopType": "VnetLocal",
 "NextHopIpAddress": null,
 "ProvisioningState": "Succeeded"
 },
 {
 "Name": "route13",
 "Etag": null,
 "Id": null,
 "AddressPrefix": "10.3.0.0/16",
 "NextHopType": "VnetLocal",
 "NextHopIpAddress": null,
 "ProvisioningState": null
 }
 ]
Subnets : []

This command gets the route table named RouteTable01 by using Get-AzRouteTable. The command passes that table to the current cmdlet by using the pipeline operator. The current cmdlet adds the route named Route02, and then passes the result to the Set-AzRouteTable cmdlet, which updates the table to reflect your changes.

$RouteTable = Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01"
Add-AzRouteConfig -Name "Route13" -AddressPrefix "AppService" -NextHopType "VirtualAppliance" -NextHopIpAddress "10.0.2.4" -RouteTable $RouteTable

The first command gets a route table named RouteTable01 by using the Get-AzRouteTable cmdlet. The command stores the table in the $RouteTable variable. The second command adds a route named Route13 to the route table stored in $RouteTable. This route forwards traffic to IP prefixes contained in the AppService Service Tag to a virtual appliance.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.