Azure Classic v5.43.0, May 6 23

azure.network.getRouteFilter

Explore with Pulumi AI

Use this data source to access information about an existing Route Filter.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Network.GetRouteFilter.Invoke(new()
    {
        Name = "existing",
        ResourceGroupName = "existing",
    });

    return new Dictionary<string, object?>
    {
        ["id"] = example.Apply(getRouteFilterResult => getRouteFilterResult.Id),
    };
});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := network.LookupRouteFilter(ctx, &network.LookupRouteFilterArgs{
			Name:              "existing",
			ResourceGroupName: "existing",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.network.NetworkFunctions;
import com.pulumi.azure.network.inputs.GetRouteFilterArgs;
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) {
        final var example = NetworkFunctions.getRouteFilter(GetRouteFilterArgs.builder()
            .name("existing")
            .resourceGroupName("existing")
            .build());

        ctx.export("id", example.applyValue(getRouteFilterResult -> getRouteFilterResult.id()));
    }
}

import pulumi
import pulumi_azure as azure

example = azure.network.get_route_filter(name="existing",
    resource_group_name="existing")
pulumi.export("id", example.id)

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

const example = azure.network.getRouteFilter({
    name: "existing",
    resourceGroupName: "existing",
});
export const id = example.then(example => example.id);

variables:
  example:
    fn::invoke:
      Function: azure:network:getRouteFilter
      Arguments:
        name: existing
        resourceGroupName: existing
outputs:
  id: ${example.id}

Using getRouteFilter

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 getRouteFilter(args: GetRouteFilterArgs, opts?: InvokeOptions): Promise<GetRouteFilterResult>
function getRouteFilterOutput(args: GetRouteFilterOutputArgs, opts?: InvokeOptions): Output<GetRouteFilterResult>

def get_route_filter(name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetRouteFilterResult
def get_route_filter_output(name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetRouteFilterResult]

func LookupRouteFilter(ctx *Context, args *LookupRouteFilterArgs, opts ...InvokeOption) (*LookupRouteFilterResult, error)
func LookupRouteFilterOutput(ctx *Context, args *LookupRouteFilterOutputArgs, opts ...InvokeOption) LookupRouteFilterResultOutput

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

public static class GetRouteFilter 
{
    public static Task<GetRouteFilterResult> InvokeAsync(GetRouteFilterArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteFilterResult> Invoke(GetRouteFilterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRouteFilterResult> getRouteFilter(GetRouteFilterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:network/getRouteFilter:getRouteFilter
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The Name of this Route Filter.
ResourceGroupName string: The name of the Resource Group where the Route Filter exists.

Name string: The Name of this Route Filter.
ResourceGroupName string: The name of the Resource Group where the Route Filter exists.

name String: The Name of this Route Filter.
resourceGroupName String: The name of the Resource Group where the Route Filter exists.

name string: The Name of this Route Filter.
resourceGroupName string: The name of the Resource Group where the Route Filter exists.

name str: The Name of this Route Filter.
resource_group_name str: The name of the Resource Group where the Route Filter exists.

name String: The Name of this Route Filter.
resourceGroupName String: The name of the Resource Group where the Route Filter exists.

getRouteFilter Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Location string: The Azure Region where the Route Filter exists.
Name string: The Name of Route Filter Rule
ResourceGroupName string
Rules List<GetRouteFilterRule>: A rule block as defined below.
Tags Dictionary<string, string>: A mapping of tags assigned to the Route Filter.

Id string: The provider-assigned unique ID for this managed resource.
Location string: The Azure Region where the Route Filter exists.
Name string: The Name of Route Filter Rule
ResourceGroupName string
Rules []GetRouteFilterRule: A rule block as defined below.
Tags map[string]string: A mapping of tags assigned to the Route Filter.

id String: The provider-assigned unique ID for this managed resource.
location String: The Azure Region where the Route Filter exists.
name String: The Name of Route Filter Rule
resourceGroupName String
rules List<GetRouteFilterRule>: A rule block as defined below.
tags Map<String,String>: A mapping of tags assigned to the Route Filter.

id string: The provider-assigned unique ID for this managed resource.
location string: The Azure Region where the Route Filter exists.
name string: The Name of Route Filter Rule
resourceGroupName string
rules GetRouteFilterRule[]: A rule block as defined below.
tags {[key: string]: string}: A mapping of tags assigned to the Route Filter.

id str: The provider-assigned unique ID for this managed resource.
location str: The Azure Region where the Route Filter exists.
name str: The Name of Route Filter Rule
resource_group_name str
rules Sequence[GetRouteFilterRule]: A rule block as defined below.
tags Mapping[str, str]: A mapping of tags assigned to the Route Filter.

id String: The provider-assigned unique ID for this managed resource.
location String: The Azure Region where the Route Filter exists.
name String: The Name of Route Filter Rule
resourceGroupName String
rules List<Property Map>: A rule block as defined below.
tags Map<String>: A mapping of tags assigned to the Route Filter.

Supporting Types

GetRouteFilterRule

Access string: The access type of the rule
Communities List<string>: The collection for bgp community values.
Name string: The Name of this Route Filter.
RuleType string: The Route Filter Rule Type.

Access string: The access type of the rule
Communities []string: The collection for bgp community values.
Name string: The Name of this Route Filter.
RuleType string: The Route Filter Rule Type.

access String: The access type of the rule
communities List<String>: The collection for bgp community values.
name String: The Name of this Route Filter.
ruleType String: The Route Filter Rule Type.

access string: The access type of the rule
communities string[]: The collection for bgp community values.
name string: The Name of this Route Filter.
ruleType string: The Route Filter Rule Type.

access str: The access type of the rule
communities Sequence[str]: The collection for bgp community values.
name str: The Name of this Route Filter.
rule_type str: The Route Filter Rule Type.

access String: The access type of the rule
communities List<String>: The collection for bgp community values.
name String: The Name of this Route Filter.
ruleType String: The Route Filter Rule Type.

Package Details

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