Add-AzureRmRouteFilterRuleConfig

Reference

Module:: AzureRM.Network

Adds a route filter rule to a route filter.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Add-AzureRmRouteFilterRuleConfig
   -RouteFilter <PSRouteFilter>
   [-Force]
   -Name <String>
   -Access <String>
   -RouteFilterRuleType <String>
   -CommunityList <System.Collections.Generic.List`1[System.String]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-AzureRmRouteFilterRuleConfig cmdlet adds a route filter rule to an Azure route filter.

Examples

Example 1: Add a route filter rule to a route filter

PS C:\>$RouteFilter = Get-AzureRmRouteFilter -ResourceGroupName "ResourceGroup11" -Name "routefilter01"
					  PS C:\> Add-AzureRmRouteFilterRuleConfig -Name "rule13" -Access Allow -RouteFilterRuleType Community -RouteFilter $RouteFilter

The first command gets a route filter named routefilter01 by using the Get-AzureRmRouteFilter cmdlet. The command stores the filter in the $RouteFilter variable.

Parameters

-Access

Specifies the access of the route filter rule, Valid values are Deny or Allow.

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

-CommunityList

The list of community value that route filter will filter on

Type:	List<T>[String]
Position:	Named
Default value:	None
Required:	True
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

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

-Force

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

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

-Name

Specifies a name of the route filter rule to add to the route filter.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RouteFilter

Specifies the route filter to which this cmdlet adds a route filter rule.

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

-RouteFilterRuleType

Specifies the route filter rule type. Valid values are: Community

Type:	String
Accepted values:	Community
Position:	Named
Default value:	None
Required:	True
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PSRouteFilter

Parameters: RouteFilter (ByValue)

Outputs