Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Remove-AzRouteConfig

Removes a route from a route table.

Syntax

Default (Default) 

Remove-AzRouteConfig
 -RouteTable <PSRouteTable>
 [-Name <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

The Remove-AzRouteConfig cmdlet removes a route from an Azure route table.

Examples

Example 1: Remove a route

Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Remove-AzRouteConfig -Name "Route02" | Set-AzRouteTable

Name : RouteTable01
ResourceGroupName : ResourceGroup11
Location : eastus
Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ
 k/routeTables/RouteTable01
Etag : W/"47099b62-60ec-4bc1-b87b-fad56cb8bed1"
ProvisioningState : Succeeded
Tags :
Routes : [
 {
 "Name": "Route07",
 "Etag": "W/\"47099b62-60ec-4bc1-b87b-fad56cb8bed1\"",
 "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"
 }
 ]
Subnets : []

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

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

-Name

Specifies the name of the route that this cmdlet removes.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-RouteTable

Specifies the route table that contains the route that this cmdlet deletes.

Parameter properties

Type:PSRouteTable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

CommonParameters

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.

Inputs

PSRouteTable

Outputs

PSRouteTable

Related Links

Feedback

Was this page helpful?