Equinix v0.8.0, Apr 2 24

Equinix v0.8.0 published on Tuesday, Apr 2, 2024 by Equinix

equinix.metal.getInterconnection

Explore with Pulumi AI

Equinix v0.8.0 published on Tuesday, Apr 2, 2024 by Equinix

Example Usage

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

const example = equinix.metal.getInterconnection({
    connectionId: "4347e805-eb46-4699-9eb9-5c116e6a017d",
});

import pulumi
import pulumi_equinix as equinix

example = equinix.metal.get_interconnection(connection_id="4347e805-eb46-4699-9eb9-5c116e6a017d")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := metal.LookupInterconnection(ctx, &metal.LookupInterconnectionArgs{
			ConnectionId: "4347e805-eb46-4699-9eb9-5c116e6a017d",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Equinix.Metal.GetInterconnection.Invoke(new()
    {
        ConnectionId = "4347e805-eb46-4699-9eb9-5c116e6a017d",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.metal.MetalFunctions;
import com.pulumi.equinix.metal.inputs.GetInterconnectionArgs;
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 example = MetalFunctions.getInterconnection(GetInterconnectionArgs.builder()
            .connectionId("4347e805-eb46-4699-9eb9-5c116e6a017d")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: equinix:metal:getInterconnection
      Arguments:
        connectionId: 4347e805-eb46-4699-9eb9-5c116e6a017d

Using getInterconnection

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 getInterconnection(args: GetInterconnectionArgs, opts?: InvokeOptions): Promise<GetInterconnectionResult>
function getInterconnectionOutput(args: GetInterconnectionOutputArgs, opts?: InvokeOptions): Output<GetInterconnectionResult>

def get_interconnection(connection_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetInterconnectionResult
def get_interconnection_output(connection_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetInterconnectionResult]

func LookupInterconnection(ctx *Context, args *LookupInterconnectionArgs, opts ...InvokeOption) (*LookupInterconnectionResult, error)
func LookupInterconnectionOutput(ctx *Context, args *LookupInterconnectionOutputArgs, opts ...InvokeOption) LookupInterconnectionResultOutput

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

public static class GetInterconnection 
{
    public static Task<GetInterconnectionResult> InvokeAsync(GetInterconnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetInterconnectionResult> Invoke(GetInterconnectionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInterconnectionResult> getInterconnection(GetInterconnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: equinix:metal/getInterconnection:getInterconnection
  arguments:
    # arguments dictionary

The following arguments are supported:

ConnectionId string: ID of the connection resource.

ConnectionId string: ID of the connection resource.

connectionId String: ID of the connection resource.

connectionId string: ID of the connection resource.

connection_id str: ID of the connection resource.

connectionId String: ID of the connection resource.

getInterconnection Result

The following output properties are available:

AuthorizationCode string
ConnectionId string
ContactEmail string: The preferred email used for communication and notifications about the Equinix Fabric interconnection.
Description string: Description of the connection resource.
Facility string: (Deprecated) Slug of a facility to which the connection belongs. Use metro instead; read the facility to metro migration guide
Deprecated: Use metro instead of facility. For more information, read the migration guide.
Id string: Port UUID.
Metro string: Slug of a metro to which the connection belongs.
Mode string: Mode for connections in IBX facilities with the dedicated type - standard or tunnel.
Name string: Port name.
OrganizationId string: ID of the organization where the connection is scoped to.
Ports List<GetInterconnectionPort>: List of connection ports - primary (ports[0]) and secondary (ports[1])
ProjectId string: ID of project to which the connection belongs.
Redundancy string: Connection redundancy, reduntant or primary.
ServiceTokenType string: Type of service token, a_side or z_side. One available in shared connection.
ServiceTokens List<GetInterconnectionServiceToken>: List of connection service tokens with attributes
Speed string: Port speed in bits per second.
Status string: Port status.
Tags List<string>: String list of tags.
Token string: (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use service_tokens instead.
Deprecated: If your organization already has connection service tokens enabled, use service_tokens instead
Type string: Token type, a_side or z_side.
Vlans List<int>: Attached VLANs. Only available in shared connection. One vlan for Primary/Single connection and two vlans for Redundant connection.
Vrfs List<string>

AuthorizationCode string
ConnectionId string
ContactEmail string: The preferred email used for communication and notifications about the Equinix Fabric interconnection.
Description string: Description of the connection resource.
Facility string: (Deprecated) Slug of a facility to which the connection belongs. Use metro instead; read the facility to metro migration guide
Deprecated: Use metro instead of facility. For more information, read the migration guide.
Id string: Port UUID.
Metro string: Slug of a metro to which the connection belongs.
Mode string: Mode for connections in IBX facilities with the dedicated type - standard or tunnel.
Name string: Port name.
OrganizationId string: ID of the organization where the connection is scoped to.
Ports []GetInterconnectionPort: List of connection ports - primary (ports[0]) and secondary (ports[1])
ProjectId string: ID of project to which the connection belongs.
Redundancy string: Connection redundancy, reduntant or primary.
ServiceTokenType string: Type of service token, a_side or z_side. One available in shared connection.
ServiceTokens []GetInterconnectionServiceToken: List of connection service tokens with attributes
Speed string: Port speed in bits per second.
Status string: Port status.
Tags []string: String list of tags.
Token string: (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use service_tokens instead.
Deprecated: If your organization already has connection service tokens enabled, use service_tokens instead
Type string: Token type, a_side or z_side.
Vlans []int: Attached VLANs. Only available in shared connection. One vlan for Primary/Single connection and two vlans for Redundant connection.
Vrfs []string

authorizationCode String
connectionId String
contactEmail String: The preferred email used for communication and notifications about the Equinix Fabric interconnection.
description String: Description of the connection resource.
facility String: (Deprecated) Slug of a facility to which the connection belongs. Use metro instead; read the facility to metro migration guide
Deprecated: Use metro instead of facility. For more information, read the migration guide.
id String: Port UUID.
metro String: Slug of a metro to which the connection belongs.
mode String: Mode for connections in IBX facilities with the dedicated type - standard or tunnel.
name String: Port name.
organizationId String: ID of the organization where the connection is scoped to.
ports List<GetInterconnectionPort>: List of connection ports - primary (ports[0]) and secondary (ports[1])
projectId String: ID of project to which the connection belongs.
redundancy String: Connection redundancy, reduntant or primary.
serviceTokenType String: Type of service token, a_side or z_side. One available in shared connection.
serviceTokens List<GetInterconnectionServiceToken>: List of connection service tokens with attributes
speed String: Port speed in bits per second.
status String: Port status.
tags List<String>: String list of tags.
token String: (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use service_tokens instead.
Deprecated: If your organization already has connection service tokens enabled, use service_tokens instead
type String: Token type, a_side or z_side.
vlans List<Integer>: Attached VLANs. Only available in shared connection. One vlan for Primary/Single connection and two vlans for Redundant connection.
vrfs List<String>

authorizationCode string
connectionId string
contactEmail string: The preferred email used for communication and notifications about the Equinix Fabric interconnection.
description string: Description of the connection resource.
facility string: (Deprecated) Slug of a facility to which the connection belongs. Use metro instead; read the facility to metro migration guide
Deprecated: Use metro instead of facility. For more information, read the migration guide.
id string: Port UUID.
metro string: Slug of a metro to which the connection belongs.
mode string: Mode for connections in IBX facilities with the dedicated type - standard or tunnel.
name string: Port name.
organizationId string: ID of the organization where the connection is scoped to.
ports GetInterconnectionPort[]: List of connection ports - primary (ports[0]) and secondary (ports[1])
projectId string: ID of project to which the connection belongs.
redundancy string: Connection redundancy, reduntant or primary.
serviceTokenType string: Type of service token, a_side or z_side. One available in shared connection.
serviceTokens GetInterconnectionServiceToken[]: List of connection service tokens with attributes
speed string: Port speed in bits per second.
status string: Port status.
tags string[]: String list of tags.
token string: (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use service_tokens instead.
Deprecated: If your organization already has connection service tokens enabled, use service_tokens instead
type string: Token type, a_side or z_side.
vlans number[]: Attached VLANs. Only available in shared connection. One vlan for Primary/Single connection and two vlans for Redundant connection.
vrfs string[]

authorization_code str
connection_id str
contact_email str: The preferred email used for communication and notifications about the Equinix Fabric interconnection.
description str: Description of the connection resource.
facility str: (Deprecated) Slug of a facility to which the connection belongs. Use metro instead; read the facility to metro migration guide
Deprecated: Use metro instead of facility. For more information, read the migration guide.
id str: Port UUID.
metro str: Slug of a metro to which the connection belongs.
mode str: Mode for connections in IBX facilities with the dedicated type - standard or tunnel.
name str: Port name.
organization_id str: ID of the organization where the connection is scoped to.
ports Sequence[GetInterconnectionPort]: List of connection ports - primary (ports[0]) and secondary (ports[1])
project_id str: ID of project to which the connection belongs.
redundancy str: Connection redundancy, reduntant or primary.
service_token_type str: Type of service token, a_side or z_side. One available in shared connection.
service_tokens Sequence[GetInterconnectionServiceToken]: List of connection service tokens with attributes
speed str: Port speed in bits per second.
status str: Port status.
tags Sequence[str]: String list of tags.
token str: (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use service_tokens instead.
Deprecated: If your organization already has connection service tokens enabled, use service_tokens instead
type str: Token type, a_side or z_side.
vlans Sequence[int]: Attached VLANs. Only available in shared connection. One vlan for Primary/Single connection and two vlans for Redundant connection.
vrfs Sequence[str]

authorizationCode String
connectionId String
contactEmail String: The preferred email used for communication and notifications about the Equinix Fabric interconnection.
description String: Description of the connection resource.
facility String: (Deprecated) Slug of a facility to which the connection belongs. Use metro instead; read the facility to metro migration guide
Deprecated: Use metro instead of facility. For more information, read the migration guide.
id String: Port UUID.
metro String: Slug of a metro to which the connection belongs.
mode String: Mode for connections in IBX facilities with the dedicated type - standard or tunnel.
name String: Port name.
organizationId String: ID of the organization where the connection is scoped to.
ports List<Property Map>: List of connection ports - primary (ports[0]) and secondary (ports[1])
projectId String: ID of project to which the connection belongs.
redundancy String: Connection redundancy, reduntant or primary.
serviceTokenType String: Type of service token, a_side or z_side. One available in shared connection.
serviceTokens List<Property Map>: List of connection service tokens with attributes
speed String: Port speed in bits per second.
status String: Port status.
tags List<String>: String list of tags.
token String: (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use service_tokens instead.
Deprecated: If your organization already has connection service tokens enabled, use service_tokens instead
type String: Token type, a_side or z_side.
vlans List<Number>: Attached VLANs. Only available in shared connection. One vlan for Primary/Single connection and two vlans for Redundant connection.
vrfs List<String>

Supporting Types

GetInterconnectionPort

Id string: Port UUID.
LinkStatus string: Port link status.
Name string: Port name.
Role string: Port role - primary or secondary.
Speed int: Port speed in bits per second.
Status string: Port status.
VirtualCircuitIds List<object>: List of IDs of virtual cicruits attached to this port.

Id string: Port UUID.
LinkStatus string: Port link status.
Name string: Port name.
Role string: Port role - primary or secondary.
Speed int: Port speed in bits per second.
Status string: Port status.
VirtualCircuitIds []interface{}: List of IDs of virtual cicruits attached to this port.

id String: Port UUID.
linkStatus String: Port link status.
name String: Port name.
role String: Port role - primary or secondary.
speed Integer: Port speed in bits per second.
status String: Port status.
virtualCircuitIds List<Object>: List of IDs of virtual cicruits attached to this port.

id string: Port UUID.
linkStatus string: Port link status.
name string: Port name.
role string: Port role - primary or secondary.
speed number: Port speed in bits per second.
status string: Port status.
virtualCircuitIds any[]: List of IDs of virtual cicruits attached to this port.

id str: Port UUID.
link_status str: Port link status.
name str: Port name.
role str: Port role - primary or secondary.
speed int: Port speed in bits per second.
status str: Port status.
virtual_circuit_ids Sequence[Any]: List of IDs of virtual cicruits attached to this port.

id String: Port UUID.
linkStatus String: Port link status.
name String: Port name.
role String: Port role - primary or secondary.
speed Number: Port speed in bits per second.
status String: Port status.
virtualCircuitIds List<Any>: List of IDs of virtual cicruits attached to this port.

GetInterconnectionServiceToken

ExpiresAt string: Expiration date of the service token.
Id string: Port UUID.
MaxAllowedSpeed string: Maximum allowed speed for the service token, string like in the speed attribute.
Role string: Port role - primary or secondary.
State string
Type string: Token type, a_side or z_side.

ExpiresAt string: Expiration date of the service token.
Id string: Port UUID.
MaxAllowedSpeed string: Maximum allowed speed for the service token, string like in the speed attribute.
Role string: Port role - primary or secondary.
State string
Type string: Token type, a_side or z_side.

expiresAt String: Expiration date of the service token.
id String: Port UUID.
maxAllowedSpeed String: Maximum allowed speed for the service token, string like in the speed attribute.
role String: Port role - primary or secondary.
state String
type String: Token type, a_side or z_side.

expiresAt string: Expiration date of the service token.
id string: Port UUID.
maxAllowedSpeed string: Maximum allowed speed for the service token, string like in the speed attribute.
role string: Port role - primary or secondary.
state string
type string: Token type, a_side or z_side.

expires_at str: Expiration date of the service token.
id str: Port UUID.
max_allowed_speed str: Maximum allowed speed for the service token, string like in the speed attribute.
role str: Port role - primary or secondary.
state str
type str: Token type, a_side or z_side.

expiresAt String: Expiration date of the service token.
id String: Port UUID.
maxAllowedSpeed String: Maximum allowed speed for the service token, string like in the speed attribute.
role String: Port role - primary or secondary.
state String
type String: Token type, a_side or z_side.

Package Details

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

Equinix v0.8.0 published on Tuesday, Apr 2, 2024 by Equinix

equinix/pulumi-equinix

equinix.metal.getInterconnection

On this page

On this page

Example Usage

Using getInterconnection

getInterconnection Result

Supporting Types

GetInterconnectionPort

GetInterconnectionServiceToken

Package Details

On this page

On this page