Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Megaport Provider
  3. API Docs
  4. Port
megaport 1.3.6 published on Wednesday, Apr 30, 2025 by megaport
megaport/terraform-provider-megaport

megaport.Port

Explore with Pulumi AI

megaport logo
megaport 1.3.6 published on Wednesday, Apr 30, 2025 by megaport
megaport/terraform-provider-megaport

    Example Usage

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

const port = new megaport.Port("port", {
    contractTermMonths: 1,
    costCentre: "Megaport Single Port Example",
    locationId: 6,
    marketplaceVisibility: false,
    portSpeed: 1000,
    productName: "Megaport Port Example",
});

    import pulumi
import pulumi_megaport as megaport

port = megaport.Port("port",
    contract_term_months=1,
    cost_centre="Megaport Single Port Example",
    location_id=6,
    marketplace_visibility=False,
    port_speed=1000,
    product_name="Megaport Port Example")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/megaport/megaport"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := megaport.NewPort(ctx, "port", &megaport.PortArgs{
			ContractTermMonths:    pulumi.Float64(1),
			CostCentre:            pulumi.String("Megaport Single Port Example"),
			LocationId:            pulumi.Float64(6),
			MarketplaceVisibility: pulumi.Bool(false),
			PortSpeed:             pulumi.Float64(1000),
			ProductName:           pulumi.String("Megaport Port Example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var port = new Megaport.Port("port", new()
    {
        ContractTermMonths = 1,
        CostCentre = "Megaport Single Port Example",
        LocationId = 6,
        MarketplaceVisibility = false,
        PortSpeed = 1000,
        ProductName = "Megaport Port Example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.megaport.Port;
import com.pulumi.megaport.PortArgs;
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) {
        var port = new Port("port", PortArgs.builder()
            .contractTermMonths(1)
            .costCentre("Megaport Single Port Example")
            .locationId(6)
            .marketplaceVisibility(false)
            .portSpeed(1000)
            .productName("Megaport Port Example")
            .build());

    }
}

    resources:
  port:
    type: megaport:Port
    properties:
      contractTermMonths: 1
      costCentre: Megaport Single Port Example
      locationId: 6
      marketplaceVisibility: false
      portSpeed: 1000
      productName: Megaport Port Example

    Create Port Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Port(name: string, args: PortArgs, opts?: CustomResourceOptions);
    @overload
def Port(resource_name: str,
         args: PortArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Port(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         contract_term_months: Optional[float] = None,
         location_id: Optional[float] = None,
         marketplace_visibility: Optional[bool] = None,
         port_speed: Optional[float] = None,
         product_name: Optional[str] = None,
         cost_centre: Optional[str] = None,
         diversity_zone: Optional[str] = None,
         promo_code: Optional[str] = None,
         resource_tags: Optional[Mapping[str, str]] = None)
    func NewPort(ctx *Context, name string, args PortArgs, opts ...ResourceOption) (*Port, error)
    public Port(string name, PortArgs args, CustomResourceOptions? opts = null)
    public Port(String name, PortArgs args)
public Port(String name, PortArgs args, CustomResourceOptions options)

    type: megaport:Port
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PortArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PortArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PortArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PortArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PortArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var portResource = new Megaport.Port("portResource", new()
{
    ContractTermMonths = 0,
    LocationId = 0,
    MarketplaceVisibility = false,
    PortSpeed = 0,
    ProductName = "string",
    CostCentre = "string",
    DiversityZone = "string",
    PromoCode = "string",
    ResourceTags = 
    {
        { "string", "string" },
    },
});

    example, err := megaport.NewPort(ctx, "portResource", &megaport.PortArgs{
	ContractTermMonths:    pulumi.Float64(0),
	LocationId:            pulumi.Float64(0),
	MarketplaceVisibility: pulumi.Bool(false),
	PortSpeed:             pulumi.Float64(0),
	ProductName:           pulumi.String("string"),
	CostCentre:            pulumi.String("string"),
	DiversityZone:         pulumi.String("string"),
	PromoCode:             pulumi.String("string"),
	ResourceTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var portResource = new Port("portResource", PortArgs.builder()
    .contractTermMonths(0.0)
    .locationId(0.0)
    .marketplaceVisibility(false)
    .portSpeed(0.0)
    .productName("string")
    .costCentre("string")
    .diversityZone("string")
    .promoCode("string")
    .resourceTags(Map.of("string", "string"))
    .build());

    port_resource = megaport.Port("portResource",
    contract_term_months=0,
    location_id=0,
    marketplace_visibility=False,
    port_speed=0,
    product_name="string",
    cost_centre="string",
    diversity_zone="string",
    promo_code="string",
    resource_tags={
        "string": "string",
    })

    const portResource = new megaport.Port("portResource", {
    contractTermMonths: 0,
    locationId: 0,
    marketplaceVisibility: false,
    portSpeed: 0,
    productName: "string",
    costCentre: "string",
    diversityZone: "string",
    promoCode: "string",
    resourceTags: {
        string: "string",
    },
});

    type: megaport:Port
properties:
    contractTermMonths: 0
    costCentre: string
    diversityZone: string
    locationId: 0
    marketplaceVisibility: false
    portSpeed: 0
    productName: string
    promoCode: string
    resourceTags:
        string: string

    Port Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Port resource accepts the following input properties:

    ContractTermMonths double
    The term of the contract in months: valid values are 1, 12, 24, and 36. To set the product to a month-to-month contract with no minimum term, set the value to 1.
    LocationId double
    The numeric location ID of the product. This value can be retrieved from the data source megaport_location.
    MarketplaceVisibility bool
    Whether the product is visible in the marketplace. By default, the Port is private to your enterprise and consumes services from the Megaport network for your own internal company, team, and resources. When set to Private, the Port is not searchable in the Megaport Marketplace (however, others can still connect to you using a service key). Click Public to make the new Port and profile visible on the Megaport network for inbound connection requests. It is possible to change the Port from Private to Public after the initial setup.
    PortSpeed double
    The speed of the port in Mbps.
    ProductName string
    The name of the product. Specify a name for the Port that is easily identifiable, particularly if you plan on having more than one Port.
    CostCentre string
    A customer reference number to be included in billing information and invoices. Also known as the service level reference (SLR) number. Specify a unique identifying number for the product to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service. Please note that a VXC associated with the Port is not automatically updated with the Port service level reference number.
    DiversityZone string
    The diversity zone of the product.
    PromoCode string
    Promo code is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesn't exist or doesn't work for the service, the request will still be successful.
    ResourceTags Dictionary<string, string>
    The resource tags associated with the product.
    ContractTermMonths float64
    The term of the contract in months: valid values are 1, 12, 24, and 36. To set the product to a month-to-month contract with no minimum term, set the value to 1.
    LocationId float64
    The numeric location ID of the product. This value can be retrieved from the data source megaport_location.
    MarketplaceVisibility bool
    Whether the product is visible in the marketplace. By default, the Port is private to your enterprise and consumes services from the Megaport network for your own internal company, team, and resources. When set to Private, the Port is not searchable in the Megaport Marketplace (however, others can still connect to you using a service key). Click Public to make the new Port and profile visible on the Megaport network for inbound connection requests. It is possible to change the Port from Private to Public after the initial setup.
    PortSpeed float64
    The speed of the port in Mbps.
    ProductName string
    The name of the product. Specify a name for the Port that is easily identifiable, particularly if you plan on having more than one Port.
    CostCentre string
    A customer reference number to be included in billing information and invoices. Also known as the service level reference (SLR) number. Specify a unique identifying number for the product to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service. Please note that a VXC associated with the Port is not automatically updated with the Port service level reference number.
    DiversityZone string
    The diversity zone of the product.
    PromoCode string
    Promo code is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesn't exist or doesn't work for the service, the request will still be successful.
    ResourceTags map[string]string
    The resource tags associated with the product.
    contractTermMonths Double
    The term of the contract in months: valid values are 1, 12, 24, and 36. To set the product to a month-to-month contract with no minimum term, set the value to 1.
    locationId Double
    The numeric location ID of the product. This value can be retrieved from the data source megaport_location.
    marketplaceVisibility Boolean
    Whether the product is visible in the marketplace. By default, the Port is private to your enterprise and consumes services from the Megaport network for your own internal company, team, and resources. When set to Private, the Port is not searchable in the Megaport Marketplace (however, others can still connect to you using a service key). Click Public to make the new Port and profile visible on the Megaport network for inbound connection requests. It is possible to change the Port from Private to Public after the initial setup.
    portSpeed Double
    The speed of the port in Mbps.
    productName String
    The name of the product. Specify a name for the Port that is easily identifiable, particularly if you plan on having more than one Port.
    costCentre String
    A customer reference number to be included in billing information and invoices. Also known as the service level reference (SLR) number. Specify a unique identifying number for the product to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service. Please note that a VXC associated with the Port is not automatically updated with the Port service level reference number.
    diversityZone String
    The diversity zone of the product.
    promoCode String
    Promo code is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesn't exist or doesn't work for the service, the request will still be successful.
    resourceTags Map<String,String>
    The resource tags associated with the product.
    contractTermMonths number
    The term of the contract in months: valid values are 1, 12, 24, and 36. To set the product to a month-to-month contract with no minimum term, set the value to 1.
    locationId number
    The numeric location ID of the product. This value can be retrieved from the data source megaport_location.
    marketplaceVisibility boolean
    Whether the product is visible in the marketplace. By default, the Port is private to your enterprise and consumes services from the Megaport network for your own internal company, team, and resources. When set to Private, the Port is not searchable in the Megaport Marketplace (however, others can still connect to you using a service key). Click Public to make the new Port and profile visible on the Megaport network for inbound connection requests. It is possible to change the Port from Private to Public after the initial setup.
    portSpeed number
    The speed of the port in Mbps.
    productName string
    The name of the product. Specify a name for the Port that is easily identifiable, particularly if you plan on having more than one Port.
    costCentre string
    A customer reference number to be included in billing information and invoices. Also known as the service level reference (SLR) number. Specify a unique identifying number for the product to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service. Please note that a VXC associated with the Port is not automatically updated with the Port service level reference number.
    diversityZone string
    The diversity zone of the product.
    promoCode string
    Promo code is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesn't exist or doesn't work for the service, the request will still be successful.
    resourceTags {[key: string]: string}
    The resource tags associated with the product.
    contract_term_months float
    The term of the contract in months: valid values are 1, 12, 24, and 36. To set the product to a month-to-month contract with no minimum term, set the value to 1.
    location_id float
    The numeric location ID of the product. This value can be retrieved from the data source megaport_location.
    marketplace_visibility bool
    Whether the product is visible in the marketplace. By default, the Port is private to your enterprise and consumes services from the Megaport network for your own internal company, team, and resources. When set to Private, the Port is not searchable in the Megaport Marketplace (however, others can still connect to you using a service key). Click Public to make the new Port and profile visible on the Megaport network for inbound connection requests. It is possible to change the Port from Private to Public after the initial setup.
    port_speed float
    The speed of the port in Mbps.
    product_name str
    The name of the product. Specify a name for the Port that is easily identifiable, particularly if you plan on having more than one Port.
    cost_centre str
    A customer reference number to be included in billing information and invoices. Also known as the service level reference (SLR) number. Specify a unique identifying number for the product to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service. Please note that a VXC associated with the Port is not automatically updated with the Port service level reference number.
    diversity_zone str
    The diversity zone of the product.
    promo_code str
    Promo code is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesn't exist or doesn't work for the service, the request will still be successful.
    resource_tags Mapping[str, str]
    The resource tags associated with the product.
    contractTermMonths Number
    The term of the contract in months: valid values are 1, 12, 24, and 36. To set the product to a month-to-month contract with no minimum term, set the value to 1.
    locationId Number
    The numeric location ID of the product. This value can be retrieved from the data source megaport_location.
    marketplaceVisibility Boolean
    Whether the product is visible in the marketplace. By default, the Port is private to your enterprise and consumes services from the Megaport network for your own internal company, team, and resources. When set to Private, the Port is not searchable in the Megaport Marketplace (however, others can still connect to you using a service key). Click Public to make the new Port and profile visible on the Megaport network for inbound connection requests. It is possible to change the Port from Private to Public after the initial setup.
    portSpeed Number
    The speed of the port in Mbps.
    productName String
    The name of the product. Specify a name for the Port that is easily identifiable, particularly if you plan on having more than one Port.
    costCentre String
    A customer reference number to be included in billing information and invoices. Also known as the service level reference (SLR) number. Specify a unique identifying number for the product to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service. Please note that a VXC associated with the Port is not automatically updated with the Port service level reference number.
    diversityZone String
    The diversity zone of the product.
    promoCode String
    Promo code is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesn't exist or doesn't work for the service, the request will still be successful.
    resourceTags Map<String>
    The resource tags associated with the product.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Port resource produces the following output properties:

    Cancelable bool
    Whether the product is cancelable.
    CompanyUid string
    The unique identifier of the company.
    ContractEndDate string
    The date the contract ends.
    ContractStartDate string
    The date the contract started.
    CreateDate string
    The date the product was created.
    CreatedBy string
    The user who created the product.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    The last time the resource was updated.
    LiveDate string
    The date the product went live.
    Locked bool
    Whether the product is locked.
    Market string
    The market the product is in.
    ProductId double
    The numeric ID of the product.
    ProductUid string
    The unique identifier for the resource.
    ProvisioningStatus string
    The provisioning status of the product.
    Resources PortResources
    Resources attached to port.
    TerminateDate string
    The date the product will be terminated.
    UsageAlgorithm string
    The usage algorithm for the product.
    Virtual bool
    Whether the product is virtual.
    VxcAutoApproval bool
    Whether VXC is auto-approved on this product.
    VxcPermitted bool
    Whether VXC is permitted on this product.
    Cancelable bool
    Whether the product is cancelable.
    CompanyUid string
    The unique identifier of the company.
    ContractEndDate string
    The date the contract ends.
    ContractStartDate string
    The date the contract started.
    CreateDate string
    The date the product was created.
    CreatedBy string
    The user who created the product.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    The last time the resource was updated.
    LiveDate string
    The date the product went live.
    Locked bool
    Whether the product is locked.
    Market string
    The market the product is in.
    ProductId float64
    The numeric ID of the product.
    ProductUid string
    The unique identifier for the resource.
    ProvisioningStatus string
    The provisioning status of the product.
    Resources PortResources
    Resources attached to port.
    TerminateDate string
    The date the product will be terminated.
    UsageAlgorithm string
    The usage algorithm for the product.
    Virtual bool
    Whether the product is virtual.
    VxcAutoApproval bool
    Whether VXC is auto-approved on this product.
    VxcPermitted bool
    Whether VXC is permitted on this product.
    cancelable Boolean
    Whether the product is cancelable.
    companyUid String
    The unique identifier of the company.
    contractEndDate String
    The date the contract ends.
    contractStartDate String
    The date the contract started.
    createDate String
    The date the product was created.
    createdBy String
    The user who created the product.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    The last time the resource was updated.
    liveDate String
    The date the product went live.
    locked Boolean
    Whether the product is locked.
    market String
    The market the product is in.
    productId Double
    The numeric ID of the product.
    productUid String
    The unique identifier for the resource.
    provisioningStatus String
    The provisioning status of the product.
    resources PortResources
    Resources attached to port.
    terminateDate String
    The date the product will be terminated.
    usageAlgorithm String
    The usage algorithm for the product.
    virtual Boolean
    Whether the product is virtual.
    vxcAutoApproval Boolean
    Whether VXC is auto-approved on this product.
    vxcPermitted Boolean
    Whether VXC is permitted on this product.
    cancelable boolean
    Whether the product is cancelable.
    companyUid string
    The unique identifier of the company.
    contractEndDate string
    The date the contract ends.
    contractStartDate string
    The date the contract started.
    createDate string
    The date the product was created.
    createdBy string
    The user who created the product.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdated string
    The last time the resource was updated.
    liveDate string
    The date the product went live.
    locked boolean
    Whether the product is locked.
    market string
    The market the product is in.
    productId number
    The numeric ID of the product.
    productUid string
    The unique identifier for the resource.
    provisioningStatus string
    The provisioning status of the product.
    resources PortResources
    Resources attached to port.
    terminateDate string
    The date the product will be terminated.
    usageAlgorithm string
    The usage algorithm for the product.
    virtual boolean
    Whether the product is virtual.
    vxcAutoApproval boolean
    Whether VXC is auto-approved on this product.
    vxcPermitted boolean
    Whether VXC is permitted on this product.
    cancelable bool
    Whether the product is cancelable.
    company_uid str
    The unique identifier of the company.
    contract_end_date str
    The date the contract ends.
    contract_start_date str
    The date the contract started.
    create_date str
    The date the product was created.
    created_by str
    The user who created the product.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated str
    The last time the resource was updated.
    live_date str
    The date the product went live.
    locked bool
    Whether the product is locked.
    market str
    The market the product is in.
    product_id float
    The numeric ID of the product.
    product_uid str
    The unique identifier for the resource.
    provisioning_status str
    The provisioning status of the product.
    resources PortResources
    Resources attached to port.
    terminate_date str
    The date the product will be terminated.
    usage_algorithm str
    The usage algorithm for the product.
    virtual bool
    Whether the product is virtual.
    vxc_auto_approval bool
    Whether VXC is auto-approved on this product.
    vxc_permitted bool
    Whether VXC is permitted on this product.
    cancelable Boolean
    Whether the product is cancelable.
    companyUid String
    The unique identifier of the company.
    contractEndDate String
    The date the contract ends.
    contractStartDate String
    The date the contract started.
    createDate String
    The date the product was created.
    createdBy String
    The user who created the product.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    The last time the resource was updated.
    liveDate String
    The date the product went live.
    locked Boolean
    Whether the product is locked.
    market String
    The market the product is in.
    productId Number
    The numeric ID of the product.
    productUid String
    The unique identifier for the resource.
    provisioningStatus String
    The provisioning status of the product.
    resources Property Map
    Resources attached to port.
    terminateDate String
    The date the product will be terminated.
    usageAlgorithm String
    The usage algorithm for the product.
    virtual Boolean
    Whether the product is virtual.
    vxcAutoApproval Boolean
    Whether VXC is auto-approved on this product.
    vxcPermitted Boolean
    Whether VXC is permitted on this product.

    Look up Existing Port Resource

    Get an existing Port resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PortState, opts?: CustomResourceOptions): Port
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cancelable: Optional[bool] = None,
        company_uid: Optional[str] = None,
        contract_end_date: Optional[str] = None,
        contract_start_date: Optional[str] = None,
        contract_term_months: Optional[float] = None,
        cost_centre: Optional[str] = None,
        create_date: Optional[str] = None,
        created_by: Optional[str] = None,
        diversity_zone: Optional[str] = None,
        last_updated: Optional[str] = None,
        live_date: Optional[str] = None,
        location_id: Optional[float] = None,
        locked: Optional[bool] = None,
        market: Optional[str] = None,
        marketplace_visibility: Optional[bool] = None,
        port_speed: Optional[float] = None,
        product_id: Optional[float] = None,
        product_name: Optional[str] = None,
        product_uid: Optional[str] = None,
        promo_code: Optional[str] = None,
        provisioning_status: Optional[str] = None,
        resource_tags: Optional[Mapping[str, str]] = None,
        resources: Optional[PortResourcesArgs] = None,
        terminate_date: Optional[str] = None,
        usage_algorithm: Optional[str] = None,
        virtual: Optional[bool] = None,
        vxc_auto_approval: Optional[bool] = None,
        vxc_permitted: Optional[bool] = None) -> Port
    func GetPort(ctx *Context, name string, id IDInput, state *PortState, opts ...ResourceOption) (*Port, error)
    public static Port Get(string name, Input<string> id, PortState? state, CustomResourceOptions? opts = null)
    public static Port get(String name, Output<String> id, PortState state, CustomResourceOptions options)
    resources:  _:    type: megaport:Port    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Cancelable bool
    Whether the product is cancelable.
    CompanyUid string
    The unique identifier of the company.
    ContractEndDate string
    The date the contract ends.
    ContractStartDate string
    The date the contract started.
    ContractTermMonths double
    The term of the contract in months: valid values are 1, 12, 24, and 36. To set the product to a month-to-month contract with no minimum term, set the value to 1.
    CostCentre string
    A customer reference number to be included in billing information and invoices. Also known as the service level reference (SLR) number. Specify a unique identifying number for the product to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service. Please note that a VXC associated with the Port is not automatically updated with the Port service level reference number.
    CreateDate string
    The date the product was created.
    CreatedBy string
    The user who created the product.
    DiversityZone string
    The diversity zone of the product.
    LastUpdated string
    The last time the resource was updated.
    LiveDate string
    The date the product went live.
    LocationId double
    The numeric location ID of the product. This value can be retrieved from the data source megaport_location.
    Locked bool
    Whether the product is locked.
    Market string
    The market the product is in.
    MarketplaceVisibility bool
    Whether the product is visible in the marketplace. By default, the Port is private to your enterprise and consumes services from the Megaport network for your own internal company, team, and resources. When set to Private, the Port is not searchable in the Megaport Marketplace (however, others can still connect to you using a service key). Click Public to make the new Port and profile visible on the Megaport network for inbound connection requests. It is possible to change the Port from Private to Public after the initial setup.
    PortSpeed double
    The speed of the port in Mbps.
    ProductId double
    The numeric ID of the product.
    ProductName string
    The name of the product. Specify a name for the Port that is easily identifiable, particularly if you plan on having more than one Port.
    ProductUid string
    The unique identifier for the resource.
    PromoCode string
    Promo code is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesn't exist or doesn't work for the service, the request will still be successful.
    ProvisioningStatus string
    The provisioning status of the product.
    ResourceTags Dictionary<string, string>
    The resource tags associated with the product.
    Resources PortResources
    Resources attached to port.
    TerminateDate string
    The date the product will be terminated.
    UsageAlgorithm string
    The usage algorithm for the product.
    Virtual bool
    Whether the product is virtual.
    VxcAutoApproval bool
    Whether VXC is auto-approved on this product.
    VxcPermitted bool
    Whether VXC is permitted on this product.
    Cancelable bool
    Whether the product is cancelable.
    CompanyUid string
    The unique identifier of the company.
    ContractEndDate string
    The date the contract ends.
    ContractStartDate string
    The date the contract started.
    ContractTermMonths float64
    The term of the contract in months: valid values are 1, 12, 24, and 36. To set the product to a month-to-month contract with no minimum term, set the value to 1.
    CostCentre string
    A customer reference number to be included in billing information and invoices. Also known as the service level reference (SLR) number. Specify a unique identifying number for the product to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service. Please note that a VXC associated with the Port is not automatically updated with the Port service level reference number.
    CreateDate string
    The date the product was created.
    CreatedBy string
    The user who created the product.
    DiversityZone string
    The diversity zone of the product.
    LastUpdated string
    The last time the resource was updated.
    LiveDate string
    The date the product went live.
    LocationId float64
    The numeric location ID of the product. This value can be retrieved from the data source megaport_location.
    Locked bool
    Whether the product is locked.
    Market string
    The market the product is in.
    MarketplaceVisibility bool
    Whether the product is visible in the marketplace. By default, the Port is private to your enterprise and consumes services from the Megaport network for your own internal company, team, and resources. When set to Private, the Port is not searchable in the Megaport Marketplace (however, others can still connect to you using a service key). Click Public to make the new Port and profile visible on the Megaport network for inbound connection requests. It is possible to change the Port from Private to Public after the initial setup.
    PortSpeed float64
    The speed of the port in Mbps.
    ProductId float64
    The numeric ID of the product.
    ProductName string
    The name of the product. Specify a name for the Port that is easily identifiable, particularly if you plan on having more than one Port.
    ProductUid string
    The unique identifier for the resource.
    PromoCode string
    Promo code is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesn't exist or doesn't work for the service, the request will still be successful.
    ProvisioningStatus string
    The provisioning status of the product.
    ResourceTags map[string]string
    The resource tags associated with the product.
    Resources PortResourcesArgs
    Resources attached to port.
    TerminateDate string
    The date the product will be terminated.
    UsageAlgorithm string
    The usage algorithm for the product.
    Virtual bool
    Whether the product is virtual.
    VxcAutoApproval bool
    Whether VXC is auto-approved on this product.
    VxcPermitted bool
    Whether VXC is permitted on this product.
    cancelable Boolean
    Whether the product is cancelable.
    companyUid String
    The unique identifier of the company.
    contractEndDate String
    The date the contract ends.
    contractStartDate String
    The date the contract started.
    contractTermMonths Double
    The term of the contract in months: valid values are 1, 12, 24, and 36. To set the product to a month-to-month contract with no minimum term, set the value to 1.
    costCentre String
    A customer reference number to be included in billing information and invoices. Also known as the service level reference (SLR) number. Specify a unique identifying number for the product to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service. Please note that a VXC associated with the Port is not automatically updated with the Port service level reference number.
    createDate String
    The date the product was created.
    createdBy String
    The user who created the product.
    diversityZone String
    The diversity zone of the product.
    lastUpdated String
    The last time the resource was updated.
    liveDate String
    The date the product went live.
    locationId Double
    The numeric location ID of the product. This value can be retrieved from the data source megaport_location.
    locked Boolean
    Whether the product is locked.
    market String
    The market the product is in.
    marketplaceVisibility Boolean
    Whether the product is visible in the marketplace. By default, the Port is private to your enterprise and consumes services from the Megaport network for your own internal company, team, and resources. When set to Private, the Port is not searchable in the Megaport Marketplace (however, others can still connect to you using a service key). Click Public to make the new Port and profile visible on the Megaport network for inbound connection requests. It is possible to change the Port from Private to Public after the initial setup.
    portSpeed Double
    The speed of the port in Mbps.
    productId Double
    The numeric ID of the product.
    productName String
    The name of the product. Specify a name for the Port that is easily identifiable, particularly if you plan on having more than one Port.
    productUid String
    The unique identifier for the resource.
    promoCode String
    Promo code is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesn't exist or doesn't work for the service, the request will still be successful.
    provisioningStatus String
    The provisioning status of the product.
    resourceTags Map<String,String>
    The resource tags associated with the product.
    resources PortResources
    Resources attached to port.
    terminateDate String
    The date the product will be terminated.
    usageAlgorithm String
    The usage algorithm for the product.
    virtual Boolean
    Whether the product is virtual.
    vxcAutoApproval Boolean
    Whether VXC is auto-approved on this product.
    vxcPermitted Boolean
    Whether VXC is permitted on this product.
    cancelable boolean
    Whether the product is cancelable.
    companyUid string
    The unique identifier of the company.
    contractEndDate string
    The date the contract ends.
    contractStartDate string
    The date the contract started.
    contractTermMonths number
    The term of the contract in months: valid values are 1, 12, 24, and 36. To set the product to a month-to-month contract with no minimum term, set the value to 1.
    costCentre string
    A customer reference number to be included in billing information and invoices. Also known as the service level reference (SLR) number. Specify a unique identifying number for the product to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service. Please note that a VXC associated with the Port is not automatically updated with the Port service level reference number.
    createDate string
    The date the product was created.
    createdBy string
    The user who created the product.
    diversityZone string
    The diversity zone of the product.
    lastUpdated string
    The last time the resource was updated.
    liveDate string
    The date the product went live.
    locationId number
    The numeric location ID of the product. This value can be retrieved from the data source megaport_location.
    locked boolean
    Whether the product is locked.
    market string
    The market the product is in.
    marketplaceVisibility boolean
    Whether the product is visible in the marketplace. By default, the Port is private to your enterprise and consumes services from the Megaport network for your own internal company, team, and resources. When set to Private, the Port is not searchable in the Megaport Marketplace (however, others can still connect to you using a service key). Click Public to make the new Port and profile visible on the Megaport network for inbound connection requests. It is possible to change the Port from Private to Public after the initial setup.
    portSpeed number
    The speed of the port in Mbps.
    productId number
    The numeric ID of the product.
    productName string
    The name of the product. Specify a name for the Port that is easily identifiable, particularly if you plan on having more than one Port.
    productUid string
    The unique identifier for the resource.
    promoCode string
    Promo code is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesn't exist or doesn't work for the service, the request will still be successful.
    provisioningStatus string
    The provisioning status of the product.
    resourceTags {[key: string]: string}
    The resource tags associated with the product.
    resources PortResources
    Resources attached to port.
    terminateDate string
    The date the product will be terminated.
    usageAlgorithm string
    The usage algorithm for the product.
    virtual boolean
    Whether the product is virtual.
    vxcAutoApproval boolean
    Whether VXC is auto-approved on this product.
    vxcPermitted boolean
    Whether VXC is permitted on this product.
    cancelable bool
    Whether the product is cancelable.
    company_uid str
    The unique identifier of the company.
    contract_end_date str
    The date the contract ends.
    contract_start_date str
    The date the contract started.
    contract_term_months float
    The term of the contract in months: valid values are 1, 12, 24, and 36. To set the product to a month-to-month contract with no minimum term, set the value to 1.
    cost_centre str
    A customer reference number to be included in billing information and invoices. Also known as the service level reference (SLR) number. Specify a unique identifying number for the product to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service. Please note that a VXC associated with the Port is not automatically updated with the Port service level reference number.
    create_date str
    The date the product was created.
    created_by str
    The user who created the product.
    diversity_zone str
    The diversity zone of the product.
    last_updated str
    The last time the resource was updated.
    live_date str
    The date the product went live.
    location_id float
    The numeric location ID of the product. This value can be retrieved from the data source megaport_location.
    locked bool
    Whether the product is locked.
    market str
    The market the product is in.
    marketplace_visibility bool
    Whether the product is visible in the marketplace. By default, the Port is private to your enterprise and consumes services from the Megaport network for your own internal company, team, and resources. When set to Private, the Port is not searchable in the Megaport Marketplace (however, others can still connect to you using a service key). Click Public to make the new Port and profile visible on the Megaport network for inbound connection requests. It is possible to change the Port from Private to Public after the initial setup.
    port_speed float
    The speed of the port in Mbps.
    product_id float
    The numeric ID of the product.
    product_name str
    The name of the product. Specify a name for the Port that is easily identifiable, particularly if you plan on having more than one Port.
    product_uid str
    The unique identifier for the resource.
    promo_code str
    Promo code is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesn't exist or doesn't work for the service, the request will still be successful.
    provisioning_status str
    The provisioning status of the product.
    resource_tags Mapping[str, str]
    The resource tags associated with the product.
    resources PortResourcesArgs
    Resources attached to port.
    terminate_date str
    The date the product will be terminated.
    usage_algorithm str
    The usage algorithm for the product.
    virtual bool
    Whether the product is virtual.
    vxc_auto_approval bool
    Whether VXC is auto-approved on this product.
    vxc_permitted bool
    Whether VXC is permitted on this product.
    cancelable Boolean
    Whether the product is cancelable.
    companyUid String
    The unique identifier of the company.
    contractEndDate String
    The date the contract ends.
    contractStartDate String
    The date the contract started.
    contractTermMonths Number
    The term of the contract in months: valid values are 1, 12, 24, and 36. To set the product to a month-to-month contract with no minimum term, set the value to 1.
    costCentre String
    A customer reference number to be included in billing information and invoices. Also known as the service level reference (SLR) number. Specify a unique identifying number for the product to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service. Please note that a VXC associated with the Port is not automatically updated with the Port service level reference number.
    createDate String
    The date the product was created.
    createdBy String
    The user who created the product.
    diversityZone String
    The diversity zone of the product.
    lastUpdated String
    The last time the resource was updated.
    liveDate String
    The date the product went live.
    locationId Number
    The numeric location ID of the product. This value can be retrieved from the data source megaport_location.
    locked Boolean
    Whether the product is locked.
    market String
    The market the product is in.
    marketplaceVisibility Boolean
    Whether the product is visible in the marketplace. By default, the Port is private to your enterprise and consumes services from the Megaport network for your own internal company, team, and resources. When set to Private, the Port is not searchable in the Megaport Marketplace (however, others can still connect to you using a service key). Click Public to make the new Port and profile visible on the Megaport network for inbound connection requests. It is possible to change the Port from Private to Public after the initial setup.
    portSpeed Number
    The speed of the port in Mbps.
    productId Number
    The numeric ID of the product.
    productName String
    The name of the product. Specify a name for the Port that is easily identifiable, particularly if you plan on having more than one Port.
    productUid String
    The unique identifier for the resource.
    promoCode String
    Promo code is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesn't exist or doesn't work for the service, the request will still be successful.
    provisioningStatus String
    The provisioning status of the product.
    resourceTags Map<String>
    The resource tags associated with the product.
    resources Property Map
    Resources attached to port.
    terminateDate String
    The date the product will be terminated.
    usageAlgorithm String
    The usage algorithm for the product.
    virtual Boolean
    Whether the product is virtual.
    vxcAutoApproval Boolean
    Whether VXC is auto-approved on this product.
    vxcPermitted Boolean
    Whether VXC is permitted on this product.

    Supporting Types

    PortResources, PortResourcesArgs

    Interface PortResourcesInterface
    Port interface details.
    Interface PortResourcesInterface
    Port interface details.
    interface_ PortResourcesInterface
    Port interface details.
    interface PortResourcesInterface
    Port interface details.
    interface PortResourcesInterface
    Port interface details.
    interface Property Map
    Port interface details.

    PortResourcesInterface, PortResourcesInterfaceArgs

    Demarcation string
    The demarcation of the interface.
    Up double
    The up status of the interface.
    Demarcation string
    The demarcation of the interface.
    Up float64
    The up status of the interface.
    demarcation String
    The demarcation of the interface.
    up Double
    The up status of the interface.
    demarcation string
    The demarcation of the interface.
    up number
    The up status of the interface.
    demarcation str
    The demarcation of the interface.
    up float
    The up status of the interface.
    demarcation String
    The demarcation of the interface.
    up Number
    The up status of the interface.

    Import

    Order can be imported by specifying the Product UID.

    $ pulumi import megaport:index/port:Port example "<PRODUCT_UID>"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    megaport megaport/terraform-provider-megaport
    License
    Notes
    This Pulumi package is based on the megaport Terraform Provider.
    megaport logo
    megaport 1.3.6 published on Wednesday, Apr 30, 2025 by megaport
    megaport/terraform-provider-megaport