Set-AzRouteFilterRuleConfig

Modifies the route filter rule of a route filter.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Set-AzRouteFilterRuleConfig
   -RouteFilter <PSRouteFilter>
   [-Force]
   -Name <String>
   -Access <String>
   -RouteFilterRuleType <String>
   -CommunityList <String[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzRouteFilterRuleConfig cmdlet modifies the route filter rule of a route filter.

Examples

Example 1

PS C:\> $rf = Get-AzRouteFilter -Name "RouteFilter01" -ResourceGroupName "ResourceGroup01"
PS C:\> $rf = Set-AzRouteFilterRuleConfig -RouteFilter $rf -Name "Rule01" -Access Deny -RouteFilterRuleType Community -CommunityList "12076:5010","12076:5040"
PS C:\> Set-AzRouteFilter -RouteFilter $rf

The first command gets the route filter named RouteFilter01 and stores it in the $rf variable. The second command modifies the route filter rule named Rule01 and stores updated route filter in the $rf variable. The third command saves updated route filter.

Parameters

-Access

The access type of the rule. Possible values are: 'Allow', 'Deny'

Type:String
Accepted values:Allow, Deny
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CommunityList

The list of community value that route filter will filter on

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Do not ask for confirmation if you want to overwrite a resource

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

The name of the route filter rule

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RouteFilter

The RouteFilter

Type:PSRouteFilter
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-RouteFilterRuleType

The route filter rule type of the rule. Possible values are: 'Community'

Type:String
Accepted values:Community
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSRouteFilter

Outputs

PSRouteFilter