equinix.fabric.getMetros

Explore with Pulumi AI

Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix

Example Usage

Using getMetros

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.

TypeScript
Python
Go
C#
Java
YAML

function getMetros(args: GetMetrosArgs, opts?: InvokeOptions): Promise<GetMetrosResult>
function getMetrosOutput(args: GetMetrosOutputArgs, opts?: InvokeOptions): Output<GetMetrosResult>

def get_metros(pagination: Optional[GetMetrosPagination] = None,
               presence: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetMetrosResult
def get_metros_output(pagination: Optional[pulumi.Input[GetMetrosPaginationArgs]] = None,
               presence: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetMetrosResult]

func GetMetros(ctx *Context, args *GetMetrosArgs, opts ...InvokeOption) (*GetMetrosResult, error)
func GetMetrosOutput(ctx *Context, args *GetMetrosOutputArgs, opts ...InvokeOption) GetMetrosResultOutput

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

public static class GetMetros 
{
    public static Task<GetMetrosResult> InvokeAsync(GetMetrosArgs args, InvokeOptions? opts = null)
    public static Output<GetMetrosResult> Invoke(GetMetrosInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMetrosResult> getMetros(GetMetrosArgs args, InvokeOptions options)
public static Output<GetMetrosResult> getMetros(GetMetrosArgs args, InvokeOptions options)

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

The following arguments are supported:

Pagination GetMetrosPagination: Pagination details for the returned metro list
Presence string: User On Boarded Metros based on Fabric resource availability

Pagination GetMetrosPagination: Pagination details for the returned metro list
Presence string: User On Boarded Metros based on Fabric resource availability

pagination GetMetrosPagination: Pagination details for the returned metro list
presence String: User On Boarded Metros based on Fabric resource availability

pagination GetMetrosPagination: Pagination details for the returned metro list
presence string: User On Boarded Metros based on Fabric resource availability

pagination GetMetrosPagination: Pagination details for the returned metro list
presence str: User On Boarded Metros based on Fabric resource availability

pagination Property Map: Pagination details for the returned metro list
presence String: User On Boarded Metros based on Fabric resource availability

getMetros Result

The following output properties are available:

Datas List<GetMetrosData>: Returned list of metro objects
Id string: The unique identifier of the resource
Pagination GetMetrosPagination: Pagination details for the returned metro list
Presence string: User On Boarded Metros based on Fabric resource availability

Datas []GetMetrosData: Returned list of metro objects
Id string: The unique identifier of the resource
Pagination GetMetrosPagination: Pagination details for the returned metro list
Presence string: User On Boarded Metros based on Fabric resource availability

datas List<GetMetrosData>: Returned list of metro objects
id String: The unique identifier of the resource
pagination GetMetrosPagination: Pagination details for the returned metro list
presence String: User On Boarded Metros based on Fabric resource availability

datas GetMetrosData[]: Returned list of metro objects
id string: The unique identifier of the resource
pagination GetMetrosPagination: Pagination details for the returned metro list
presence string: User On Boarded Metros based on Fabric resource availability

datas Sequence[GetMetrosData]: Returned list of metro objects
id str: The unique identifier of the resource
pagination GetMetrosPagination: Pagination details for the returned metro list
presence str: User On Boarded Metros based on Fabric resource availability

datas List<Property Map>: Returned list of metro objects
id String: The unique identifier of the resource
pagination Property Map: Pagination details for the returned metro list
presence String: User On Boarded Metros based on Fabric resource availability

Supporting Types

GetMetrosData

Code string: Code assigned to an Equinix IBX data center in a specified metropolitan area
ConnectedMetros List<GetMetrosDataConnectedMetro>: Arrays of objects containing latency data for the specified metro
EquinixAsn int: Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.
GeoCoordinates GetMetrosDataGeoCoordinates: Geographic location data of Fabric Metro
GeoScopes List<string>: List of supported geographic boundaries of a Fabric Metro. Example values: CANADA, CONUS.
Href string: The canonical URL at which the resource resides
LocalVcBandwidthMax int: This field holds Max Connection speed within the metro.
Name string: Name of the region in which the data center is located
Region string: Board geographical area in which the data center is located
Type string: Indicator of a fabric metro

Code string: Code assigned to an Equinix IBX data center in a specified metropolitan area
ConnectedMetros []GetMetrosDataConnectedMetro: Arrays of objects containing latency data for the specified metro
EquinixAsn int: Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.
GeoCoordinates GetMetrosDataGeoCoordinates: Geographic location data of Fabric Metro
GeoScopes []string: List of supported geographic boundaries of a Fabric Metro. Example values: CANADA, CONUS.
Href string: The canonical URL at which the resource resides
LocalVcBandwidthMax int: This field holds Max Connection speed within the metro.
Name string: Name of the region in which the data center is located
Region string: Board geographical area in which the data center is located
Type string: Indicator of a fabric metro

code String: Code assigned to an Equinix IBX data center in a specified metropolitan area
connectedMetros List<GetMetrosDataConnectedMetro>: Arrays of objects containing latency data for the specified metro
equinixAsn Integer: Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.
geoCoordinates GetMetrosDataGeoCoordinates: Geographic location data of Fabric Metro
geoScopes List<String>: List of supported geographic boundaries of a Fabric Metro. Example values: CANADA, CONUS.
href String: The canonical URL at which the resource resides
localVcBandwidthMax Integer: This field holds Max Connection speed within the metro.
name String: Name of the region in which the data center is located
region String: Board geographical area in which the data center is located
type String: Indicator of a fabric metro

code string: Code assigned to an Equinix IBX data center in a specified metropolitan area
connectedMetros GetMetrosDataConnectedMetro[]: Arrays of objects containing latency data for the specified metro
equinixAsn number: Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.
geoCoordinates GetMetrosDataGeoCoordinates: Geographic location data of Fabric Metro
geoScopes string[]: List of supported geographic boundaries of a Fabric Metro. Example values: CANADA, CONUS.
href string: The canonical URL at which the resource resides
localVcBandwidthMax number: This field holds Max Connection speed within the metro.
name string: Name of the region in which the data center is located
region string: Board geographical area in which the data center is located
type string: Indicator of a fabric metro

code str: Code assigned to an Equinix IBX data center in a specified metropolitan area
connected_metros Sequence[GetMetrosDataConnectedMetro]: Arrays of objects containing latency data for the specified metro
equinix_asn int: Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.
geo_coordinates GetMetrosDataGeoCoordinates: Geographic location data of Fabric Metro
geo_scopes Sequence[str]: List of supported geographic boundaries of a Fabric Metro. Example values: CANADA, CONUS.
href str: The canonical URL at which the resource resides
local_vc_bandwidth_max int: This field holds Max Connection speed within the metro.
name str: Name of the region in which the data center is located
region str: Board geographical area in which the data center is located
type str: Indicator of a fabric metro

code String: Code assigned to an Equinix IBX data center in a specified metropolitan area
connectedMetros List<Property Map>: Arrays of objects containing latency data for the specified metro
equinixAsn Number: Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.
geoCoordinates Property Map: Geographic location data of Fabric Metro
geoScopes List<String>: List of supported geographic boundaries of a Fabric Metro. Example values: CANADA, CONUS.
href String: The canonical URL at which the resource resides
localVcBandwidthMax Number: This field holds Max Connection speed within the metro.
name String: Name of the region in which the data center is located
region String: Board geographical area in which the data center is located
type String: Indicator of a fabric metro