Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getRouteFilterRule
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getRouteFilterRule

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the specified rule from a route filter.

    Uses Azure REST API version 2024-05-01.

    Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

    Using getRouteFilterRule

    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 getRouteFilterRule(args: GetRouteFilterRuleArgs, opts?: InvokeOptions): Promise<GetRouteFilterRuleResult>
function getRouteFilterRuleOutput(args: GetRouteFilterRuleOutputArgs, opts?: InvokeOptions): Output<GetRouteFilterRuleResult>
    def get_route_filter_rule(resource_group_name: Optional[str] = None,
                          route_filter_name: Optional[str] = None,
                          rule_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetRouteFilterRuleResult
def get_route_filter_rule_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                          route_filter_name: Optional[pulumi.Input[str]] = None,
                          rule_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetRouteFilterRuleResult]
    func LookupRouteFilterRule(ctx *Context, args *LookupRouteFilterRuleArgs, opts ...InvokeOption) (*LookupRouteFilterRuleResult, error)
func LookupRouteFilterRuleOutput(ctx *Context, args *LookupRouteFilterRuleOutputArgs, opts ...InvokeOption) LookupRouteFilterRuleResultOutput

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

    public static class GetRouteFilterRule 
{
    public static Task<GetRouteFilterRuleResult> InvokeAsync(GetRouteFilterRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteFilterRuleResult> Invoke(GetRouteFilterRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRouteFilterRuleResult> getRouteFilterRule(GetRouteFilterRuleArgs args, InvokeOptions options)
public static Output<GetRouteFilterRuleResult> getRouteFilterRule(GetRouteFilterRuleArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group.
    RouteFilterName string
    The name of the route filter.
    RuleName string
    The name of the rule.
    ResourceGroupName string
    The name of the resource group.
    RouteFilterName string
    The name of the route filter.
    RuleName string
    The name of the rule.
    resourceGroupName String
    The name of the resource group.
    routeFilterName String
    The name of the route filter.
    ruleName String
    The name of the rule.
    resourceGroupName string
    The name of the resource group.
    routeFilterName string
    The name of the route filter.
    ruleName string
    The name of the rule.
    resource_group_name str
    The name of the resource group.
    route_filter_name str
    The name of the route filter.
    rule_name str
    The name of the rule.
    resourceGroupName String
    The name of the resource group.
    routeFilterName String
    The name of the route filter.
    ruleName String
    The name of the rule.

    getRouteFilterRule Result

    The following output properties are available:

    Access string
    The access type of the rule.
    AzureApiVersion string
    The Azure API version of the resource.
    Communities List<string>
    The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the route filter rule resource.
    RouteFilterRuleType string
    The rule type of the rule.
    Id string
    Resource ID.
    Location string
    Resource location.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    Access string
    The access type of the rule.
    AzureApiVersion string
    The Azure API version of the resource.
    Communities []string
    The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the route filter rule resource.
    RouteFilterRuleType string
    The rule type of the rule.
    Id string
    Resource ID.
    Location string
    Resource location.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    access String
    The access type of the rule.
    azureApiVersion String
    The Azure API version of the resource.
    communities List<String>
    The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the route filter rule resource.
    routeFilterRuleType String
    The rule type of the rule.
    id String
    Resource ID.
    location String
    Resource location.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    access string
    The access type of the rule.
    azureApiVersion string
    The Azure API version of the resource.
    communities string[]
    The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
    etag string
    A unique read-only string that changes whenever the resource is updated.
    provisioningState string
    The provisioning state of the route filter rule resource.
    routeFilterRuleType string
    The rule type of the rule.
    id string
    Resource ID.
    location string
    Resource location.
    name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    access str
    The access type of the rule.
    azure_api_version str
    The Azure API version of the resource.
    communities Sequence[str]
    The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
    etag str
    A unique read-only string that changes whenever the resource is updated.
    provisioning_state str
    The provisioning state of the route filter rule resource.
    route_filter_rule_type str
    The rule type of the rule.
    id str
    Resource ID.
    location str
    Resource location.
    name str
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    access String
    The access type of the rule.
    azureApiVersion String
    The Azure API version of the resource.
    communities List<String>
    The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the route filter rule resource.
    routeFilterRuleType String
    The rule type of the rule.
    id String
    Resource ID.
    location String
    Resource location.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native