Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. RouteMap

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.network.RouteMap

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Route Map.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleVirtualWan = new azure.network.VirtualWan("example", {
    name: "example-vwan",
    resourceGroupName: example.name,
    location: example.location,
});
const exampleVirtualHub = new azure.network.VirtualHub("example", {
    name: "example-vhub",
    resourceGroupName: example.name,
    location: example.location,
    virtualWanId: exampleVirtualWan.id,
    addressPrefix: "10.0.1.0/24",
});
const exampleRouteMap = new azure.network.RouteMap("example", {
    name: "example-rm",
    virtualHubId: exampleVirtualHub.id,
    rules: [{
        name: "rule1",
        nextStepIfMatched: "Continue",
        actions: [{
            type: "Add",
            parameters: [{
                asPaths: ["22334"],
            }],
        }],
        matchCriterions: [{
            matchCondition: "Contains",
            routePrefixes: ["10.0.0.0/8"],
        }],
    }],
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_virtual_wan = azure.network.VirtualWan("example",
    name="example-vwan",
    resource_group_name=example.name,
    location=example.location)
example_virtual_hub = azure.network.VirtualHub("example",
    name="example-vhub",
    resource_group_name=example.name,
    location=example.location,
    virtual_wan_id=example_virtual_wan.id,
    address_prefix="10.0.1.0/24")
example_route_map = azure.network.RouteMap("example",
    name="example-rm",
    virtual_hub_id=example_virtual_hub.id,
    rules=[{
        "name": "rule1",
        "next_step_if_matched": "Continue",
        "actions": [{
            "type": "Add",
            "parameters": [{
                "as_paths": ["22334"],
            }],
        }],
        "match_criterions": [{
            "match_condition": "Contains",
            "route_prefixes": ["10.0.0.0/8"],
        }],
    }])
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleVirtualWan, err := network.NewVirtualWan(ctx, "example", &network.VirtualWanArgs{
			Name:              pulumi.String("example-vwan"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
		})
		if err != nil {
			return err
		}
		exampleVirtualHub, err := network.NewVirtualHub(ctx, "example", &network.VirtualHubArgs{
			Name:              pulumi.String("example-vhub"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			VirtualWanId:      exampleVirtualWan.ID(),
			AddressPrefix:     pulumi.String("10.0.1.0/24"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewRouteMap(ctx, "example", &network.RouteMapArgs{
			Name:         pulumi.String("example-rm"),
			VirtualHubId: exampleVirtualHub.ID(),
			Rules: network.RouteMapRuleArray{
				&network.RouteMapRuleArgs{
					Name:              pulumi.String("rule1"),
					NextStepIfMatched: pulumi.String("Continue"),
					Actions: network.RouteMapRuleActionArray{
						&network.RouteMapRuleActionArgs{
							Type: pulumi.String("Add"),
							Parameters: network.RouteMapRuleActionParameterArray{
								&network.RouteMapRuleActionParameterArgs{
									AsPaths: pulumi.StringArray{
										pulumi.String("22334"),
									},
								},
							},
						},
					},
					MatchCriterions: network.RouteMapRuleMatchCriterionArray{
						&network.RouteMapRuleMatchCriterionArgs{
							MatchCondition: pulumi.String("Contains"),
							RoutePrefixes: pulumi.StringArray{
								pulumi.String("10.0.0.0/8"),
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleVirtualWan = new Azure.Network.VirtualWan("example", new()
    {
        Name = "example-vwan",
        ResourceGroupName = example.Name,
        Location = example.Location,
    });

    var exampleVirtualHub = new Azure.Network.VirtualHub("example", new()
    {
        Name = "example-vhub",
        ResourceGroupName = example.Name,
        Location = example.Location,
        VirtualWanId = exampleVirtualWan.Id,
        AddressPrefix = "10.0.1.0/24",
    });

    var exampleRouteMap = new Azure.Network.RouteMap("example", new()
    {
        Name = "example-rm",
        VirtualHubId = exampleVirtualHub.Id,
        Rules = new[]
        {
            new Azure.Network.Inputs.RouteMapRuleArgs
            {
                Name = "rule1",
                NextStepIfMatched = "Continue",
                Actions = new[]
                {
                    new Azure.Network.Inputs.RouteMapRuleActionArgs
                    {
                        Type = "Add",
                        Parameters = new[]
                        {
                            new Azure.Network.Inputs.RouteMapRuleActionParameterArgs
                            {
                                AsPaths = new[]
                                {
                                    "22334",
                                },
                            },
                        },
                    },
                },
                MatchCriterions = new[]
                {
                    new Azure.Network.Inputs.RouteMapRuleMatchCriterionArgs
                    {
                        MatchCondition = "Contains",
                        RoutePrefixes = new[]
                        {
                            "10.0.0.0/8",
                        },
                    },
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualWan;
import com.pulumi.azure.network.VirtualWanArgs;
import com.pulumi.azure.network.VirtualHub;
import com.pulumi.azure.network.VirtualHubArgs;
import com.pulumi.azure.network.RouteMap;
import com.pulumi.azure.network.RouteMapArgs;
import com.pulumi.azure.network.inputs.RouteMapRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleVirtualWan = new VirtualWan("exampleVirtualWan", VirtualWanArgs.builder()
            .name("example-vwan")
            .resourceGroupName(example.name())
            .location(example.location())
            .build());

        var exampleVirtualHub = new VirtualHub("exampleVirtualHub", VirtualHubArgs.builder()
            .name("example-vhub")
            .resourceGroupName(example.name())
            .location(example.location())
            .virtualWanId(exampleVirtualWan.id())
            .addressPrefix("10.0.1.0/24")
            .build());

        var exampleRouteMap = new RouteMap("exampleRouteMap", RouteMapArgs.builder()
            .name("example-rm")
            .virtualHubId(exampleVirtualHub.id())
            .rules(RouteMapRuleArgs.builder()
                .name("rule1")
                .nextStepIfMatched("Continue")
                .actions(RouteMapRuleActionArgs.builder()
                    .type("Add")
                    .parameters(RouteMapRuleActionParameterArgs.builder()
                        .asPaths("22334")
                        .build())
                    .build())
                .matchCriterions(RouteMapRuleMatchCriterionArgs.builder()
                    .matchCondition("Contains")
                    .routePrefixes("10.0.0.0/8")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleVirtualWan:
    type: azure:network:VirtualWan
    name: example
    properties:
      name: example-vwan
      resourceGroupName: ${example.name}
      location: ${example.location}
  exampleVirtualHub:
    type: azure:network:VirtualHub
    name: example
    properties:
      name: example-vhub
      resourceGroupName: ${example.name}
      location: ${example.location}
      virtualWanId: ${exampleVirtualWan.id}
      addressPrefix: 10.0.1.0/24
  exampleRouteMap:
    type: azure:network:RouteMap
    name: example
    properties:
      name: example-rm
      virtualHubId: ${exampleVirtualHub.id}
      rules:
        - name: rule1
          nextStepIfMatched: Continue
          actions:
            - type: Add
              parameters:
                - asPaths:
                    - '22334'
          matchCriterions:
            - matchCondition: Contains
              routePrefixes:
                - 10.0.0.0/8
Copy

Create RouteMap Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new RouteMap(name: string, args: RouteMapArgs, opts?: CustomResourceOptions);
@overload
def RouteMap(resource_name: str,
             args: RouteMapArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def RouteMap(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             virtual_hub_id: Optional[str] = None,
             name: Optional[str] = None,
             rules: Optional[Sequence[RouteMapRuleArgs]] = None)
func NewRouteMap(ctx *Context, name string, args RouteMapArgs, opts ...ResourceOption) (*RouteMap, error)
public RouteMap(string name, RouteMapArgs args, CustomResourceOptions? opts = null)
public RouteMap(String name, RouteMapArgs args)
public RouteMap(String name, RouteMapArgs args, CustomResourceOptions options)

type: azure:network:RouteMap
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RouteMapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RouteMapArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RouteMapArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RouteMapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RouteMapArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var routeMapResource = new Azure.Network.RouteMap("routeMapResource", new()
{
    VirtualHubId = "string",
    Name = "string",
    Rules = new[]
    {
        new Azure.Network.Inputs.RouteMapRuleArgs
        {
            Name = "string",
            Actions = new[]
            {
                new Azure.Network.Inputs.RouteMapRuleActionArgs
                {
                    Type = "string",
                    Parameters = new[]
                    {
                        new Azure.Network.Inputs.RouteMapRuleActionParameterArgs
                        {
                            AsPaths = new[]
                            {
                                "string",
                            },
                            Communities = new[]
                            {
                                "string",
                            },
                            RoutePrefixes = new[]
                            {
                                "string",
                            },
                        },
                    },
                },
            },
            MatchCriterions = new[]
            {
                new Azure.Network.Inputs.RouteMapRuleMatchCriterionArgs
                {
                    MatchCondition = "string",
                    AsPaths = new[]
                    {
                        "string",
                    },
                    Communities = new[]
                    {
                        "string",
                    },
                    RoutePrefixes = new[]
                    {
                        "string",
                    },
                },
            },
            NextStepIfMatched = "string",
        },
    },
});
Copy
example, err := network.NewRouteMap(ctx, "routeMapResource", &network.RouteMapArgs{
	VirtualHubId: pulumi.String("string"),
	Name:         pulumi.String("string"),
	Rules: network.RouteMapRuleArray{
		&network.RouteMapRuleArgs{
			Name: pulumi.String("string"),
			Actions: network.RouteMapRuleActionArray{
				&network.RouteMapRuleActionArgs{
					Type: pulumi.String("string"),
					Parameters: network.RouteMapRuleActionParameterArray{
						&network.RouteMapRuleActionParameterArgs{
							AsPaths: pulumi.StringArray{
								pulumi.String("string"),
							},
							Communities: pulumi.StringArray{
								pulumi.String("string"),
							},
							RoutePrefixes: pulumi.StringArray{
								pulumi.String("string"),
							},
						},
					},
				},
			},
			MatchCriterions: network.RouteMapRuleMatchCriterionArray{
				&network.RouteMapRuleMatchCriterionArgs{
					MatchCondition: pulumi.String("string"),
					AsPaths: pulumi.StringArray{
						pulumi.String("string"),
					},
					Communities: pulumi.StringArray{
						pulumi.String("string"),
					},
					RoutePrefixes: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			NextStepIfMatched: pulumi.String("string"),
		},
	},
})
Copy
var routeMapResource = new RouteMap("routeMapResource", RouteMapArgs.builder()
    .virtualHubId("string")
    .name("string")
    .rules(RouteMapRuleArgs.builder()
        .name("string")
        .actions(RouteMapRuleActionArgs.builder()
            .type("string")
            .parameters(RouteMapRuleActionParameterArgs.builder()
                .asPaths("string")
                .communities("string")
                .routePrefixes("string")
                .build())
            .build())
        .matchCriterions(RouteMapRuleMatchCriterionArgs.builder()
            .matchCondition("string")
            .asPaths("string")
            .communities("string")
            .routePrefixes("string")
            .build())
        .nextStepIfMatched("string")
        .build())
    .build());
Copy
route_map_resource = azure.network.RouteMap("routeMapResource",
    virtual_hub_id="string",
    name="string",
    rules=[{
        "name": "string",
        "actions": [{
            "type": "string",
            "parameters": [{
                "as_paths": ["string"],
                "communities": ["string"],
                "route_prefixes": ["string"],
            }],
        }],
        "match_criterions": [{
            "match_condition": "string",
            "as_paths": ["string"],
            "communities": ["string"],
            "route_prefixes": ["string"],
        }],
        "next_step_if_matched": "string",
    }])
Copy
const routeMapResource = new azure.network.RouteMap("routeMapResource", {
    virtualHubId: "string",
    name: "string",
    rules: [{
        name: "string",
        actions: [{
            type: "string",
            parameters: [{
                asPaths: ["string"],
                communities: ["string"],
                routePrefixes: ["string"],
            }],
        }],
        matchCriterions: [{
            matchCondition: "string",
            asPaths: ["string"],
            communities: ["string"],
            routePrefixes: ["string"],
        }],
        nextStepIfMatched: "string",
    }],
});
Copy
type: azure:network:RouteMap
properties:
    name: string
    rules:
        - actions:
            - parameters:
                - asPaths:
                    - string
                  communities:
                    - string
                  routePrefixes:
                    - string
              type: string
          matchCriterions:
            - asPaths:
                - string
              communities:
                - string
              matchCondition: string
              routePrefixes:
                - string
          name: string
          nextStepIfMatched: string
    virtualHubId: string
Copy

RouteMap Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The RouteMap resource accepts the following input properties:

VirtualHubId
This property is required.
Changes to this property will trigger replacement.
string
The resource ID of the Virtual Hub. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Route Map. Changing this forces a new resource to be created.
Rules List<RouteMapRule>
A rule block as defined below.
VirtualHubId
This property is required.
Changes to this property will trigger replacement.
string
The resource ID of the Virtual Hub. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Route Map. Changing this forces a new resource to be created.
Rules []RouteMapRuleArgs
A rule block as defined below.
virtualHubId
This property is required.
Changes to this property will trigger replacement.
String
The resource ID of the Virtual Hub. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Route Map. Changing this forces a new resource to be created.
rules List<RouteMapRule>
A rule block as defined below.
virtualHubId
This property is required.
Changes to this property will trigger replacement.
string
The resource ID of the Virtual Hub. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Route Map. Changing this forces a new resource to be created.
rules RouteMapRule[]
A rule block as defined below.
virtual_hub_id
This property is required.
Changes to this property will trigger replacement.
str
The resource ID of the Virtual Hub. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Route Map. Changing this forces a new resource to be created.
rules Sequence[RouteMapRuleArgs]
A rule block as defined below.
virtualHubId
This property is required.
Changes to this property will trigger replacement.
String
The resource ID of the Virtual Hub. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Route Map. Changing this forces a new resource to be created.
rules List<Property Map>
A rule block as defined below.

Outputs

All input properties are implicitly available as output properties. Additionally, the RouteMap resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing RouteMap Resource

Get an existing RouteMap resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RouteMapState, opts?: CustomResourceOptions): RouteMap
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        rules: Optional[Sequence[RouteMapRuleArgs]] = None,
        virtual_hub_id: Optional[str] = None) -> RouteMap
func GetRouteMap(ctx *Context, name string, id IDInput, state *RouteMapState, opts ...ResourceOption) (*RouteMap, error)
public static RouteMap Get(string name, Input<string> id, RouteMapState? state, CustomResourceOptions? opts = null)
public static RouteMap get(String name, Output<String> id, RouteMapState state, CustomResourceOptions options)
resources:  _:    type: azure:network:RouteMap    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Name Changes to this property will trigger replacement. string
The name which should be used for this Route Map. Changing this forces a new resource to be created.
Rules List<RouteMapRule>
A rule block as defined below.
VirtualHubId Changes to this property will trigger replacement. string
The resource ID of the Virtual Hub. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Route Map. Changing this forces a new resource to be created.
Rules []RouteMapRuleArgs
A rule block as defined below.
VirtualHubId Changes to this property will trigger replacement. string
The resource ID of the Virtual Hub. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Route Map. Changing this forces a new resource to be created.
rules List<RouteMapRule>
A rule block as defined below.
virtualHubId Changes to this property will trigger replacement. String
The resource ID of the Virtual Hub. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Route Map. Changing this forces a new resource to be created.
rules RouteMapRule[]
A rule block as defined below.
virtualHubId Changes to this property will trigger replacement. string
The resource ID of the Virtual Hub. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Route Map. Changing this forces a new resource to be created.
rules Sequence[RouteMapRuleArgs]
A rule block as defined below.
virtual_hub_id Changes to this property will trigger replacement. str
The resource ID of the Virtual Hub. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Route Map. Changing this forces a new resource to be created.
rules List<Property Map>
A rule block as defined below.
virtualHubId Changes to this property will trigger replacement. String
The resource ID of the Virtual Hub. Changing this forces a new resource to be created.

Supporting Types

RouteMapRule
, RouteMapRuleArgs

Name This property is required. string
The unique name for the rule.
Actions List<RouteMapRuleAction>
An action block as defined below.
MatchCriterions List<RouteMapRuleMatchCriterion>
A match_criterion block as defined below.
NextStepIfMatched string
The next step after the rule is evaluated. Possible values are Continue, Terminate and Unknown. Defaults to Unknown.
Name This property is required. string
The unique name for the rule.
Actions []RouteMapRuleAction
An action block as defined below.
MatchCriterions []RouteMapRuleMatchCriterion
A match_criterion block as defined below.
NextStepIfMatched string
The next step after the rule is evaluated. Possible values are Continue, Terminate and Unknown. Defaults to Unknown.
name This property is required. String
The unique name for the rule.
actions List<RouteMapRuleAction>
An action block as defined below.
matchCriterions List<RouteMapRuleMatchCriterion>
A match_criterion block as defined below.
nextStepIfMatched String
The next step after the rule is evaluated. Possible values are Continue, Terminate and Unknown. Defaults to Unknown.
name This property is required. string
The unique name for the rule.
actions RouteMapRuleAction[]
An action block as defined below.
matchCriterions RouteMapRuleMatchCriterion[]
A match_criterion block as defined below.
nextStepIfMatched string
The next step after the rule is evaluated. Possible values are Continue, Terminate and Unknown. Defaults to Unknown.
name This property is required. str
The unique name for the rule.
actions Sequence[RouteMapRuleAction]
An action block as defined below.
match_criterions Sequence[RouteMapRuleMatchCriterion]
A match_criterion block as defined below.
next_step_if_matched str
The next step after the rule is evaluated. Possible values are Continue, Terminate and Unknown. Defaults to Unknown.
name This property is required. String
The unique name for the rule.
actions List<Property Map>
An action block as defined below.
matchCriterions List<Property Map>
A match_criterion block as defined below.
nextStepIfMatched String
The next step after the rule is evaluated. Possible values are Continue, Terminate and Unknown. Defaults to Unknown.

RouteMapRuleAction
, RouteMapRuleActionArgs

Type This property is required. string
The type of the action to be taken. Possible values are Add, Drop, Remove, Replace and Unknown.
Parameters List<RouteMapRuleActionParameter>
A parameter block as defined below. Required if type is anything other than Drop.
Type This property is required. string
The type of the action to be taken. Possible values are Add, Drop, Remove, Replace and Unknown.
Parameters []RouteMapRuleActionParameter
A parameter block as defined below. Required if type is anything other than Drop.
type This property is required. String
The type of the action to be taken. Possible values are Add, Drop, Remove, Replace and Unknown.
parameters List<RouteMapRuleActionParameter>
A parameter block as defined below. Required if type is anything other than Drop.
type This property is required. string
The type of the action to be taken. Possible values are Add, Drop, Remove, Replace and Unknown.
parameters RouteMapRuleActionParameter[]
A parameter block as defined below. Required if type is anything other than Drop.
type This property is required. str
The type of the action to be taken. Possible values are Add, Drop, Remove, Replace and Unknown.
parameters Sequence[RouteMapRuleActionParameter]
A parameter block as defined below. Required if type is anything other than Drop.
type This property is required. String
The type of the action to be taken. Possible values are Add, Drop, Remove, Replace and Unknown.
parameters List<Property Map>
A parameter block as defined below. Required if type is anything other than Drop.

RouteMapRuleActionParameter
, RouteMapRuleActionParameterArgs

AsPaths List<string>
A list of AS paths.
Communities List<string>
A list of BGP communities.
RoutePrefixes List<string>
A list of route prefixes.
AsPaths []string
A list of AS paths.
Communities []string
A list of BGP communities.
RoutePrefixes []string
A list of route prefixes.
asPaths List<String>
A list of AS paths.
communities List<String>
A list of BGP communities.
routePrefixes List<String>
A list of route prefixes.
asPaths string[]
A list of AS paths.
communities string[]
A list of BGP communities.
routePrefixes string[]
A list of route prefixes.
as_paths Sequence[str]
A list of AS paths.
communities Sequence[str]
A list of BGP communities.
route_prefixes Sequence[str]
A list of route prefixes.
asPaths List<String>
A list of AS paths.
communities List<String>
A list of BGP communities.
routePrefixes List<String>
A list of route prefixes.

RouteMapRuleMatchCriterion
, RouteMapRuleMatchCriterionArgs

MatchCondition This property is required. string
The match condition to apply the rule of the Route Map. Possible values are Contains, Equals, NotContains, NotEquals and Unknown.
AsPaths List<string>
A list of AS paths which this criterion matches.
Communities List<string>
A list of BGP communities which this criterion matches.
RoutePrefixes List<string>
A list of route prefixes which this criterion matches.
MatchCondition This property is required. string
The match condition to apply the rule of the Route Map. Possible values are Contains, Equals, NotContains, NotEquals and Unknown.
AsPaths []string
A list of AS paths which this criterion matches.
Communities []string
A list of BGP communities which this criterion matches.
RoutePrefixes []string
A list of route prefixes which this criterion matches.
matchCondition This property is required. String
The match condition to apply the rule of the Route Map. Possible values are Contains, Equals, NotContains, NotEquals and Unknown.
asPaths List<String>
A list of AS paths which this criterion matches.
communities List<String>
A list of BGP communities which this criterion matches.
routePrefixes List<String>
A list of route prefixes which this criterion matches.
matchCondition This property is required. string
The match condition to apply the rule of the Route Map. Possible values are Contains, Equals, NotContains, NotEquals and Unknown.
asPaths string[]
A list of AS paths which this criterion matches.
communities string[]
A list of BGP communities which this criterion matches.
routePrefixes string[]
A list of route prefixes which this criterion matches.
match_condition This property is required. str
The match condition to apply the rule of the Route Map. Possible values are Contains, Equals, NotContains, NotEquals and Unknown.
as_paths Sequence[str]
A list of AS paths which this criterion matches.
communities Sequence[str]
A list of BGP communities which this criterion matches.
route_prefixes Sequence[str]
A list of route prefixes which this criterion matches.
matchCondition This property is required. String
The match condition to apply the rule of the Route Map. Possible values are Contains, Equals, NotContains, NotEquals and Unknown.
asPaths List<String>
A list of AS paths which this criterion matches.
communities List<String>
A list of BGP communities which this criterion matches.
routePrefixes List<String>
A list of route prefixes which this criterion matches.

Import

Route Maps can be imported using the resource id, e.g.

$ pulumi import azure:network/routeMap:RouteMap example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure