< Back
Set-AzureRmRouteConfig
Post
NAME Set-AzureRmRouteConfig
SYNOPSIS
Sets the goal state for a route.
SYNTAX
Set-AzureRmRouteConfig [-AddressPrefix <String>] [-DefaultProfile <IAzureContextContainer>] [-Name <String>] [-NextHopIpAddress <String>]
[-NextHopType <String>] -RouteTable <PSRouteTable> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmRouteConfig cmdlet sets the goal state for an Azure route.
PARAMETERS
-AddressPrefix <String>
Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the route that this cmdlet modifies.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NextHopIpAddress <String>
Specifies the IP address of a virtual appliance that you add to your Azure virtual network. This route forwards packets to that address.
Specify this parameter only if you specify a value of VirtualAppliance for the NextHopType parameter.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NextHopType <String>
Specifies how this route forwards packets. The acceptable values for this parameter are:
- Internet. The default Internet gateway provided by Azure. - None. If you specify this value, the route does not forward packets. -
VirtualAppliance. A virtual appliance that you add to your Azure virtual network. - VirtualNetworkGateway. An Azureserver-to-server virtual
private network gateway. - VnetLocal. The local virtual network. If you have two subnets, 10.1.0.0/16 and 10.2.0.0/16 in the same virtual
network, select a value of VnetLocal for each subnet to forward to the other subnet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RouteTable <PSRouteTable>
Specifies the route table with which this route is associated.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSRouteTable
Parameter 'RouteTable' accepts value of type 'PSRouteTable' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSRouteTable
NOTES
Example 1: Modify a route
PS C:\\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Set-AzureRmRouteConfig -Name "Route02" -AddressPrefix
10.4.0.0/16 -NextHopType VnetLocal | Set-AzureRmRouteTable
Name : Routetable01
ResourceGroupName : ResourceGroup11
Location : eastus
Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ
k/routeTables/RouteTable01
Etag : W/"58c2922e-9efe-4554-a457-956ef44bc718"
ProvisioningState : Succeeded
Tags :
Routes : [
{
"Name": "Route07",
"Etag": "W/\\"58c2922e-9efe-4554-a457-956ef44bc718\\"",
"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/\\"58c2922e-9efe-4554-a457-956ef44bc718\\"",
"Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro
soft.Network/routeTables/routetable01/routes/route02",
"AddressPrefix": "10.4.0.0/16",
"NextHopType": "VnetLocal",
"NextHopIpAddress": null,
"ProvisioningState": "Succeeded"
}
]
Subnets : []
This command gets the route table named RouteTable01 by using the Get-AzureRmRouteTable cmdlet. The command passes that table to the current
cmdlet by using the pipeline operator. The current cmdlet modifies the route named Route02, and then passes the result to the
Set-AzureRmRouteTable cmdlet, which updates the table to reflect your changes.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... outeconfig
Add-AzureRmRouteConfig
Get-AzureRmRouteConfig
New-AzureRmRouteConfig
Remove-AzureRmRouteConfig
SYNOPSIS
Sets the goal state for a route.
SYNTAX
Set-AzureRmRouteConfig [-AddressPrefix <String>] [-DefaultProfile <IAzureContextContainer>] [-Name <String>] [-NextHopIpAddress <String>]
[-NextHopType <String>] -RouteTable <PSRouteTable> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmRouteConfig cmdlet sets the goal state for an Azure route.
PARAMETERS
-AddressPrefix <String>
Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the route that this cmdlet modifies.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NextHopIpAddress <String>
Specifies the IP address of a virtual appliance that you add to your Azure virtual network. This route forwards packets to that address.
Specify this parameter only if you specify a value of VirtualAppliance for the NextHopType parameter.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NextHopType <String>
Specifies how this route forwards packets. The acceptable values for this parameter are:
- Internet. The default Internet gateway provided by Azure. - None. If you specify this value, the route does not forward packets. -
VirtualAppliance. A virtual appliance that you add to your Azure virtual network. - VirtualNetworkGateway. An Azureserver-to-server virtual
private network gateway. - VnetLocal. The local virtual network. If you have two subnets, 10.1.0.0/16 and 10.2.0.0/16 in the same virtual
network, select a value of VnetLocal for each subnet to forward to the other subnet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RouteTable <PSRouteTable>
Specifies the route table with which this route is associated.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSRouteTable
Parameter 'RouteTable' accepts value of type 'PSRouteTable' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSRouteTable
NOTES
Example 1: Modify a route
PS C:\\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Set-AzureRmRouteConfig -Name "Route02" -AddressPrefix
10.4.0.0/16 -NextHopType VnetLocal | Set-AzureRmRouteTable
Name : Routetable01
ResourceGroupName : ResourceGroup11
Location : eastus
Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ
k/routeTables/RouteTable01
Etag : W/"58c2922e-9efe-4554-a457-956ef44bc718"
ProvisioningState : Succeeded
Tags :
Routes : [
{
"Name": "Route07",
"Etag": "W/\\"58c2922e-9efe-4554-a457-956ef44bc718\\"",
"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/\\"58c2922e-9efe-4554-a457-956ef44bc718\\"",
"Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro
soft.Network/routeTables/routetable01/routes/route02",
"AddressPrefix": "10.4.0.0/16",
"NextHopType": "VnetLocal",
"NextHopIpAddress": null,
"ProvisioningState": "Succeeded"
}
]
Subnets : []
This command gets the route table named RouteTable01 by using the Get-AzureRmRouteTable cmdlet. The command passes that table to the current
cmdlet by using the pipeline operator. The current cmdlet modifies the route named Route02, and then passes the result to the
Set-AzureRmRouteTable cmdlet, which updates the table to reflect your changes.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... outeconfig
Add-AzureRmRouteConfig
Get-AzureRmRouteConfig
New-AzureRmRouteConfig
Remove-AzureRmRouteConfig