1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. RouteMap
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi

azure-native.network.RouteMap

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi

    The RouteMap child resource of a Virtual hub. Azure REST API version: 2023-02-01.

    Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01.

    Example Usage

    RouteMapPut

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var routeMap = new AzureNative.Network.RouteMap("routeMap", new()
        {
            AssociatedInboundConnections = new[]
            {
                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1",
            },
            AssociatedOutboundConnections = new[] {},
            ResourceGroupName = "rg1",
            RouteMapName = "routeMap1",
            Rules = new[]
            {
                new AzureNative.Network.Inputs.RouteMapRuleArgs
                {
                    Actions = new[]
                    {
                        new AzureNative.Network.Inputs.ActionArgs
                        {
                            Parameters = new[]
                            {
                                new AzureNative.Network.Inputs.ParameterArgs
                                {
                                    AsPath = new[]
                                    {
                                        "22334",
                                    },
                                    Community = new() { },
                                    RoutePrefix = new() { },
                                },
                            },
                            Type = AzureNative.Network.RouteMapActionType.Add,
                        },
                    },
                    MatchCriteria = new[]
                    {
                        new AzureNative.Network.Inputs.CriterionArgs
                        {
                            AsPath = new() { },
                            Community = new() { },
                            MatchCondition = AzureNative.Network.RouteMapMatchCondition.Contains,
                            RoutePrefix = new[]
                            {
                                "10.0.0.0/8",
                            },
                        },
                    },
                    Name = "rule1",
                    NextStepIfMatched = AzureNative.Network.NextStep.Continue,
                },
            },
            VirtualHubName = "virtualHub1",
        });
    
    });
    
    package main
    
    import (
    	network "github.com/pulumi/pulumi-azure-native-sdk/network/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := network.NewRouteMap(ctx, "routeMap", &network.RouteMapArgs{
    			AssociatedInboundConnections: pulumi.StringArray{
    				pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1"),
    			},
    			AssociatedOutboundConnections: pulumi.StringArray{},
    			ResourceGroupName:             pulumi.String("rg1"),
    			RouteMapName:                  pulumi.String("routeMap1"),
    			Rules: network.RouteMapRuleArray{
    				&network.RouteMapRuleArgs{
    					Actions: network.ActionArray{
    						&network.ActionArgs{
    							Parameters: network.ParameterArray{
    								&network.ParameterArgs{
    									AsPath: pulumi.StringArray{
    										pulumi.String("22334"),
    									},
    									Community:   pulumi.StringArray{},
    									RoutePrefix: pulumi.StringArray{},
    								},
    							},
    							Type: pulumi.String(network.RouteMapActionTypeAdd),
    						},
    					},
    					MatchCriteria: network.CriterionArray{
    						&network.CriterionArgs{
    							AsPath:         pulumi.StringArray{},
    							Community:      pulumi.StringArray{},
    							MatchCondition: pulumi.String(network.RouteMapMatchConditionContains),
    							RoutePrefix: pulumi.StringArray{
    								pulumi.String("10.0.0.0/8"),
    							},
    						},
    					},
    					Name:              pulumi.String("rule1"),
    					NextStepIfMatched: pulumi.String(network.NextStepContinue),
    				},
    			},
    			VirtualHubName: pulumi.String("virtualHub1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.network.RouteMap;
    import com.pulumi.azurenative.network.RouteMapArgs;
    import com.pulumi.azurenative.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 routeMap = new RouteMap("routeMap", RouteMapArgs.builder()
                .associatedInboundConnections("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1")
                .associatedOutboundConnections()
                .resourceGroupName("rg1")
                .routeMapName("routeMap1")
                .rules(RouteMapRuleArgs.builder()
                    .actions(ActionArgs.builder()
                        .parameters(ParameterArgs.builder()
                            .asPath("22334")
                            .community()
                            .routePrefix()
                            .build())
                        .type("Add")
                        .build())
                    .matchCriteria(CriterionArgs.builder()
                        .asPath()
                        .community()
                        .matchCondition("Contains")
                        .routePrefix("10.0.0.0/8")
                        .build())
                    .name("rule1")
                    .nextStepIfMatched("Continue")
                    .build())
                .virtualHubName("virtualHub1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    route_map = azure_native.network.RouteMap("routeMap",
        associated_inbound_connections=["/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1"],
        associated_outbound_connections=[],
        resource_group_name="rg1",
        route_map_name="routeMap1",
        rules=[azure_native.network.RouteMapRuleArgs(
            actions=[azure_native.network.ActionArgs(
                parameters=[azure_native.network.ParameterArgs(
                    as_path=["22334"],
                    community=[],
                    route_prefix=[],
                )],
                type=azure_native.network.RouteMapActionType.ADD,
            )],
            match_criteria=[azure_native.network.CriterionArgs(
                as_path=[],
                community=[],
                match_condition=azure_native.network.RouteMapMatchCondition.CONTAINS,
                route_prefix=["10.0.0.0/8"],
            )],
            name="rule1",
            next_step_if_matched=azure_native.network.NextStep.CONTINUE_,
        )],
        virtual_hub_name="virtualHub1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const routeMap = new azure_native.network.RouteMap("routeMap", {
        associatedInboundConnections: ["/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1"],
        associatedOutboundConnections: [],
        resourceGroupName: "rg1",
        routeMapName: "routeMap1",
        rules: [{
            actions: [{
                parameters: [{
                    asPath: ["22334"],
                    community: [],
                    routePrefix: [],
                }],
                type: azure_native.network.RouteMapActionType.Add,
            }],
            matchCriteria: [{
                asPath: [],
                community: [],
                matchCondition: azure_native.network.RouteMapMatchCondition.Contains,
                routePrefix: ["10.0.0.0/8"],
            }],
            name: "rule1",
            nextStepIfMatched: azure_native.network.NextStep.Continue,
        }],
        virtualHubName: "virtualHub1",
    });
    
    resources:
      routeMap:
        type: azure-native:network:RouteMap
        properties:
          associatedInboundConnections:
            - /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1
          associatedOutboundConnections: []
          resourceGroupName: rg1
          routeMapName: routeMap1
          rules:
            - actions:
                - parameters:
                    - asPath:
                        - '22334'
                      community: []
                      routePrefix: []
                  type: Add
              matchCriteria:
                - asPath: []
                  community: []
                  matchCondition: Contains
                  routePrefix:
                    - 10.0.0.0/8
              name: rule1
              nextStepIfMatched: Continue
          virtualHubName: virtualHub1
    

    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,
                 resource_group_name: Optional[str] = None,
                 virtual_hub_name: Optional[str] = None,
                 associated_inbound_connections: Optional[Sequence[str]] = None,
                 associated_outbound_connections: Optional[Sequence[str]] = None,
                 id: Optional[str] = None,
                 route_map_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-native:network:RouteMap
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args RouteMapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args RouteMapArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouteMapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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 AzureNative.Network.RouteMap("routeMapResource", new()
    {
        ResourceGroupName = "string",
        VirtualHubName = "string",
        AssociatedInboundConnections = new[]
        {
            "string",
        },
        AssociatedOutboundConnections = new[]
        {
            "string",
        },
        Id = "string",
        RouteMapName = "string",
        Rules = new[]
        {
            new AzureNative.Network.Inputs.RouteMapRuleArgs
            {
                Actions = new[]
                {
                    new AzureNative.Network.Inputs.ActionArgs
                    {
                        Parameters = new[]
                        {
                            new AzureNative.Network.Inputs.ParameterArgs
                            {
                                AsPath = new[]
                                {
                                    "string",
                                },
                                Community = new[]
                                {
                                    "string",
                                },
                                RoutePrefix = new[]
                                {
                                    "string",
                                },
                            },
                        },
                        Type = "string",
                    },
                },
                MatchCriteria = new[]
                {
                    new AzureNative.Network.Inputs.CriterionArgs
                    {
                        AsPath = new[]
                        {
                            "string",
                        },
                        Community = new[]
                        {
                            "string",
                        },
                        MatchCondition = "string",
                        RoutePrefix = new[]
                        {
                            "string",
                        },
                    },
                },
                Name = "string",
                NextStepIfMatched = "string",
            },
        },
    });
    
    example, err := network.NewRouteMap(ctx, "routeMapResource", &network.RouteMapArgs{
    ResourceGroupName: pulumi.String("string"),
    VirtualHubName: pulumi.String("string"),
    AssociatedInboundConnections: pulumi.StringArray{
    pulumi.String("string"),
    },
    AssociatedOutboundConnections: pulumi.StringArray{
    pulumi.String("string"),
    },
    Id: pulumi.String("string"),
    RouteMapName: pulumi.String("string"),
    Rules: network.RouteMapRuleArray{
    &network.RouteMapRuleArgs{
    Actions: network.ActionArray{
    &network.ActionArgs{
    Parameters: network.ParameterArray{
    &network.ParameterArgs{
    AsPath: pulumi.StringArray{
    pulumi.String("string"),
    },
    Community: pulumi.StringArray{
    pulumi.String("string"),
    },
    RoutePrefix: pulumi.StringArray{
    pulumi.String("string"),
    },
    },
    },
    Type: pulumi.String("string"),
    },
    },
    MatchCriteria: network.CriterionArray{
    &network.CriterionArgs{
    AsPath: pulumi.StringArray{
    pulumi.String("string"),
    },
    Community: pulumi.StringArray{
    pulumi.String("string"),
    },
    MatchCondition: pulumi.String("string"),
    RoutePrefix: pulumi.StringArray{
    pulumi.String("string"),
    },
    },
    },
    Name: pulumi.String("string"),
    NextStepIfMatched: pulumi.String("string"),
    },
    },
    })
    
    var routeMapResource = new RouteMap("routeMapResource", RouteMapArgs.builder()
        .resourceGroupName("string")
        .virtualHubName("string")
        .associatedInboundConnections("string")
        .associatedOutboundConnections("string")
        .id("string")
        .routeMapName("string")
        .rules(RouteMapRuleArgs.builder()
            .actions(ActionArgs.builder()
                .parameters(ParameterArgs.builder()
                    .asPath("string")
                    .community("string")
                    .routePrefix("string")
                    .build())
                .type("string")
                .build())
            .matchCriteria(CriterionArgs.builder()
                .asPath("string")
                .community("string")
                .matchCondition("string")
                .routePrefix("string")
                .build())
            .name("string")
            .nextStepIfMatched("string")
            .build())
        .build());
    
    route_map_resource = azure_native.network.RouteMap("routeMapResource",
        resource_group_name="string",
        virtual_hub_name="string",
        associated_inbound_connections=["string"],
        associated_outbound_connections=["string"],
        id="string",
        route_map_name="string",
        rules=[azure_native.network.RouteMapRuleArgs(
            actions=[azure_native.network.ActionArgs(
                parameters=[azure_native.network.ParameterArgs(
                    as_path=["string"],
                    community=["string"],
                    route_prefix=["string"],
                )],
                type="string",
            )],
            match_criteria=[azure_native.network.CriterionArgs(
                as_path=["string"],
                community=["string"],
                match_condition="string",
                route_prefix=["string"],
            )],
            name="string",
            next_step_if_matched="string",
        )])
    
    const routeMapResource = new azure_native.network.RouteMap("routeMapResource", {
        resourceGroupName: "string",
        virtualHubName: "string",
        associatedInboundConnections: ["string"],
        associatedOutboundConnections: ["string"],
        id: "string",
        routeMapName: "string",
        rules: [{
            actions: [{
                parameters: [{
                    asPath: ["string"],
                    community: ["string"],
                    routePrefix: ["string"],
                }],
                type: "string",
            }],
            matchCriteria: [{
                asPath: ["string"],
                community: ["string"],
                matchCondition: "string",
                routePrefix: ["string"],
            }],
            name: "string",
            nextStepIfMatched: "string",
        }],
    });
    
    type: azure-native:network:RouteMap
    properties:
        associatedInboundConnections:
            - string
        associatedOutboundConnections:
            - string
        id: string
        resourceGroupName: string
        routeMapName: string
        rules:
            - actions:
                - parameters:
                    - asPath:
                        - string
                      community:
                        - string
                      routePrefix:
                        - string
                  type: string
              matchCriteria:
                - asPath:
                    - string
                  community:
                    - string
                  matchCondition: string
                  routePrefix:
                    - string
              name: string
              nextStepIfMatched: string
        virtualHubName: string
    

    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

    The RouteMap resource accepts the following input properties:

    ResourceGroupName string
    The resource group name of the RouteMap's resource group.
    VirtualHubName string
    The name of the VirtualHub containing the RouteMap.
    AssociatedInboundConnections List<string>
    List of connections which have this RoutMap associated for inbound traffic.
    AssociatedOutboundConnections List<string>
    List of connections which have this RoutMap associated for outbound traffic.
    Id string
    Resource ID.
    RouteMapName string
    The name of the RouteMap.
    Rules List<Pulumi.AzureNative.Network.Inputs.RouteMapRule>
    List of RouteMap rules to be applied.
    ResourceGroupName string
    The resource group name of the RouteMap's resource group.
    VirtualHubName string
    The name of the VirtualHub containing the RouteMap.
    AssociatedInboundConnections []string
    List of connections which have this RoutMap associated for inbound traffic.
    AssociatedOutboundConnections []string
    List of connections which have this RoutMap associated for outbound traffic.
    Id string
    Resource ID.
    RouteMapName string
    The name of the RouteMap.
    Rules []RouteMapRuleArgs
    List of RouteMap rules to be applied.
    resourceGroupName String
    The resource group name of the RouteMap's resource group.
    virtualHubName String
    The name of the VirtualHub containing the RouteMap.
    associatedInboundConnections List<String>
    List of connections which have this RoutMap associated for inbound traffic.
    associatedOutboundConnections List<String>
    List of connections which have this RoutMap associated for outbound traffic.
    id String
    Resource ID.
    routeMapName String
    The name of the RouteMap.
    rules List<RouteMapRule>
    List of RouteMap rules to be applied.
    resourceGroupName string
    The resource group name of the RouteMap's resource group.
    virtualHubName string
    The name of the VirtualHub containing the RouteMap.
    associatedInboundConnections string[]
    List of connections which have this RoutMap associated for inbound traffic.
    associatedOutboundConnections string[]
    List of connections which have this RoutMap associated for outbound traffic.
    id string
    Resource ID.
    routeMapName string
    The name of the RouteMap.
    rules RouteMapRule[]
    List of RouteMap rules to be applied.
    resource_group_name str
    The resource group name of the RouteMap's resource group.
    virtual_hub_name str
    The name of the VirtualHub containing the RouteMap.
    associated_inbound_connections Sequence[str]
    List of connections which have this RoutMap associated for inbound traffic.
    associated_outbound_connections Sequence[str]
    List of connections which have this RoutMap associated for outbound traffic.
    id str
    Resource ID.
    route_map_name str
    The name of the RouteMap.
    rules Sequence[RouteMapRuleArgs]
    List of RouteMap rules to be applied.
    resourceGroupName String
    The resource group name of the RouteMap's resource group.
    virtualHubName String
    The name of the VirtualHub containing the RouteMap.
    associatedInboundConnections List<String>
    List of connections which have this RoutMap associated for inbound traffic.
    associatedOutboundConnections List<String>
    List of connections which have this RoutMap associated for outbound traffic.
    id String
    Resource ID.
    routeMapName String
    The name of the RouteMap.
    rules List<Property Map>
    List of RouteMap rules to be applied.

    Outputs

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

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    ProvisioningState string
    The provisioning state of the RouteMap resource.
    Type string
    Resource type.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    ProvisioningState string
    The provisioning state of the RouteMap resource.
    Type string
    Resource type.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    provisioningState String
    The provisioning state of the RouteMap resource.
    type String
    Resource type.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    provisioningState string
    The provisioning state of the RouteMap resource.
    type string
    Resource type.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    provisioning_state str
    The provisioning state of the RouteMap resource.
    type str
    Resource type.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    provisioningState String
    The provisioning state of the RouteMap resource.
    type String
    Resource type.

    Supporting Types

    Action, ActionArgs

    Parameters List<Pulumi.AzureNative.Network.Inputs.Parameter>
    List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added
    Type string | Pulumi.AzureNative.Network.RouteMapActionType
    Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'
    Parameters []Parameter
    List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added
    Type string | RouteMapActionType
    Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'
    parameters List<Parameter>
    List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added
    type String | RouteMapActionType
    Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'
    parameters Parameter[]
    List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added
    type string | RouteMapActionType
    Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'
    parameters Sequence[Parameter]
    List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added
    type str | RouteMapActionType
    Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'
    parameters List<Property Map>
    List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added
    type String | "Unknown" | "Remove" | "Add" | "Replace" | "Drop"
    Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'

    ActionResponse, ActionResponseArgs

    Parameters List<Pulumi.AzureNative.Network.Inputs.ParameterResponse>
    List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added
    Type string
    Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'
    Parameters []ParameterResponse
    List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added
    Type string
    Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'
    parameters List<ParameterResponse>
    List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added
    type String
    Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'
    parameters ParameterResponse[]
    List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added
    type string
    Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'
    parameters Sequence[ParameterResponse]
    List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added
    type str
    Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'
    parameters List<Property Map>
    List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added
    type String
    Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'

    Criterion, CriterionArgs

    AsPath List<string>
    List of AS paths which this criteria matches.
    Community List<string>
    List of BGP communities which this criteria matches.
    MatchCondition string | Pulumi.AzureNative.Network.RouteMapMatchCondition
    Match condition to apply RouteMap rules.
    RoutePrefix List<string>
    List of route prefixes which this criteria matches.
    AsPath []string
    List of AS paths which this criteria matches.
    Community []string
    List of BGP communities which this criteria matches.
    MatchCondition string | RouteMapMatchCondition
    Match condition to apply RouteMap rules.
    RoutePrefix []string
    List of route prefixes which this criteria matches.
    asPath List<String>
    List of AS paths which this criteria matches.
    community List<String>
    List of BGP communities which this criteria matches.
    matchCondition String | RouteMapMatchCondition
    Match condition to apply RouteMap rules.
    routePrefix List<String>
    List of route prefixes which this criteria matches.
    asPath string[]
    List of AS paths which this criteria matches.
    community string[]
    List of BGP communities which this criteria matches.
    matchCondition string | RouteMapMatchCondition
    Match condition to apply RouteMap rules.
    routePrefix string[]
    List of route prefixes which this criteria matches.
    as_path Sequence[str]
    List of AS paths which this criteria matches.
    community Sequence[str]
    List of BGP communities which this criteria matches.
    match_condition str | RouteMapMatchCondition
    Match condition to apply RouteMap rules.
    route_prefix Sequence[str]
    List of route prefixes which this criteria matches.
    asPath List<String>
    List of AS paths which this criteria matches.
    community List<String>
    List of BGP communities which this criteria matches.
    matchCondition String | "Unknown" | "Contains" | "Equals" | "NotContains" | "NotEquals"
    Match condition to apply RouteMap rules.
    routePrefix List<String>
    List of route prefixes which this criteria matches.

    CriterionResponse, CriterionResponseArgs

    AsPath List<string>
    List of AS paths which this criteria matches.
    Community List<string>
    List of BGP communities which this criteria matches.
    MatchCondition string
    Match condition to apply RouteMap rules.
    RoutePrefix List<string>
    List of route prefixes which this criteria matches.
    AsPath []string
    List of AS paths which this criteria matches.
    Community []string
    List of BGP communities which this criteria matches.
    MatchCondition string
    Match condition to apply RouteMap rules.
    RoutePrefix []string
    List of route prefixes which this criteria matches.
    asPath List<String>
    List of AS paths which this criteria matches.
    community List<String>
    List of BGP communities which this criteria matches.
    matchCondition String
    Match condition to apply RouteMap rules.
    routePrefix List<String>
    List of route prefixes which this criteria matches.
    asPath string[]
    List of AS paths which this criteria matches.
    community string[]
    List of BGP communities which this criteria matches.
    matchCondition string
    Match condition to apply RouteMap rules.
    routePrefix string[]
    List of route prefixes which this criteria matches.
    as_path Sequence[str]
    List of AS paths which this criteria matches.
    community Sequence[str]
    List of BGP communities which this criteria matches.
    match_condition str
    Match condition to apply RouteMap rules.
    route_prefix Sequence[str]
    List of route prefixes which this criteria matches.
    asPath List<String>
    List of AS paths which this criteria matches.
    community List<String>
    List of BGP communities which this criteria matches.
    matchCondition String
    Match condition to apply RouteMap rules.
    routePrefix List<String>
    List of route prefixes which this criteria matches.

    NextStep, NextStepArgs

    Unknown
    Unknown
    Continue
    Continue
    Terminate
    Terminate
    NextStepUnknown
    Unknown
    NextStepContinue
    Continue
    NextStepTerminate
    Terminate
    Unknown
    Unknown
    Continue
    Continue
    Terminate
    Terminate
    Unknown
    Unknown
    Continue
    Continue
    Terminate
    Terminate
    UNKNOWN
    Unknown
    CONTINUE_
    Continue
    TERMINATE
    Terminate
    "Unknown"
    Unknown
    "Continue"
    Continue
    "Terminate"
    Terminate

    Parameter, ParameterArgs

    AsPath List<string>
    List of AS paths.
    Community List<string>
    List of BGP communities.
    RoutePrefix List<string>
    List of route prefixes.
    AsPath []string
    List of AS paths.
    Community []string
    List of BGP communities.
    RoutePrefix []string
    List of route prefixes.
    asPath List<String>
    List of AS paths.
    community List<String>
    List of BGP communities.
    routePrefix List<String>
    List of route prefixes.
    asPath string[]
    List of AS paths.
    community string[]
    List of BGP communities.
    routePrefix string[]
    List of route prefixes.
    as_path Sequence[str]
    List of AS paths.
    community Sequence[str]
    List of BGP communities.
    route_prefix Sequence[str]
    List of route prefixes.
    asPath List<String>
    List of AS paths.
    community List<String>
    List of BGP communities.
    routePrefix List<String>
    List of route prefixes.

    ParameterResponse, ParameterResponseArgs

    AsPath List<string>
    List of AS paths.
    Community List<string>
    List of BGP communities.
    RoutePrefix List<string>
    List of route prefixes.
    AsPath []string
    List of AS paths.
    Community []string
    List of BGP communities.
    RoutePrefix []string
    List of route prefixes.
    asPath List<String>
    List of AS paths.
    community List<String>
    List of BGP communities.
    routePrefix List<String>
    List of route prefixes.
    asPath string[]
    List of AS paths.
    community string[]
    List of BGP communities.
    routePrefix string[]
    List of route prefixes.
    as_path Sequence[str]
    List of AS paths.
    community Sequence[str]
    List of BGP communities.
    route_prefix Sequence[str]
    List of route prefixes.
    asPath List<String>
    List of AS paths.
    community List<String>
    List of BGP communities.
    routePrefix List<String>
    List of route prefixes.

    RouteMapActionType, RouteMapActionTypeArgs

    Unknown
    Unknown
    Remove
    Remove
    Add
    Add
    Replace
    Replace
    Drop
    Drop
    RouteMapActionTypeUnknown
    Unknown
    RouteMapActionTypeRemove
    Remove
    RouteMapActionTypeAdd
    Add
    RouteMapActionTypeReplace
    Replace
    RouteMapActionTypeDrop
    Drop
    Unknown
    Unknown
    Remove
    Remove
    Add
    Add
    Replace
    Replace
    Drop
    Drop
    Unknown
    Unknown
    Remove
    Remove
    Add
    Add
    Replace
    Replace
    Drop
    Drop
    UNKNOWN
    Unknown
    REMOVE
    Remove
    ADD
    Add
    REPLACE
    Replace
    DROP
    Drop
    "Unknown"
    Unknown
    "Remove"
    Remove
    "Add"
    Add
    "Replace"
    Replace
    "Drop"
    Drop

    RouteMapMatchCondition, RouteMapMatchConditionArgs

    Unknown
    Unknown
    Contains
    Contains
    EqualsValue
    Equals
    NotContains
    NotContains
    NotEquals
    NotEquals
    RouteMapMatchConditionUnknown
    Unknown
    RouteMapMatchConditionContains
    Contains
    RouteMapMatchConditionEquals
    Equals
    RouteMapMatchConditionNotContains
    NotContains
    RouteMapMatchConditionNotEquals
    NotEquals
    Unknown
    Unknown
    Contains
    Contains
    Equals
    Equals
    NotContains
    NotContains
    NotEquals
    NotEquals
    Unknown
    Unknown
    Contains
    Contains
    Equals
    Equals
    NotContains
    NotContains
    NotEquals
    NotEquals
    UNKNOWN
    Unknown
    CONTAINS
    Contains
    EQUALS
    Equals
    NOT_CONTAINS
    NotContains
    NOT_EQUALS
    NotEquals
    "Unknown"
    Unknown
    "Contains"
    Contains
    "Equals"
    Equals
    "NotContains"
    NotContains
    "NotEquals"
    NotEquals

    RouteMapRule, RouteMapRuleArgs

    Actions List<Pulumi.AzureNative.Network.Inputs.Action>
    List of actions which will be applied on a match.
    MatchCriteria List<Pulumi.AzureNative.Network.Inputs.Criterion>
    List of matching criterion which will be applied to traffic.
    Name string
    The unique name for the rule.
    NextStepIfMatched string | Pulumi.AzureNative.Network.NextStep
    Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.
    Actions []Action
    List of actions which will be applied on a match.
    MatchCriteria []Criterion
    List of matching criterion which will be applied to traffic.
    Name string
    The unique name for the rule.
    NextStepIfMatched string | NextStep
    Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.
    actions List<Action>
    List of actions which will be applied on a match.
    matchCriteria List<Criterion>
    List of matching criterion which will be applied to traffic.
    name String
    The unique name for the rule.
    nextStepIfMatched String | NextStep
    Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.
    actions Action[]
    List of actions which will be applied on a match.
    matchCriteria Criterion[]
    List of matching criterion which will be applied to traffic.
    name string
    The unique name for the rule.
    nextStepIfMatched string | NextStep
    Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.
    actions Sequence[Action]
    List of actions which will be applied on a match.
    match_criteria Sequence[Criterion]
    List of matching criterion which will be applied to traffic.
    name str
    The unique name for the rule.
    next_step_if_matched str | NextStep
    Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.
    actions List<Property Map>
    List of actions which will be applied on a match.
    matchCriteria List<Property Map>
    List of matching criterion which will be applied to traffic.
    name String
    The unique name for the rule.
    nextStepIfMatched String | "Unknown" | "Continue" | "Terminate"
    Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.

    RouteMapRuleResponse, RouteMapRuleResponseArgs

    Actions List<Pulumi.AzureNative.Network.Inputs.ActionResponse>
    List of actions which will be applied on a match.
    MatchCriteria List<Pulumi.AzureNative.Network.Inputs.CriterionResponse>
    List of matching criterion which will be applied to traffic.
    Name string
    The unique name for the rule.
    NextStepIfMatched string
    Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.
    Actions []ActionResponse
    List of actions which will be applied on a match.
    MatchCriteria []CriterionResponse
    List of matching criterion which will be applied to traffic.
    Name string
    The unique name for the rule.
    NextStepIfMatched string
    Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.
    actions List<ActionResponse>
    List of actions which will be applied on a match.
    matchCriteria List<CriterionResponse>
    List of matching criterion which will be applied to traffic.
    name String
    The unique name for the rule.
    nextStepIfMatched String
    Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.
    actions ActionResponse[]
    List of actions which will be applied on a match.
    matchCriteria CriterionResponse[]
    List of matching criterion which will be applied to traffic.
    name string
    The unique name for the rule.
    nextStepIfMatched string
    Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.
    actions Sequence[ActionResponse]
    List of actions which will be applied on a match.
    match_criteria Sequence[CriterionResponse]
    List of matching criterion which will be applied to traffic.
    name str
    The unique name for the rule.
    next_step_if_matched str
    Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.
    actions List<Property Map>
    List of actions which will be applied on a match.
    matchCriteria List<Property Map>
    List of matching criterion which will be applied to traffic.
    name String
    The unique name for the rule.
    nextStepIfMatched String
    Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:network:RouteMap routeMap1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi