equinix.fabric.getAdvertisedRoutes

Equinix v0.29.1, Mar 17 26

Viewing docs for Equinix v0.29.1
published on Tuesday, Mar 17, 2026 by Equinix

Schema (JSON)

equinix/pulumi-equinix

Viewing docs for Equinix v0.29.1
published on Tuesday, Mar 17, 2026 by Equinix

Schema (JSON)

equinix/pulumi-equinix

Using getAdvertisedRoutes

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 getAdvertisedRoutes(args: GetAdvertisedRoutesArgs, opts?: InvokeOptions): Promise<GetAdvertisedRoutesResult>
function getAdvertisedRoutesOutput(args: GetAdvertisedRoutesOutputArgs, opts?: InvokeOptions): Output<GetAdvertisedRoutesResult>

def get_advertised_routes(connection_id: Optional[str] = None,
                          filter: Optional[GetAdvertisedRoutesFilter] = None,
                          pagination: Optional[GetAdvertisedRoutesPagination] = None,
                          sort: Optional[GetAdvertisedRoutesSort] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAdvertisedRoutesResult
def get_advertised_routes_output(connection_id: Optional[pulumi.Input[str]] = None,
                          filter: Optional[pulumi.Input[GetAdvertisedRoutesFilterArgs]] = None,
                          pagination: Optional[pulumi.Input[GetAdvertisedRoutesPaginationArgs]] = None,
                          sort: Optional[pulumi.Input[GetAdvertisedRoutesSortArgs]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetAdvertisedRoutesResult]

func GetAdvertisedRoutes(ctx *Context, args *GetAdvertisedRoutesArgs, opts ...InvokeOption) (*GetAdvertisedRoutesResult, error)
func GetAdvertisedRoutesOutput(ctx *Context, args *GetAdvertisedRoutesOutputArgs, opts ...InvokeOption) GetAdvertisedRoutesResultOutput

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

public static class GetAdvertisedRoutes 
{
    public static Task<GetAdvertisedRoutesResult> InvokeAsync(GetAdvertisedRoutesArgs args, InvokeOptions? opts = null)
    public static Output<GetAdvertisedRoutesResult> Invoke(GetAdvertisedRoutesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAdvertisedRoutesResult> getAdvertisedRoutes(GetAdvertisedRoutesArgs args, InvokeOptions options)
public static Output<GetAdvertisedRoutesResult> getAdvertisedRoutes(GetAdvertisedRoutesArgs args, InvokeOptions options)

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

The following arguments are supported:

ConnectionId string: The uuid of the routes this data source should retrieve
Filter GetAdvertisedRoutesFilter: Filters for the Data Source Search Request
Pagination GetAdvertisedRoutesPagination: Pagination details for the returned advertised routes list
Sort GetAdvertisedRoutesSort: Sort details for the returned advertised routes list

ConnectionId string: The uuid of the routes this data source should retrieve
Filter GetAdvertisedRoutesFilter: Filters for the Data Source Search Request
Pagination GetAdvertisedRoutesPagination: Pagination details for the returned advertised routes list
Sort GetAdvertisedRoutesSort: Sort details for the returned advertised routes list

connectionId String: The uuid of the routes this data source should retrieve
filter GetAdvertisedRoutesFilter: Filters for the Data Source Search Request
pagination GetAdvertisedRoutesPagination: Pagination details for the returned advertised routes list
sort GetAdvertisedRoutesSort: Sort details for the returned advertised routes list

connectionId string: The uuid of the routes this data source should retrieve
filter GetAdvertisedRoutesFilter: Filters for the Data Source Search Request
pagination GetAdvertisedRoutesPagination: Pagination details for the returned advertised routes list
sort GetAdvertisedRoutesSort: Sort details for the returned advertised routes list

connection_id str: The uuid of the routes this data source should retrieve
filter GetAdvertisedRoutesFilter: Filters for the Data Source Search Request
pagination GetAdvertisedRoutesPagination: Pagination details for the returned advertised routes list
sort GetAdvertisedRoutesSort: Sort details for the returned advertised routes list

connectionId String: The uuid of the routes this data source should retrieve
filter Property Map: Filters for the Data Source Search Request
pagination Property Map: Pagination details for the returned advertised routes list
sort Property Map: Sort details for the returned advertised routes list

getAdvertisedRoutes Result

The following output properties are available:

ConnectionId string: The uuid of the routes this data source should retrieve
Datas List<GetAdvertisedRoutesData>: Returned list of advertised routes objects
Filter GetAdvertisedRoutesFilter: Filters for the Data Source Search Request
Id string: The unique identifier of the resource
Pagination GetAdvertisedRoutesPagination: Pagination details for the returned advertised routes list
Sort GetAdvertisedRoutesSort: Sort details for the returned advertised routes list

ConnectionId string: The uuid of the routes this data source should retrieve
Datas []GetAdvertisedRoutesData: Returned list of advertised routes objects
Filter GetAdvertisedRoutesFilter: Filters for the Data Source Search Request
Id string: The unique identifier of the resource
Pagination GetAdvertisedRoutesPagination: Pagination details for the returned advertised routes list
Sort GetAdvertisedRoutesSort: Sort details for the returned advertised routes list

connectionId String: The uuid of the routes this data source should retrieve
datas List<GetAdvertisedRoutesData>: Returned list of advertised routes objects
filter GetAdvertisedRoutesFilter: Filters for the Data Source Search Request
id String: The unique identifier of the resource
pagination GetAdvertisedRoutesPagination: Pagination details for the returned advertised routes list
sort GetAdvertisedRoutesSort: Sort details for the returned advertised routes list

connectionId string: The uuid of the routes this data source should retrieve
datas GetAdvertisedRoutesData[]: Returned list of advertised routes objects
filter GetAdvertisedRoutesFilter: Filters for the Data Source Search Request
id string: The unique identifier of the resource
pagination GetAdvertisedRoutesPagination: Pagination details for the returned advertised routes list
sort GetAdvertisedRoutesSort: Sort details for the returned advertised routes list

connection_id str: The uuid of the routes this data source should retrieve
datas Sequence[GetAdvertisedRoutesData]: Returned list of advertised routes objects
filter GetAdvertisedRoutesFilter: Filters for the Data Source Search Request
id str: The unique identifier of the resource
pagination GetAdvertisedRoutesPagination: Pagination details for the returned advertised routes list
sort GetAdvertisedRoutesSort: Sort details for the returned advertised routes list

connectionId String: The uuid of the routes this data source should retrieve
datas List<Property Map>: Returned list of advertised routes objects
filter Property Map: Filters for the Data Source Search Request
id String: The unique identifier of the resource
pagination Property Map: Pagination details for the returned advertised routes list
sort Property Map: Sort details for the returned advertised routes list

Supporting Types

GetAdvertisedRoutesData

AsPaths List<string>: List of supported AS Paths for the Advertised Routes.
ChangeLog GetAdvertisedRoutesDataChangeLog: Change Log of the route table entry
Connection GetAdvertisedRoutesDataConnection: connection of the route table entry
LocalPreference int: This field holds local preference of the advertised route.
Med int: Multi-Exit Discriminator for the Advertised Route
NextHop string: Next Hop of the Advertised Route
Prefix string: Prefix of the Advertised Route
ProtocolType string: Advertised Route protocol type
State string: State of the advertised Route
Type string: Indicator of a advertised route

AsPaths []string: List of supported AS Paths for the Advertised Routes.
ChangeLog GetAdvertisedRoutesDataChangeLog: Change Log of the route table entry
Connection GetAdvertisedRoutesDataConnection: connection of the route table entry
LocalPreference int: This field holds local preference of the advertised route.
Med int: Multi-Exit Discriminator for the Advertised Route
NextHop string: Next Hop of the Advertised Route
Prefix string: Prefix of the Advertised Route
ProtocolType string: Advertised Route protocol type
State string: State of the advertised Route
Type string: Indicator of a advertised route

asPaths List<String>: List of supported AS Paths for the Advertised Routes.
changeLog GetAdvertisedRoutesDataChangeLog: Change Log of the route table entry
connection GetAdvertisedRoutesDataConnection: connection of the route table entry
localPreference Integer: This field holds local preference of the advertised route.
med Integer: Multi-Exit Discriminator for the Advertised Route
nextHop String: Next Hop of the Advertised Route
prefix String: Prefix of the Advertised Route
protocolType String: Advertised Route protocol type
state String: State of the advertised Route
type String: Indicator of a advertised route

asPaths string[]: List of supported AS Paths for the Advertised Routes.
changeLog GetAdvertisedRoutesDataChangeLog: Change Log of the route table entry
connection GetAdvertisedRoutesDataConnection: connection of the route table entry
localPreference number: This field holds local preference of the advertised route.
med number: Multi-Exit Discriminator for the Advertised Route
nextHop string: Next Hop of the Advertised Route
prefix string: Prefix of the Advertised Route
protocolType string: Advertised Route protocol type
state string: State of the advertised Route
type string: Indicator of a advertised route

as_paths Sequence[str]: List of supported AS Paths for the Advertised Routes.
change_log GetAdvertisedRoutesDataChangeLog: Change Log of the route table entry
connection GetAdvertisedRoutesDataConnection: connection of the route table entry
local_preference int: This field holds local preference of the advertised route.
med int: Multi-Exit Discriminator for the Advertised Route
next_hop str: Next Hop of the Advertised Route
prefix str: Prefix of the Advertised Route
protocol_type str: Advertised Route protocol type
state str: State of the advertised Route
type str: Indicator of a advertised route

asPaths List<String>: List of supported AS Paths for the Advertised Routes.
changeLog Property Map: Change Log of the route table entry
connection Property Map: connection of the route table entry
localPreference Number: This field holds local preference of the advertised route.
med Number: Multi-Exit Discriminator for the Advertised Route
nextHop String: Next Hop of the Advertised Route
prefix String: Prefix of the Advertised Route
protocolType String: Advertised Route protocol type
state String: State of the advertised Route
type String: Indicator of a advertised route

GetAdvertisedRoutesDataChangeLog

CreatedBy string: Created by User Key
CreatedByEmail string: Created by User Email Address
CreatedByFullName string: Created by User Full Name
CreatedDateTime string: Created by User Date and Time
DeletedBy string: Deleted by User Key
DeletedByEmail string: Deleted by User Email Address
DeletedByFullName string: Deleted by User Full Name
DeletedDateTime string: Deleted by User Date and Time
UpdatedBy string: Updated by User Key
UpdatedByEmail string: Updated by User Email Address
UpdatedByFullName string: Updated by User Full Name
UpdatedDateTime string: Updated by User Date and Time

CreatedBy string: Created by User Key
CreatedByEmail string: Created by User Email Address
CreatedByFullName string: Created by User Full Name
CreatedDateTime string: Created by User Date and Time
DeletedBy string: Deleted by User Key
DeletedByEmail string: Deleted by User Email Address
DeletedByFullName string: Deleted by User Full Name
DeletedDateTime string: Deleted by User Date and Time
UpdatedBy string: Updated by User Key
UpdatedByEmail string: Updated by User Email Address
UpdatedByFullName string: Updated by User Full Name
UpdatedDateTime string: Updated by User Date and Time

createdBy String: Created by User Key
createdByEmail String: Created by User Email Address
createdByFullName String: Created by User Full Name
createdDateTime String: Created by User Date and Time
deletedBy String: Deleted by User Key
deletedByEmail String: Deleted by User Email Address
deletedByFullName String: Deleted by User Full Name
deletedDateTime String: Deleted by User Date and Time
updatedBy String: Updated by User Key
updatedByEmail String: Updated by User Email Address
updatedByFullName String: Updated by User Full Name
updatedDateTime String: Updated by User Date and Time

createdBy string: Created by User Key
createdByEmail string: Created by User Email Address
createdByFullName string: Created by User Full Name
createdDateTime string: Created by User Date and Time
deletedBy string: Deleted by User Key
deletedByEmail string: Deleted by User Email Address
deletedByFullName string: Deleted by User Full Name
deletedDateTime string: Deleted by User Date and Time
updatedBy string: Updated by User Key
updatedByEmail string: Updated by User Email Address
updatedByFullName string: Updated by User Full Name
updatedDateTime string: Updated by User Date and Time

created_by str: Created by User Key
created_by_email str: Created by User Email Address
created_by_full_name str: Created by User Full Name
created_date_time str: Created by User Date and Time
deleted_by str: Deleted by User Key
deleted_by_email str: Deleted by User Email Address
deleted_by_full_name str: Deleted by User Full Name
deleted_date_time str: Deleted by User Date and Time
updated_by str: Updated by User Key
updated_by_email str: Updated by User Email Address
updated_by_full_name str: Updated by User Full Name
updated_date_time str: Updated by User Date and Time

createdBy String: Created by User Key
createdByEmail String: Created by User Email Address
createdByFullName String: Created by User Full Name
createdDateTime String: Created by User Date and Time
deletedBy String: Deleted by User Key
deletedByEmail String: Deleted by User Email Address
deletedByFullName String: Deleted by User Full Name
deletedDateTime String: Deleted by User Date and Time
updatedBy String: Updated by User Key
updatedByEmail String: Updated by User Email Address
updatedByFullName String: Updated by User Full Name
updatedDateTime String: Updated by User Date and Time

GetAdvertisedRoutesDataConnection

Href string: HREF of the Connection
Name string: Name of the Connection
Uuid string: UUID of the Connection

Href string: HREF of the Connection
Name string: Name of the Connection
Uuid string: UUID of the Connection

href String: HREF of the Connection
name String: Name of the Connection
uuid String: UUID of the Connection

href string: HREF of the Connection
name string: Name of the Connection
uuid string: UUID of the Connection

href str: HREF of the Connection
name str: Name of the Connection
uuid str: UUID of the Connection

href String: HREF of the Connection
name String: Name of the Connection
uuid String: UUID of the Connection

GetAdvertisedRoutesFilter

Operator string: Operators to use on your filtered field with the values given. One of [ =, !=, >, >=, <, <=, BETWEEN, NOT BETWEEN, LIKE, NOT LIKE, IN, NOT IN, IS NOT NULL, IS NULL]
Property string: possible field names to use on filters. One of [/type /name /project/projectId /uuid /state]
Values List<string>: The values that you want to apply the property+operator combination to in order to filter your data search

Operator string: Operators to use on your filtered field with the values given. One of [ =, !=, >, >=, <, <=, BETWEEN, NOT BETWEEN, LIKE, NOT LIKE, IN, NOT IN, IS NOT NULL, IS NULL]
Property string: possible field names to use on filters. One of [/type /name /project/projectId /uuid /state]
Values []string: The values that you want to apply the property+operator combination to in order to filter your data search

operator String: Operators to use on your filtered field with the values given. One of [ =, !=, >, >=, <, <=, BETWEEN, NOT BETWEEN, LIKE, NOT LIKE, IN, NOT IN, IS NOT NULL, IS NULL]
property String: possible field names to use on filters. One of [/type /name /project/projectId /uuid /state]
values List<String>: The values that you want to apply the property+operator combination to in order to filter your data search

operator string: Operators to use on your filtered field with the values given. One of [ =, !=, >, >=, <, <=, BETWEEN, NOT BETWEEN, LIKE, NOT LIKE, IN, NOT IN, IS NOT NULL, IS NULL]
property string: possible field names to use on filters. One of [/type /name /project/projectId /uuid /state]
values string[]: The values that you want to apply the property+operator combination to in order to filter your data search

operator str: Operators to use on your filtered field with the values given. One of [ =, !=, >, >=, <, <=, BETWEEN, NOT BETWEEN, LIKE, NOT LIKE, IN, NOT IN, IS NOT NULL, IS NULL]
property str: possible field names to use on filters. One of [/type /name /project/projectId /uuid /state]
values Sequence[str]: The values that you want to apply the property+operator combination to in order to filter your data search

operator String: Operators to use on your filtered field with the values given. One of [ =, !=, >, >=, <, <=, BETWEEN, NOT BETWEEN, LIKE, NOT LIKE, IN, NOT IN, IS NOT NULL, IS NULL]
property String: possible field names to use on filters. One of [/type /name /project/projectId /uuid /state]
values List<String>: The values that you want to apply the property+operator combination to in order to filter your data search

GetAdvertisedRoutesPagination

Next string: URL relative to the next item in the response.
Previous string: URL relative to the previous item in the response.
Total int: The total number of elements returned
Limit int: Maximum number of search results returned per page.
Offset int: Index of the first item returned in the response.

Next string: URL relative to the next item in the response.
Previous string: URL relative to the previous item in the response.
Total int: The total number of elements returned
Limit int: Maximum number of search results returned per page.
Offset int: Index of the first item returned in the response.

next String: URL relative to the next item in the response.
previous String: URL relative to the previous item in the response.
total Integer: The total number of elements returned
limit Integer: Maximum number of search results returned per page.
offset Integer: Index of the first item returned in the response.

next string: URL relative to the next item in the response.
previous string: URL relative to the previous item in the response.
total number: The total number of elements returned
limit number: Maximum number of search results returned per page.
offset number: Index of the first item returned in the response.

next str: URL relative to the next item in the response.
previous str: URL relative to the previous item in the response.
total int: The total number of elements returned
limit int: Maximum number of search results returned per page.
offset int: Index of the first item returned in the response.

next String: URL relative to the next item in the response.
previous String: URL relative to the previous item in the response.
total Number: The total number of elements returned
limit Number: Maximum number of search results returned per page.
offset Number: Index of the first item returned in the response.

GetAdvertisedRoutesSort

Direction string: Sort direction, one of [ASC, DESC]
Property string: Property name to sort by

Direction string: Sort direction, one of [ASC, DESC]
Property string: Property name to sort by

direction String: Sort direction, one of [ASC, DESC]
property String: Property name to sort by

direction string: Sort direction, one of [ASC, DESC]
property string: Property name to sort by

direction str: Sort direction, one of [ASC, DESC]
property str: Property name to sort by

direction String: Sort direction, one of [ASC, DESC]
property String: Property name to sort by

Package Details

Repository: equinix equinix/pulumi-equinix
License: Apache-2.0
Notes: This Pulumi package is based on the equinix Terraform Provider.

Viewing docs for Equinix v0.29.1
published on Tuesday, Mar 17, 2026 by Equinix

Schema (JSON)

equinix/pulumi-equinix

equinix.fabric.getAdvertisedRoutes

On this page

On this page

Using getAdvertisedRoutes

getAdvertisedRoutes Result

Supporting Types

GetAdvertisedRoutesData

GetAdvertisedRoutesDataChangeLog

GetAdvertisedRoutesDataConnection

GetAdvertisedRoutesFilter

GetAdvertisedRoutesPagination

GetAdvertisedRoutesSort

Package Details

On this page

On this page