Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Equinix
  3. API Docs
  4. fabric
  5. getRouteAggregationRule
Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix
equinix/pulumi-equinix

equinix.fabric.getRouteAggregationRule

Explore with Pulumi AI

equinix logo
Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix
equinix/pulumi-equinix

    Fabric V4 API compatible data resource that allow user to fetch Equinix Fabric Route Aggregation Rule by UUID Additional Documentation:

    • API: https://developer.equinix.com/catalog/fabricv4#tag/Route-Aggregations

    Example Usage

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

const raRule = equinix.fabric.getRouteAggregationRule({
    routeAggregationId: "<route_aggregation_id>",
    routeAggregationRuleId: "<route_aggregation_rule_id>",
});
export const routeAggregationRuleName = raRule.then(raRule => raRule.name);
export const routeAggregationRuleDescription = raRule.then(raRule => raRule.description);
export const routeAggregationRuleType = raRule.then(raRule => raRule.type);
export const routeAggregationRulePrefix = raRule.then(raRule => raRule.prefix);
export const routeAggregationRuleState = raRule.then(raRule => raRule.state);

    import pulumi
import pulumi_equinix as equinix

ra_rule = equinix.fabric.get_route_aggregation_rule(route_aggregation_id="<route_aggregation_id>",
    route_aggregation_rule_id="<route_aggregation_rule_id>")
pulumi.export("routeAggregationRuleName", ra_rule.name)
pulumi.export("routeAggregationRuleDescription", ra_rule.description)
pulumi.export("routeAggregationRuleType", ra_rule.type)
pulumi.export("routeAggregationRulePrefix", ra_rule.prefix)
pulumi.export("routeAggregationRuleState", ra_rule.state)

    package main

import (
	"github.com/equinix/pulumi-equinix/sdk/go/equinix/fabric"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		raRule, err := fabric.LookupRouteAggregationRule(ctx, &fabric.LookupRouteAggregationRuleArgs{
			RouteAggregationId:     "<route_aggregation_id>",
			RouteAggregationRuleId: "<route_aggregation_rule_id>",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("routeAggregationRuleName", raRule.Name)
		ctx.Export("routeAggregationRuleDescription", raRule.Description)
		ctx.Export("routeAggregationRuleType", raRule.Type)
		ctx.Export("routeAggregationRulePrefix", raRule.Prefix)
		ctx.Export("routeAggregationRuleState", raRule.State)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var raRule = Equinix.Fabric.GetRouteAggregationRule.Invoke(new()
    {
        RouteAggregationId = "<route_aggregation_id>",
        RouteAggregationRuleId = "<route_aggregation_rule_id>",
    });

    return new Dictionary<string, object?>
    {
        ["routeAggregationRuleName"] = raRule.Apply(getRouteAggregationRuleResult => getRouteAggregationRuleResult.Name),
        ["routeAggregationRuleDescription"] = raRule.Apply(getRouteAggregationRuleResult => getRouteAggregationRuleResult.Description),
        ["routeAggregationRuleType"] = raRule.Apply(getRouteAggregationRuleResult => getRouteAggregationRuleResult.Type),
        ["routeAggregationRulePrefix"] = raRule.Apply(getRouteAggregationRuleResult => getRouteAggregationRuleResult.Prefix),
        ["routeAggregationRuleState"] = raRule.Apply(getRouteAggregationRuleResult => getRouteAggregationRuleResult.State),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.fabric.FabricFunctions;
import com.pulumi.equinix.fabric.inputs.GetRouteAggregationRuleArgs;
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 raRule = FabricFunctions.getRouteAggregationRule(GetRouteAggregationRuleArgs.builder()
            .routeAggregationId("<route_aggregation_id>")
            .routeAggregationRuleId("<route_aggregation_rule_id>")
            .build());

        ctx.export("routeAggregationRuleName", raRule.applyValue(getRouteAggregationRuleResult -> getRouteAggregationRuleResult.name()));
        ctx.export("routeAggregationRuleDescription", raRule.applyValue(getRouteAggregationRuleResult -> getRouteAggregationRuleResult.description()));
        ctx.export("routeAggregationRuleType", raRule.applyValue(getRouteAggregationRuleResult -> getRouteAggregationRuleResult.type()));
        ctx.export("routeAggregationRulePrefix", raRule.applyValue(getRouteAggregationRuleResult -> getRouteAggregationRuleResult.prefix()));
        ctx.export("routeAggregationRuleState", raRule.applyValue(getRouteAggregationRuleResult -> getRouteAggregationRuleResult.state()));
    }
}

    variables:
  raRule:
    fn::invoke:
      function: equinix:fabric:getRouteAggregationRule
      arguments:
        routeAggregationId: <route_aggregation_id>
        routeAggregationRuleId: <route_aggregation_rule_id>
outputs:
  routeAggregationRuleName: ${raRule.name}
  routeAggregationRuleDescription: ${raRule.description}
  routeAggregationRuleType: ${raRule.type}
  routeAggregationRulePrefix: ${raRule.prefix}
  routeAggregationRuleState: ${raRule.state}

    Using getRouteAggregationRule

    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 getRouteAggregationRule(args: GetRouteAggregationRuleArgs, opts?: InvokeOptions): Promise<GetRouteAggregationRuleResult>
function getRouteAggregationRuleOutput(args: GetRouteAggregationRuleOutputArgs, opts?: InvokeOptions): Output<GetRouteAggregationRuleResult>
    def get_route_aggregation_rule(description: Optional[str] = None,
                               route_aggregation_id: Optional[str] = None,
                               route_aggregation_rule_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetRouteAggregationRuleResult
def get_route_aggregation_rule_output(description: Optional[pulumi.Input[str]] = None,
                               route_aggregation_id: Optional[pulumi.Input[str]] = None,
                               route_aggregation_rule_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetRouteAggregationRuleResult]
    func LookupRouteAggregationRule(ctx *Context, args *LookupRouteAggregationRuleArgs, opts ...InvokeOption) (*LookupRouteAggregationRuleResult, error)
func LookupRouteAggregationRuleOutput(ctx *Context, args *LookupRouteAggregationRuleOutputArgs, opts ...InvokeOption) LookupRouteAggregationRuleResultOutput

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

    public static class GetRouteAggregationRule 
{
    public static Task<GetRouteAggregationRuleResult> InvokeAsync(GetRouteAggregationRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteAggregationRuleResult> Invoke(GetRouteAggregationRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRouteAggregationRuleResult> getRouteAggregationRule(GetRouteAggregationRuleArgs args, InvokeOptions options)
public static Output<GetRouteAggregationRuleResult> getRouteAggregationRule(GetRouteAggregationRuleArgs args, InvokeOptions options)

    fn::invoke:
  function: equinix:fabric/getRouteAggregationRule:getRouteAggregationRule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    RouteAggregationId string
    The uuid of the route aggregation this data source should retrieve
    RouteAggregationRuleId string
    The uuid of the route aggregation rule this data source should retrieve
    Description string
    Customer-provided route aggregation rule description
    RouteAggregationId string
    The uuid of the route aggregation this data source should retrieve
    RouteAggregationRuleId string
    The uuid of the route aggregation rule this data source should retrieve
    Description string
    Customer-provided route aggregation rule description
    routeAggregationId String
    The uuid of the route aggregation this data source should retrieve
    routeAggregationRuleId String
    The uuid of the route aggregation rule this data source should retrieve
    description String
    Customer-provided route aggregation rule description
    routeAggregationId string
    The uuid of the route aggregation this data source should retrieve
    routeAggregationRuleId string
    The uuid of the route aggregation rule this data source should retrieve
    description string
    Customer-provided route aggregation rule description
    route_aggregation_id str
    The uuid of the route aggregation this data source should retrieve
    route_aggregation_rule_id str
    The uuid of the route aggregation rule this data source should retrieve
    description str
    Customer-provided route aggregation rule description
    routeAggregationId String
    The uuid of the route aggregation this data source should retrieve
    routeAggregationRuleId String
    The uuid of the route aggregation rule this data source should retrieve
    description String
    Customer-provided route aggregation rule description

    getRouteAggregationRule Result

    The following output properties are available:

    Change GetRouteAggregationRuleChange
    Current state of latest route aggregation rule change
    ChangeLog GetRouteAggregationRuleChangeLog
    Details of the last change on the stream resource
    Href string
    Equinix auto generated URI to the route aggregation rule resource
    Id string
    The unique identifier of the resource
    Name string
    Customer provided name of the route aggregation rule
    Prefix string
    Customer-provided route aggregation rule prefix
    RouteAggregationId string
    The uuid of the route aggregation this data source should retrieve
    RouteAggregationRuleId string
    The uuid of the route aggregation rule this data source should retrieve
    State string
    Value representing provisioning status for the route aggregation rule resource
    Type string
    Equinix defined Route Aggregation Type; BGPIPv4PREFIXAGGREGATION, BGPIPv6PREFIXAGGREGATION
    Uuid string
    Equinix-assigned unique id for the route aggregation rule resource
    Description string
    Customer-provided route aggregation rule description
    Change GetRouteAggregationRuleChange
    Current state of latest route aggregation rule change
    ChangeLog GetRouteAggregationRuleChangeLog
    Details of the last change on the stream resource
    Href string
    Equinix auto generated URI to the route aggregation rule resource
    Id string
    The unique identifier of the resource
    Name string
    Customer provided name of the route aggregation rule
    Prefix string
    Customer-provided route aggregation rule prefix
    RouteAggregationId string
    The uuid of the route aggregation this data source should retrieve
    RouteAggregationRuleId string
    The uuid of the route aggregation rule this data source should retrieve
    State string
    Value representing provisioning status for the route aggregation rule resource
    Type string
    Equinix defined Route Aggregation Type; BGPIPv4PREFIXAGGREGATION, BGPIPv6PREFIXAGGREGATION
    Uuid string
    Equinix-assigned unique id for the route aggregation rule resource
    Description string
    Customer-provided route aggregation rule description
    change GetRouteAggregationRuleChange
    Current state of latest route aggregation rule change
    changeLog GetRouteAggregationRuleChangeLog
    Details of the last change on the stream resource
    href String
    Equinix auto generated URI to the route aggregation rule resource
    id String
    The unique identifier of the resource
    name String
    Customer provided name of the route aggregation rule
    prefix String
    Customer-provided route aggregation rule prefix
    routeAggregationId String
    The uuid of the route aggregation this data source should retrieve
    routeAggregationRuleId String
    The uuid of the route aggregation rule this data source should retrieve
    state String
    Value representing provisioning status for the route aggregation rule resource
    type String
    Equinix defined Route Aggregation Type; BGPIPv4PREFIXAGGREGATION, BGPIPv6PREFIXAGGREGATION
    uuid String
    Equinix-assigned unique id for the route aggregation rule resource
    description String
    Customer-provided route aggregation rule description
    change GetRouteAggregationRuleChange
    Current state of latest route aggregation rule change
    changeLog GetRouteAggregationRuleChangeLog
    Details of the last change on the stream resource
    href string
    Equinix auto generated URI to the route aggregation rule resource
    id string
    The unique identifier of the resource
    name string
    Customer provided name of the route aggregation rule
    prefix string
    Customer-provided route aggregation rule prefix
    routeAggregationId string
    The uuid of the route aggregation this data source should retrieve
    routeAggregationRuleId string
    The uuid of the route aggregation rule this data source should retrieve
    state string
    Value representing provisioning status for the route aggregation rule resource
    type string
    Equinix defined Route Aggregation Type; BGPIPv4PREFIXAGGREGATION, BGPIPv6PREFIXAGGREGATION
    uuid string
    Equinix-assigned unique id for the route aggregation rule resource
    description string
    Customer-provided route aggregation rule description
    change GetRouteAggregationRuleChange
    Current state of latest route aggregation rule change
    change_log GetRouteAggregationRuleChangeLog
    Details of the last change on the stream resource
    href str
    Equinix auto generated URI to the route aggregation rule resource
    id str
    The unique identifier of the resource
    name str
    Customer provided name of the route aggregation rule
    prefix str
    Customer-provided route aggregation rule prefix
    route_aggregation_id str
    The uuid of the route aggregation this data source should retrieve
    route_aggregation_rule_id str
    The uuid of the route aggregation rule this data source should retrieve
    state str
    Value representing provisioning status for the route aggregation rule resource
    type str
    Equinix defined Route Aggregation Type; BGPIPv4PREFIXAGGREGATION, BGPIPv6PREFIXAGGREGATION
    uuid str
    Equinix-assigned unique id for the route aggregation rule resource
    description str
    Customer-provided route aggregation rule description
    change Property Map
    Current state of latest route aggregation rule change
    changeLog Property Map
    Details of the last change on the stream resource
    href String
    Equinix auto generated URI to the route aggregation rule resource
    id String
    The unique identifier of the resource
    name String
    Customer provided name of the route aggregation rule
    prefix String
    Customer-provided route aggregation rule prefix
    routeAggregationId String
    The uuid of the route aggregation this data source should retrieve
    routeAggregationRuleId String
    The uuid of the route aggregation rule this data source should retrieve
    state String
    Value representing provisioning status for the route aggregation rule resource
    type String
    Equinix defined Route Aggregation Type; BGPIPv4PREFIXAGGREGATION, BGPIPv6PREFIXAGGREGATION
    uuid String
    Equinix-assigned unique id for the route aggregation rule resource
    description String
    Customer-provided route aggregation rule description

    Supporting Types

    GetRouteAggregationRuleChange

    Href string
    Equinix auto generated URI to the route aggregation change
    Type string
    Equinix defined Route Aggregation Change Type
    Uuid string
    Equinix-assigned unique id for a change
    Href string
    Equinix auto generated URI to the route aggregation change
    Type string
    Equinix defined Route Aggregation Change Type
    Uuid string
    Equinix-assigned unique id for a change
    href String
    Equinix auto generated URI to the route aggregation change
    type String
    Equinix defined Route Aggregation Change Type
    uuid String
    Equinix-assigned unique id for a change
    href string
    Equinix auto generated URI to the route aggregation change
    type string
    Equinix defined Route Aggregation Change Type
    uuid string
    Equinix-assigned unique id for a change
    href str
    Equinix auto generated URI to the route aggregation change
    type str
    Equinix defined Route Aggregation Change Type
    uuid str
    Equinix-assigned unique id for a change
    href String
    Equinix auto generated URI to the route aggregation change
    type String
    Equinix defined Route Aggregation Change Type
    uuid String
    Equinix-assigned unique id for a change

    GetRouteAggregationRuleChangeLog

    CreatedBy string
    User name of creator of the stream resource
    CreatedByEmail string
    Email of creator of the stream resource
    CreatedByFullName string
    Legal name of creator of the stream resource
    CreatedDateTime string
    Creation time of the stream resource
    DeletedBy string
    User name of deleter of the stream resource
    DeletedByEmail string
    Email of deleter of the stream resource
    DeletedByFullName string
    Legal name of deleter of the stream resource
    DeletedDateTime string
    Deletion time of the stream resource
    UpdatedBy string
    User name of last updater of the stream resource
    UpdatedByEmail string
    Email of last updater of the stream resource
    UpdatedByFullName string
    Legal name of last updater of the stream resource
    UpdatedDateTime string
    Last update time of the stream resource
    CreatedBy string
    User name of creator of the stream resource
    CreatedByEmail string
    Email of creator of the stream resource
    CreatedByFullName string
    Legal name of creator of the stream resource
    CreatedDateTime string
    Creation time of the stream resource
    DeletedBy string
    User name of deleter of the stream resource
    DeletedByEmail string
    Email of deleter of the stream resource
    DeletedByFullName string
    Legal name of deleter of the stream resource
    DeletedDateTime string
    Deletion time of the stream resource
    UpdatedBy string
    User name of last updater of the stream resource
    UpdatedByEmail string
    Email of last updater of the stream resource
    UpdatedByFullName string
    Legal name of last updater of the stream resource
    UpdatedDateTime string
    Last update time of the stream resource
    createdBy String
    User name of creator of the stream resource
    createdByEmail String
    Email of creator of the stream resource
    createdByFullName String
    Legal name of creator of the stream resource
    createdDateTime String
    Creation time of the stream resource
    deletedBy String
    User name of deleter of the stream resource
    deletedByEmail String
    Email of deleter of the stream resource
    deletedByFullName String
    Legal name of deleter of the stream resource
    deletedDateTime String
    Deletion time of the stream resource
    updatedBy String
    User name of last updater of the stream resource
    updatedByEmail String
    Email of last updater of the stream resource
    updatedByFullName String
    Legal name of last updater of the stream resource
    updatedDateTime String
    Last update time of the stream resource
    createdBy string
    User name of creator of the stream resource
    createdByEmail string
    Email of creator of the stream resource
    createdByFullName string
    Legal name of creator of the stream resource
    createdDateTime string
    Creation time of the stream resource
    deletedBy string
    User name of deleter of the stream resource
    deletedByEmail string
    Email of deleter of the stream resource
    deletedByFullName string
    Legal name of deleter of the stream resource
    deletedDateTime string
    Deletion time of the stream resource
    updatedBy string
    User name of last updater of the stream resource
    updatedByEmail string
    Email of last updater of the stream resource
    updatedByFullName string
    Legal name of last updater of the stream resource
    updatedDateTime string
    Last update time of the stream resource
    created_by str
    User name of creator of the stream resource
    created_by_email str
    Email of creator of the stream resource
    created_by_full_name str
    Legal name of creator of the stream resource
    created_date_time str
    Creation time of the stream resource
    deleted_by str
    User name of deleter of the stream resource
    deleted_by_email str
    Email of deleter of the stream resource
    deleted_by_full_name str
    Legal name of deleter of the stream resource
    deleted_date_time str
    Deletion time of the stream resource
    updated_by str
    User name of last updater of the stream resource
    updated_by_email str
    Email of last updater of the stream resource
    updated_by_full_name str
    Legal name of last updater of the stream resource
    updated_date_time str
    Last update time of the stream resource
    createdBy String
    User name of creator of the stream resource
    createdByEmail String
    Email of creator of the stream resource
    createdByFullName String
    Legal name of creator of the stream resource
    createdDateTime String
    Creation time of the stream resource
    deletedBy String
    User name of deleter of the stream resource
    deletedByEmail String
    Email of deleter of the stream resource
    deletedByFullName String
    Legal name of deleter of the stream resource
    deletedDateTime String
    Deletion time of the stream resource
    updatedBy String
    User name of last updater of the stream resource
    updatedByEmail String
    Email of last updater of the stream resource
    updatedByFullName String
    Legal name of last updater of the stream resource
    updatedDateTime String
    Last update time of the stream resource

    Package Details

    Repository
    equinix equinix/pulumi-equinix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the equinix Terraform Provider.
    equinix logo
    Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix
    equinix/pulumi-equinix