Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Equinix Metal (Deprecated)
  3. API Docs
  4. getVirtualCircuit

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal

equinix-metal.getVirtualCircuit

Explore with Pulumi AI

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal

Use this data source to retrieve a virtual circuit resource from Equinix Fabric - software-defined interconnections

Example Usage

using Pulumi;
using EquinixMetal = Pulumi.EquinixMetal;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleConnection = Output.Create(EquinixMetal.GetConnection.InvokeAsync(new EquinixMetal.GetConnectionArgs
        {
            ConnectionId = "4347e805-eb46-4699-9eb9-5c116e6a017d",
        }));
        var exampleVc = exampleConnection.Apply(exampleConnection => Output.Create(EquinixMetal.GetVirtualCircuit.InvokeAsync(new EquinixMetal.GetVirtualCircuitArgs
        {
            VirtualCircuitId = exampleConnection.Ports?[1]?.VirtualCircuitIds?[0],
        })));
    }

}
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleConnection, err := equinix - metal.LookupConnection(ctx, &GetConnectionArgs{
			ConnectionId: "4347e805-eb46-4699-9eb9-5c116e6a017d",
		}, nil)
		if err != nil {
			return err
		}
		_, err = equinix - metal.LookupVirtualCircuit(ctx, &GetVirtualCircuitArgs{
			VirtualCircuitId: exampleConnection.Ports[1].VirtualCircuitIds[0],
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as equinix_metal from "@pulumi/equinix-metal";

const exampleConnection = equinix_metal.getConnection({
    connectionId: "4347e805-eb46-4699-9eb9-5c116e6a017d",
});
const exampleVc = exampleConnection.then(exampleConnection => equinix_metal.getVirtualCircuit({
    virtualCircuitId: exampleConnection.ports?[1]?.virtualCircuitIds?[0],
}));
Copy
import pulumi
import pulumi_equinix_metal as equinix_metal

example_connection = equinix_metal.get_connection(connection_id="4347e805-eb46-4699-9eb9-5c116e6a017d")
example_vc = equinix_metal.get_virtual_circuit(virtual_circuit_id=example_connection.ports[1].virtual_circuit_ids[0])
Copy

Coming soon!

Using getVirtualCircuit

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 getVirtualCircuit(args: GetVirtualCircuitArgs, opts?: InvokeOptions): Promise<GetVirtualCircuitResult>
function getVirtualCircuitOutput(args: GetVirtualCircuitOutputArgs, opts?: InvokeOptions): Output<GetVirtualCircuitResult>
Copy
def get_virtual_circuit(virtual_circuit_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVirtualCircuitResult
def get_virtual_circuit_output(virtual_circuit_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVirtualCircuitResult]
Copy
func LookupVirtualCircuit(ctx *Context, args *LookupVirtualCircuitArgs, opts ...InvokeOption) (*LookupVirtualCircuitResult, error)
func LookupVirtualCircuitOutput(ctx *Context, args *LookupVirtualCircuitOutputArgs, opts ...InvokeOption) LookupVirtualCircuitResultOutput
Copy

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

public static class GetVirtualCircuit 
{
    public static Task<GetVirtualCircuitResult> InvokeAsync(GetVirtualCircuitArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualCircuitResult> Invoke(GetVirtualCircuitInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVirtualCircuitResult> getVirtualCircuit(GetVirtualCircuitArgs args, InvokeOptions options)
public static Output<GetVirtualCircuitResult> getVirtualCircuit(GetVirtualCircuitArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: equinix-metal:index/getVirtualCircuit:getVirtualCircuit
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

VirtualCircuitId This property is required. string
ID of the virtual circuit resource
VirtualCircuitId This property is required. string
ID of the virtual circuit resource
virtualCircuitId This property is required. String
ID of the virtual circuit resource
virtualCircuitId This property is required. string
ID of the virtual circuit resource
virtual_circuit_id This property is required. str
ID of the virtual circuit resource
virtualCircuitId This property is required. String
ID of the virtual circuit resource

getVirtualCircuit Result

The following output properties are available:

Description string
Description for the Virtual Circuit resource
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the virtual circuit resource
NniVlan int
NniVnid int
ProjectId string
ID of project to which the VC belongs

Status string
Status of the virtal circuit
Tags List<string>
Tags for the Virtual Circuit resource
VirtualCircuitId string
Vnid int
Description string
Description for the Virtual Circuit resource
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the virtual circuit resource
NniVlan int
NniVnid int
ProjectId string
ID of project to which the VC belongs

Status string
Status of the virtal circuit
Tags []string
Tags for the Virtual Circuit resource
VirtualCircuitId string
Vnid int
description String
Description for the Virtual Circuit resource
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the virtual circuit resource
nniVlan Integer
nniVnid Integer
projectId String
ID of project to which the VC belongs

status String
Status of the virtal circuit
tags List<String>
Tags for the Virtual Circuit resource
virtualCircuitId String
vnid Integer
description string
Description for the Virtual Circuit resource
id string
The provider-assigned unique ID for this managed resource.
name string
Name of the virtual circuit resource
nniVlan number
nniVnid number
projectId string
ID of project to which the VC belongs

status string
Status of the virtal circuit
tags string[]
Tags for the Virtual Circuit resource
virtualCircuitId string
vnid number
description str
Description for the Virtual Circuit resource
id str
The provider-assigned unique ID for this managed resource.
name str
Name of the virtual circuit resource
nni_vlan int
nni_vnid int
project_id str
ID of project to which the VC belongs

status str
Status of the virtal circuit
tags Sequence[str]
Tags for the Virtual Circuit resource
virtual_circuit_id str
vnid int
description String
Description for the Virtual Circuit resource
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the virtual circuit resource
nniVlan Number
nniVnid Number
projectId String
ID of project to which the VC belongs

status String
Status of the virtal circuit
tags List<String>
Tags for the Virtual Circuit resource
virtualCircuitId String
vnid Number

Package Details

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

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal