Azure Native v2.73.0, Nov 20 24

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.network.getRouteMap

Explore with Pulumi AI

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

Using getRouteMap

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRouteMap(args: GetRouteMapArgs, opts?: InvokeOptions): Promise<GetRouteMapResult>
function getRouteMapOutput(args: GetRouteMapOutputArgs, opts?: InvokeOptions): Output<GetRouteMapResult>

def get_route_map(resource_group_name: Optional[str] = None,
                  route_map_name: Optional[str] = None,
                  virtual_hub_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetRouteMapResult
def get_route_map_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                  route_map_name: Optional[pulumi.Input[str]] = None,
                  virtual_hub_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetRouteMapResult]

func LookupRouteMap(ctx *Context, args *LookupRouteMapArgs, opts ...InvokeOption) (*LookupRouteMapResult, error)
func LookupRouteMapOutput(ctx *Context, args *LookupRouteMapOutputArgs, opts ...InvokeOption) LookupRouteMapResultOutput

> Note: This function is named LookupRouteMap in the Go SDK.

public static class GetRouteMap 
{
    public static Task<GetRouteMapResult> InvokeAsync(GetRouteMapArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteMapResult> Invoke(GetRouteMapInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRouteMapResult> getRouteMap(GetRouteMapArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:network:getRouteMap
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The resource group name of the RouteMap's resource group.
RouteMapName string: The name of the RouteMap.
VirtualHubName string: The name of the VirtualHub containing the RouteMap.

ResourceGroupName string: The resource group name of the RouteMap's resource group.
RouteMapName string: The name of the RouteMap.
VirtualHubName string: The name of the VirtualHub containing the RouteMap.

resourceGroupName String: The resource group name of the RouteMap's resource group.
routeMapName String: The name of the RouteMap.
virtualHubName String: The name of the VirtualHub containing the RouteMap.

resourceGroupName string: The resource group name of the RouteMap's resource group.
routeMapName string: The name of the RouteMap.
virtualHubName string: The name of the VirtualHub containing the RouteMap.

resource_group_name str: The resource group name of the RouteMap's resource group.
route_map_name str: The name of the RouteMap.
virtual_hub_name str: The name of the VirtualHub containing the RouteMap.

resourceGroupName String: The resource group name of the RouteMap's resource group.
routeMapName String: The name of the RouteMap.
virtualHubName String: The name of the VirtualHub containing the RouteMap.

getRouteMap Result

The following output properties are available:

Etag string: A unique read-only string that changes whenever the resource is updated.
Id string: Resource ID.
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.
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.
Rules List<Pulumi.AzureNative.Network.Outputs.RouteMapRuleResponse>: List of RouteMap rules to be applied.

Etag string: A unique read-only string that changes whenever the resource is updated.
Id string: Resource ID.
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.
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.
Rules []RouteMapRuleResponse: List of RouteMap rules to be applied.

etag String: A unique read-only string that changes whenever the resource is updated.
id String: Resource ID.
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.
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.
rules List<RouteMapRuleResponse>: List of RouteMap rules to be applied.

etag string: A unique read-only string that changes whenever the resource is updated.
id string: Resource ID.
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.
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.
rules RouteMapRuleResponse[]: List of RouteMap rules to be applied.

etag str: A unique read-only string that changes whenever the resource is updated.
id str: Resource ID.
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.
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.
rules Sequence[RouteMapRuleResponse]: List of RouteMap rules to be applied.

etag String: A unique read-only string that changes whenever the resource is updated.
id String: Resource ID.
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.
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.
rules List<Property Map>: List of RouteMap rules to be applied.

Supporting Types

ActionResponse

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.'

CriterionResponse

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.

ParameterResponse

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.

RouteMapRuleResponse

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'.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.network.getRouteMap

On this page

On this page

Using getRouteMap

getRouteMap Result

Supporting Types

ActionResponse

CriterionResponse

ParameterResponse

RouteMapRuleResponse

Package Details

On this page

On this page