Equinix v0.8.0, Apr 2 24

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

equinix.fabric.getPort

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 portDataName = equinix.fabric.getPort({
    uuid: "<uuid_of_port>",
});

import pulumi
import pulumi_equinix as equinix

port_data_name = equinix.fabric.get_port(uuid="<uuid_of_port>")

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 {
		_, err := fabric.GetPort(ctx, &fabric.GetPortArgs{
			Uuid: "<uuid_of_port>",
		}, 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 portDataName = Equinix.Fabric.GetPort.Invoke(new()
    {
        Uuid = "<uuid_of_port>",
    });

});

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.GetPortArgs;
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 portDataName = FabricFunctions.getPort(GetPortArgs.builder()
            .uuid("<uuid_of_port>")
            .build());

    }
}

variables:
  portDataName:
    fn::invoke:
      Function: equinix:fabric:getPort
      Arguments:
        uuid: <uuid_of_port>

Using getPort

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 getPort(args: GetPortArgs, opts?: InvokeOptions): Promise<GetPortResult>
function getPortOutput(args: GetPortOutputArgs, opts?: InvokeOptions): Output<GetPortResult>

def get_port(uuid: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetPortResult
def get_port_output(uuid: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetPortResult]

func GetPort(ctx *Context, args *GetPortArgs, opts ...InvokeOption) (*GetPortResult, error)
func GetPortOutput(ctx *Context, args *GetPortOutputArgs, opts ...InvokeOption) GetPortResultOutput

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

public static class GetPort 
{
    public static Task<GetPortResult> InvokeAsync(GetPortArgs args, InvokeOptions? opts = null)
    public static Output<GetPortResult> Invoke(GetPortInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPortResult> getPort(GetPortArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

Uuid string: Equinix-assigned port identifier

Uuid string: Equinix-assigned port identifier

uuid String: Equinix-assigned port identifier

uuid string: Equinix-assigned port identifier

uuid str: Equinix-assigned port identifier

uuid String: Equinix-assigned port identifier

getPort Result

The following output properties are available:

Account GetPortAccount: Customer account information that is associated with this port
AvailableBandwidth int: Port available bandwidth in Mbps
Bandwidth int: Port bandwidth in Mbps
ChangeLog GetPortChangeLog: Captures port lifecycle change information
Description string: Port description
Device GetPortDevice: Port device
Encapsulation GetPortEncapsulation: Port encapsulation protocol
Href string: Port URI information
Id string: The provider-assigned unique ID for this managed resource.
LagEnabled bool: Port Lag
Location GetPortLocation: Port location information
Name string: Port name
Operation GetPortOperation: Port specific operational data
Redundancy GetPortRedundancy: Port redundancy information
ServiceType string: Port service type
State string: Port state
Type string: Port type
UsedBandwidth int: Port used bandwidth in Mbps
Uuid string: Equinix-assigned port identifier

Account GetPortAccount: Customer account information that is associated with this port
AvailableBandwidth int: Port available bandwidth in Mbps
Bandwidth int: Port bandwidth in Mbps
ChangeLog GetPortChangeLog: Captures port lifecycle change information
Description string: Port description
Device GetPortDevice: Port device
Encapsulation GetPortEncapsulation: Port encapsulation protocol
Href string: Port URI information
Id string: The provider-assigned unique ID for this managed resource.
LagEnabled bool: Port Lag
Location GetPortLocation: Port location information
Name string: Port name
Operation GetPortOperation: Port specific operational data
Redundancy GetPortRedundancy: Port redundancy information
ServiceType string: Port service type
State string: Port state
Type string: Port type
UsedBandwidth int: Port used bandwidth in Mbps
Uuid string: Equinix-assigned port identifier

account GetPortAccount: Customer account information that is associated with this port
availableBandwidth Integer: Port available bandwidth in Mbps
bandwidth Integer: Port bandwidth in Mbps
changeLog GetPortChangeLog: Captures port lifecycle change information
description String: Port description
device GetPortDevice: Port device
encapsulation GetPortEncapsulation: Port encapsulation protocol
href String: Port URI information
id String: The provider-assigned unique ID for this managed resource.
lagEnabled Boolean: Port Lag
location GetPortLocation: Port location information
name String: Port name
operation GetPortOperation: Port specific operational data
redundancy GetPortRedundancy: Port redundancy information
serviceType String: Port service type
state String: Port state
type String: Port type
usedBandwidth Integer: Port used bandwidth in Mbps
uuid String: Equinix-assigned port identifier

account GetPortAccount: Customer account information that is associated with this port
availableBandwidth number: Port available bandwidth in Mbps
bandwidth number: Port bandwidth in Mbps
changeLog GetPortChangeLog: Captures port lifecycle change information
description string: Port description
device GetPortDevice: Port device
encapsulation GetPortEncapsulation: Port encapsulation protocol
href string: Port URI information
id string: The provider-assigned unique ID for this managed resource.
lagEnabled boolean: Port Lag
location GetPortLocation: Port location information
name string: Port name
operation GetPortOperation: Port specific operational data
redundancy GetPortRedundancy: Port redundancy information
serviceType string: Port service type
state string: Port state
type string: Port type
usedBandwidth number: Port used bandwidth in Mbps
uuid string: Equinix-assigned port identifier

account GetPortAccount: Customer account information that is associated with this port
available_bandwidth int: Port available bandwidth in Mbps
bandwidth int: Port bandwidth in Mbps
change_log GetPortChangeLog: Captures port lifecycle change information
description str: Port description
device GetPortDevice: Port device
encapsulation GetPortEncapsulation: Port encapsulation protocol
href str: Port URI information
id str: The provider-assigned unique ID for this managed resource.
lag_enabled bool: Port Lag
location GetPortLocation: Port location information
name str: Port name
operation GetPortOperation: Port specific operational data
redundancy GetPortRedundancy: Port redundancy information
service_type str: Port service type
state str: Port state
type str: Port type
used_bandwidth int: Port used bandwidth in Mbps
uuid str: Equinix-assigned port identifier

account Property Map: Customer account information that is associated with this port
availableBandwidth Number: Port available bandwidth in Mbps
bandwidth Number: Port bandwidth in Mbps
changeLog Property Map: Captures port lifecycle change information
description String: Port description
device Property Map: Port device
encapsulation Property Map: Port encapsulation protocol
href String: Port URI information
id String: The provider-assigned unique ID for this managed resource.
lagEnabled Boolean: Port Lag
location Property Map: Port location information
name String: Port name
operation Property Map: Port specific operational data
redundancy Property Map: Port redundancy information
serviceType String: Port service type
state String: Port state
type String: Port type
usedBandwidth Number: Port used bandwidth in Mbps
uuid String: Equinix-assigned port identifier

Supporting Types

GetPortAccount

AccountName string: Legal name of the accountholder.
AccountNumber int: Equinix-assigned account number.
GlobalCustId string: Equinix-assigned ID of the subscriber's parent organization.
GlobalOrgId string: Equinix-assigned ID of the subscriber's parent organization.
GlobalOrganizationName string: Equinix-assigned name of the subscriber's parent organization.
OrgId int: Equinix-assigned ID of the subscriber's organization.
OrganizationName string: Equinix-assigned name of the subscriber's organization.
UcmId string: Enterprise datastore id

AccountName string: Legal name of the accountholder.
AccountNumber int: Equinix-assigned account number.
GlobalCustId string: Equinix-assigned ID of the subscriber's parent organization.
GlobalOrgId string: Equinix-assigned ID of the subscriber's parent organization.
GlobalOrganizationName string: Equinix-assigned name of the subscriber's parent organization.
OrgId int: Equinix-assigned ID of the subscriber's organization.
OrganizationName string: Equinix-assigned name of the subscriber's organization.
UcmId string: Enterprise datastore id

accountName String: Legal name of the accountholder.
accountNumber Integer: Equinix-assigned account number.
globalCustId String: Equinix-assigned ID of the subscriber's parent organization.
globalOrgId String: Equinix-assigned ID of the subscriber's parent organization.
globalOrganizationName String: Equinix-assigned name of the subscriber's parent organization.
orgId Integer: Equinix-assigned ID of the subscriber's organization.
organizationName String: Equinix-assigned name of the subscriber's organization.
ucmId String: Enterprise datastore id

accountName string: Legal name of the accountholder.
accountNumber number: Equinix-assigned account number.
globalCustId string: Equinix-assigned ID of the subscriber's parent organization.
globalOrgId string: Equinix-assigned ID of the subscriber's parent organization.
globalOrganizationName string: Equinix-assigned name of the subscriber's parent organization.
orgId number: Equinix-assigned ID of the subscriber's organization.
organizationName string: Equinix-assigned name of the subscriber's organization.
ucmId string: Enterprise datastore id

account_name str: Legal name of the accountholder.
account_number int: Equinix-assigned account number.
global_cust_id str: Equinix-assigned ID of the subscriber's parent organization.
global_org_id str: Equinix-assigned ID of the subscriber's parent organization.
global_organization_name str: Equinix-assigned name of the subscriber's parent organization.
org_id int: Equinix-assigned ID of the subscriber's organization.
organization_name str: Equinix-assigned name of the subscriber's organization.
ucm_id str: Enterprise datastore id

accountName String: Legal name of the accountholder.
accountNumber Number: Equinix-assigned account number.
globalCustId String: Equinix-assigned ID of the subscriber's parent organization.
globalOrgId String: Equinix-assigned ID of the subscriber's parent organization.
globalOrganizationName String: Equinix-assigned name of the subscriber's parent organization.
orgId Number: Equinix-assigned ID of the subscriber's organization.
organizationName String: Equinix-assigned name of the subscriber's organization.
ucmId String: Enterprise datastore id

GetPortChangeLog

CreatedBy string: Created by User Key
CreatedByEmail string: Created by User Email Address
CreatedByFullName string: Created by User Full Name
CreatedDateTime string: Created by 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 Date and Time

GetPortDevice

Name string: Port name
Redundancies List<GetPortDeviceRedundancy>: Port device redundancy

Name string: Port name
Redundancies []GetPortDeviceRedundancy: Port device redundancy

name String: Port name
redundancies List<GetPortDeviceRedundancy>: Port device redundancy

name string: Port name
redundancies GetPortDeviceRedundancy[]: Port device redundancy

name str: Port name
redundancies Sequence[GetPortDeviceRedundancy]: Port device redundancy

name String: Port name
redundancies List<Property Map>: Port device redundancy

GetPortDeviceRedundancy

Enabled bool: Access point redundancy
Group string: Port redundancy group
Priority string: Priority type-Primary or Secondary

Enabled bool: Access point redundancy
Group string: Port redundancy group
Priority string: Priority type-Primary or Secondary

enabled Boolean: Access point redundancy
group String: Port redundancy group
priority String: Priority type-Primary or Secondary

enabled boolean: Access point redundancy
group string: Port redundancy group
priority string: Priority type-Primary or Secondary

enabled bool: Access point redundancy
group str: Port redundancy group
priority str: Priority type-Primary or Secondary

enabled Boolean: Access point redundancy
group String: Port redundancy group
priority String: Priority type-Primary or Secondary

GetPortEncapsulation

TagProtocolId string: Port encapsulation Tag Protocol Identifier
Type string: Port encapsulation protocol type

TagProtocolId string: Port encapsulation Tag Protocol Identifier
Type string: Port encapsulation protocol type

tagProtocolId String: Port encapsulation Tag Protocol Identifier
type String: Port encapsulation protocol type

tagProtocolId string: Port encapsulation Tag Protocol Identifier
type string: Port encapsulation protocol type

tag_protocol_id str: Port encapsulation Tag Protocol Identifier
type str: Port encapsulation protocol type

tagProtocolId String: Port encapsulation Tag Protocol Identifier
type String: Port encapsulation protocol type

GetPortLocation

Ibx string: IBX Code
MetroCode string: Access point metro code
MetroName string: Access point metro name
Region string: Access point region

Ibx string: IBX Code
MetroCode string: Access point metro code
MetroName string: Access point metro name
Region string: Access point region

ibx String: IBX Code
metroCode String: Access point metro code
metroName String: Access point metro name
region String: Access point region

ibx string: IBX Code
metroCode string: Access point metro code
metroName string: Access point metro name
region string: Access point region

ibx str: IBX Code
metro_code str: Access point metro code
metro_name str: Access point metro name
region str: Access point region

ibx String: IBX Code
metroCode String: Access point metro code
metroName String: Access point metro name
region String: Access point region

GetPortOperation

ConnectionCount int: Total number of current connections
OpStatusChangedAt string: Date and time at which port availability changed
OperationalStatus string: Port operation status

ConnectionCount int: Total number of current connections
OpStatusChangedAt string: Date and time at which port availability changed
OperationalStatus string: Port operation status

connectionCount Integer: Total number of current connections
opStatusChangedAt String: Date and time at which port availability changed
operationalStatus String: Port operation status

connectionCount number: Total number of current connections
opStatusChangedAt string: Date and time at which port availability changed
operationalStatus string: Port operation status

connection_count int: Total number of current connections
op_status_changed_at str: Date and time at which port availability changed
operational_status str: Port operation status

connectionCount Number: Total number of current connections
opStatusChangedAt String: Date and time at which port availability changed
operationalStatus String: Port operation status

GetPortRedundancy

Enabled bool: Access point redundancy
Group string: Port redundancy group
Priority string: Priority type-Primary or Secondary

Enabled bool: Access point redundancy
Group string: Port redundancy group
Priority string: Priority type-Primary or Secondary

enabled Boolean: Access point redundancy
group String: Port redundancy group
priority String: Priority type-Primary or Secondary

enabled boolean: Access point redundancy
group string: Port redundancy group
priority string: Priority type-Primary or Secondary

enabled bool: Access point redundancy
group str: Port redundancy group
priority str: Priority type-Primary or Secondary

enabled Boolean: Access point redundancy
group String: Port redundancy group
priority String: Priority type-Primary or Secondary

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.fabric.getPort

On this page

On this page

Example Usage

Using getPort

getPort Result

Supporting Types

GetPortAccount

GetPortChangeLog

GetPortDevice

GetPortDeviceRedundancy

GetPortEncapsulation

GetPortLocation

GetPortOperation

GetPortRedundancy

Package Details

On this page

On this page