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

equinix.fabric.getRouteAggregationRules

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 Rules with pagination details 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 raRules = equinix.fabric.getRouteAggregationRules({
    routeAggregationId: "<route_aggregation_id>",
    pagination: {
        limit: 2,
        offset: 1,
    },
});
export const routeAggregationRuleName = raRules.then(raRules => raRules.datas?.[0]?.name);
export const routeAggregationRuleDescription = raRules.then(raRules => raRules.datas?.[0]?.description);
export const routeAggregationRulePrefix = raRules.then(raRules => raRules.datas?.[0]?.prefix);
export const routeAggregationRuleState = raRules.then(raRules => raRules.datas?.[0]?.state);

    import pulumi
import pulumi_equinix as equinix

ra_rules = equinix.fabric.get_route_aggregation_rules(route_aggregation_id="<route_aggregation_id>",
    pagination={
        "limit": 2,
        "offset": 1,
    })
pulumi.export("routeAggregationRuleName", ra_rules.datas[0].name)
pulumi.export("routeAggregationRuleDescription", ra_rules.datas[0].description)
pulumi.export("routeAggregationRulePrefix", ra_rules.datas[0].prefix)
pulumi.export("routeAggregationRuleState", ra_rules.datas[0].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 {
		raRules, err := fabric.GetRouteAggregationRules(ctx, &fabric.GetRouteAggregationRulesArgs{
			RouteAggregationId: "<route_aggregation_id>",
			Pagination: fabric.GetRouteAggregationRulesPagination{
				Limit:  2,
				Offset: 1,
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("routeAggregationRuleName", raRules.Datas[0].Name)
		ctx.Export("routeAggregationRuleDescription", raRules.Datas[0].Description)
		ctx.Export("routeAggregationRulePrefix", raRules.Datas[0].Prefix)
		ctx.Export("routeAggregationRuleState", raRules.Datas[0].State)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var raRules = Equinix.Fabric.GetRouteAggregationRules.Invoke(new()
    {
        RouteAggregationId = "<route_aggregation_id>",
        Pagination = new Equinix.Fabric.Inputs.GetRouteAggregationRulesPaginationInputArgs
        {
            Limit = 2,
            Offset = 1,
        },
    });

    return new Dictionary<string, object?>
    {
        ["routeAggregationRuleName"] = raRules.Apply(getRouteAggregationRulesResult => getRouteAggregationRulesResult.Datas[0]?.Name),
        ["routeAggregationRuleDescription"] = raRules.Apply(getRouteAggregationRulesResult => getRouteAggregationRulesResult.Datas[0]?.Description),
        ["routeAggregationRulePrefix"] = raRules.Apply(getRouteAggregationRulesResult => getRouteAggregationRulesResult.Datas[0]?.Prefix),
        ["routeAggregationRuleState"] = raRules.Apply(getRouteAggregationRulesResult => getRouteAggregationRulesResult.Datas[0]?.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.GetRouteAggregationRulesArgs;
import com.pulumi.equinix.fabric.inputs.GetRouteAggregationRulesPaginationArgs;
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 raRules = FabricFunctions.getRouteAggregationRules(GetRouteAggregationRulesArgs.builder()
            .routeAggregationId("<route_aggregation_id>")
            .pagination(GetRouteAggregationRulesPaginationArgs.builder()
                .limit(2)
                .offset(1)
                .build())
            .build());

        ctx.export("routeAggregationRuleName", raRules.applyValue(getRouteAggregationRulesResult -> getRouteAggregationRulesResult.datas()[0].name()));
        ctx.export("routeAggregationRuleDescription", raRules.applyValue(getRouteAggregationRulesResult -> getRouteAggregationRulesResult.datas()[0].description()));
        ctx.export("routeAggregationRulePrefix", raRules.applyValue(getRouteAggregationRulesResult -> getRouteAggregationRulesResult.datas()[0].prefix()));
        ctx.export("routeAggregationRuleState", raRules.applyValue(getRouteAggregationRulesResult -> getRouteAggregationRulesResult.datas()[0].state()));
    }
}

    variables:
  raRules:
    fn::invoke:
      function: equinix:fabric:getRouteAggregationRules
      arguments:
        routeAggregationId: <route_aggregation_id>
        pagination:
          limit: 2
          offset: 1
outputs:
  routeAggregationRuleName: ${raRules.datas[0].name}
  routeAggregationRuleDescription: ${raRules.datas[0].description}
  routeAggregationRulePrefix: ${raRules.datas[0].prefix}
  routeAggregationRuleState: ${raRules.datas[0].state}

    Using getRouteAggregationRules

    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 getRouteAggregationRules(args: GetRouteAggregationRulesArgs, opts?: InvokeOptions): Promise<GetRouteAggregationRulesResult>
function getRouteAggregationRulesOutput(args: GetRouteAggregationRulesOutputArgs, opts?: InvokeOptions): Output<GetRouteAggregationRulesResult>
    def get_route_aggregation_rules(pagination: Optional[GetRouteAggregationRulesPagination] = None,
                                route_aggregation_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetRouteAggregationRulesResult
def get_route_aggregation_rules_output(pagination: Optional[pulumi.Input[GetRouteAggregationRulesPaginationArgs]] = None,
                                route_aggregation_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetRouteAggregationRulesResult]
    func GetRouteAggregationRules(ctx *Context, args *GetRouteAggregationRulesArgs, opts ...InvokeOption) (*GetRouteAggregationRulesResult, error)
func GetRouteAggregationRulesOutput(ctx *Context, args *GetRouteAggregationRulesOutputArgs, opts ...InvokeOption) GetRouteAggregationRulesResultOutput

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

    public static class GetRouteAggregationRules 
{
    public static Task<GetRouteAggregationRulesResult> InvokeAsync(GetRouteAggregationRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteAggregationRulesResult> Invoke(GetRouteAggregationRulesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRouteAggregationRulesResult> getRouteAggregationRules(GetRouteAggregationRulesArgs args, InvokeOptions options)
public static Output<GetRouteAggregationRulesResult> getRouteAggregationRules(GetRouteAggregationRulesArgs args, InvokeOptions options)

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

    The following arguments are supported:

    RouteAggregationId string
    The uuid of the route aggregation rule this data source should retrieve
    Pagination GetRouteAggregationRulesPagination
    Pagination details for the returned route aggregation rules list
    RouteAggregationId string
    The uuid of the route aggregation rule this data source should retrieve
    Pagination GetRouteAggregationRulesPagination
    Pagination details for the returned route aggregation rules list
    routeAggregationId String
    The uuid of the route aggregation rule this data source should retrieve
    pagination GetRouteAggregationRulesPagination
    Pagination details for the returned route aggregation rules list
    routeAggregationId string
    The uuid of the route aggregation rule this data source should retrieve
    pagination GetRouteAggregationRulesPagination
    Pagination details for the returned route aggregation rules list
    route_aggregation_id str
    The uuid of the route aggregation rule this data source should retrieve
    pagination GetRouteAggregationRulesPagination
    Pagination details for the returned route aggregation rules list
    routeAggregationId String
    The uuid of the route aggregation rule this data source should retrieve
    pagination Property Map
    Pagination details for the returned route aggregation rules list

    getRouteAggregationRules Result

    The following output properties are available:

    Datas List<GetRouteAggregationRulesData>
    Returned list of route aggregation rule objects
    Id string
    The unique identifier of the resource
    RouteAggregationId string
    The uuid of the route aggregation rule this data source should retrieve
    Pagination GetRouteAggregationRulesPagination
    Pagination details for the returned route aggregation rules list
    Datas []GetRouteAggregationRulesData
    Returned list of route aggregation rule objects
    Id string
    The unique identifier of the resource
    RouteAggregationId string
    The uuid of the route aggregation rule this data source should retrieve
    Pagination GetRouteAggregationRulesPagination
    Pagination details for the returned route aggregation rules list
    datas List<GetRouteAggregationRulesData>
    Returned list of route aggregation rule objects
    id String
    The unique identifier of the resource
    routeAggregationId String
    The uuid of the route aggregation rule this data source should retrieve
    pagination GetRouteAggregationRulesPagination
    Pagination details for the returned route aggregation rules list
    datas GetRouteAggregationRulesData[]
    Returned list of route aggregation rule objects
    id string
    The unique identifier of the resource
    routeAggregationId string
    The uuid of the route aggregation rule this data source should retrieve
    pagination GetRouteAggregationRulesPagination
    Pagination details for the returned route aggregation rules list
    datas Sequence[GetRouteAggregationRulesData]
    Returned list of route aggregation rule objects
    id str
    The unique identifier of the resource
    route_aggregation_id str
    The uuid of the route aggregation rule this data source should retrieve
    pagination GetRouteAggregationRulesPagination
    Pagination details for the returned route aggregation rules list
    datas List<Property Map>
    Returned list of route aggregation rule objects
    id String
    The unique identifier of the resource
    routeAggregationId String
    The uuid of the route aggregation rule this data source should retrieve
    pagination Property Map
    Pagination details for the returned route aggregation rules list

    Supporting Types

    GetRouteAggregationRulesData

    Change GetRouteAggregationRulesDataChange
    Current state of latest route aggregation rule change
    ChangeLog GetRouteAggregationRulesDataChangeLog
    Details of the last change on the stream resource
    Href string
    Equinix auto generated URI to the route aggregation rule resource
    Name string
    Customer provided name of the route aggregation rule
    Prefix string
    Customer-provided route aggregation rule prefix
    RouteAggregationId string
    UUID of the Route Aggregation to apply this Rule to
    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 GetRouteAggregationRulesDataChange
    Current state of latest route aggregation rule change
    ChangeLog GetRouteAggregationRulesDataChangeLog
    Details of the last change on the stream resource
    Href string
    Equinix auto generated URI to the route aggregation rule resource
    Name string
    Customer provided name of the route aggregation rule
    Prefix string
    Customer-provided route aggregation rule prefix
    RouteAggregationId string
    UUID of the Route Aggregation to apply this Rule to
    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 GetRouteAggregationRulesDataChange
    Current state of latest route aggregation rule change
    changeLog GetRouteAggregationRulesDataChangeLog
    Details of the last change on the stream resource
    href String
    Equinix auto generated URI to the route aggregation rule resource
    name String
    Customer provided name of the route aggregation rule
    prefix String
    Customer-provided route aggregation rule prefix
    routeAggregationId String
    UUID of the Route Aggregation to apply this Rule to
    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 GetRouteAggregationRulesDataChange
    Current state of latest route aggregation rule change
    changeLog GetRouteAggregationRulesDataChangeLog
    Details of the last change on the stream resource
    href string
    Equinix auto generated URI to the route aggregation rule resource
    name string
    Customer provided name of the route aggregation rule
    prefix string
    Customer-provided route aggregation rule prefix
    routeAggregationId string
    UUID of the Route Aggregation to apply this Rule to
    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 GetRouteAggregationRulesDataChange
    Current state of latest route aggregation rule change
    change_log GetRouteAggregationRulesDataChangeLog
    Details of the last change on the stream resource
    href str
    Equinix auto generated URI to the route aggregation rule resource
    name str
    Customer provided name of the route aggregation rule
    prefix str
    Customer-provided route aggregation rule prefix
    route_aggregation_id str
    UUID of the Route Aggregation to apply this Rule to
    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
    name String
    Customer provided name of the route aggregation rule
    prefix String
    Customer-provided route aggregation rule prefix
    routeAggregationId String
    UUID of the Route Aggregation to apply this Rule to
    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

    GetRouteAggregationRulesDataChange

    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

    GetRouteAggregationRulesDataChangeLog

    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

    GetRouteAggregationRulesPagination

    Limit int
    Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
    Next string
    The URL relative to the next item in the response
    Offset int
    Index of the first item returned in the response. The default is 0
    Previous string
    The URL relative to the previous item in the response
    Total int
    The total number of route agrgegation rules available to the user making the request
    Limit int
    Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
    Next string
    The URL relative to the next item in the response
    Offset int
    Index of the first item returned in the response. The default is 0
    Previous string
    The URL relative to the previous item in the response
    Total int
    The total number of route agrgegation rules available to the user making the request
    limit Integer
    Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
    next String
    The URL relative to the next item in the response
    offset Integer
    Index of the first item returned in the response. The default is 0
    previous String
    The URL relative to the previous item in the response
    total Integer
    The total number of route agrgegation rules available to the user making the request
    limit number
    Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
    next string
    The URL relative to the next item in the response
    offset number
    Index of the first item returned in the response. The default is 0
    previous string
    The URL relative to the previous item in the response
    total number
    The total number of route agrgegation rules available to the user making the request
    limit int
    Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
    next str
    The URL relative to the next item in the response
    offset int
    Index of the first item returned in the response. The default is 0
    previous str
    The URL relative to the previous item in the response
    total int
    The total number of route agrgegation rules available to the user making the request
    limit Number
    Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
    next String
    The URL relative to the next item in the response
    offset Number
    Index of the first item returned in the response. The default is 0
    previous String
    The URL relative to the previous item in the response
    total Number
    The total number of route agrgegation rules available to the user making the request

    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