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

megaport.getPartner

Explore with Pulumi AI

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

    Partner Port Data Source. Returns the interfaces Megaport has with cloud service providers.

    Example Usage

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

const awsPort = megaport.getPartner({
    companyName: "AWS",
    connectType: "AWS",
    locationId: 3,
    productName: "Asia Pacific (Sydney) (ap-southeast-2)",
});

    import pulumi
import pulumi_megaport as megaport

aws_port = megaport.get_partner(company_name="AWS",
    connect_type="AWS",
    location_id=3,
    product_name="Asia Pacific (Sydney) (ap-southeast-2)")

    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.GetPartner(ctx, &megaport.GetPartnerArgs{
			CompanyName: pulumi.StringRef("AWS"),
			ConnectType: pulumi.StringRef("AWS"),
			LocationId:  pulumi.Float64Ref(3),
			ProductName: pulumi.StringRef("Asia Pacific (Sydney) (ap-southeast-2)"),
		}, nil)
		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 awsPort = Megaport.GetPartner.Invoke(new()
    {
        CompanyName = "AWS",
        ConnectType = "AWS",
        LocationId = 3,
        ProductName = "Asia Pacific (Sydney) (ap-southeast-2)",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.megaport.MegaportFunctions;
import com.pulumi.megaport.inputs.GetPartnerArgs;
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 awsPort = MegaportFunctions.getPartner(GetPartnerArgs.builder()
            .companyName("AWS")
            .connectType("AWS")
            .locationId(3)
            .productName("Asia Pacific (Sydney) (ap-southeast-2)")
            .build());

    }
}

    variables:
  awsPort:
    fn::invoke:
      function: megaport:getPartner
      arguments:
        companyName: AWS
        connectType: AWS
        locationId: 3
        productName: Asia Pacific (Sydney) (ap-southeast-2)

    Using getPartner

    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 getPartner(args: GetPartnerArgs, opts?: InvokeOptions): Promise<GetPartnerResult>
function getPartnerOutput(args: GetPartnerOutputArgs, opts?: InvokeOptions): Output<GetPartnerResult>
    def get_partner(company_name: Optional[str] = None,
                company_uid: Optional[str] = None,
                connect_type: Optional[str] = None,
                diversity_zone: Optional[str] = None,
                location_id: Optional[float] = None,
                product_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetPartnerResult
def get_partner_output(company_name: Optional[pulumi.Input[str]] = None,
                company_uid: Optional[pulumi.Input[str]] = None,
                connect_type: Optional[pulumi.Input[str]] = None,
                diversity_zone: Optional[pulumi.Input[str]] = None,
                location_id: Optional[pulumi.Input[float]] = None,
                product_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetPartnerResult]
    func GetPartner(ctx *Context, args *GetPartnerArgs, opts ...InvokeOption) (*GetPartnerResult, error)
func GetPartnerOutput(ctx *Context, args *GetPartnerOutputArgs, opts ...InvokeOption) GetPartnerResultOutput

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

    public static class GetPartner 
{
    public static Task<GetPartnerResult> InvokeAsync(GetPartnerArgs args, InvokeOptions? opts = null)
    public static Output<GetPartnerResult> Invoke(GetPartnerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPartnerResult> getPartner(GetPartnerArgs args, InvokeOptions options)
public static Output<GetPartnerResult> getPartner(GetPartnerArgs args, InvokeOptions options)

    fn::invoke:
  function: megaport:index/getPartner:getPartner
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompanyName string
    The name of the company that owns the partner port.
    CompanyUid string
    The unique identifier of the company that owns the partner port.
    ConnectType string
    The type of connection for the partner port. Filters the locations based on the cloud providers, such as AWS (for Hosted VIF), AWSHC (for Hosted Connection), AZURE, GOOGLE, ORACLE, OUTSCALE, and IBM. Use TRANSIT fto display Ports that support a Megaport Internet connection. Use FRANCEIX to display France-IX Ports that you can connect to.
    DiversityZone string
    The diversity zone of the partner port.
    LocationId double
    The unique identifier of the location of the partner port.
    ProductName string
    The name of the partner port.
    CompanyName string
    The name of the company that owns the partner port.
    CompanyUid string
    The unique identifier of the company that owns the partner port.
    ConnectType string
    The type of connection for the partner port. Filters the locations based on the cloud providers, such as AWS (for Hosted VIF), AWSHC (for Hosted Connection), AZURE, GOOGLE, ORACLE, OUTSCALE, and IBM. Use TRANSIT fto display Ports that support a Megaport Internet connection. Use FRANCEIX to display France-IX Ports that you can connect to.
    DiversityZone string
    The diversity zone of the partner port.
    LocationId float64
    The unique identifier of the location of the partner port.
    ProductName string
    The name of the partner port.
    companyName String
    The name of the company that owns the partner port.
    companyUid String
    The unique identifier of the company that owns the partner port.
    connectType String
    The type of connection for the partner port. Filters the locations based on the cloud providers, such as AWS (for Hosted VIF), AWSHC (for Hosted Connection), AZURE, GOOGLE, ORACLE, OUTSCALE, and IBM. Use TRANSIT fto display Ports that support a Megaport Internet connection. Use FRANCEIX to display France-IX Ports that you can connect to.
    diversityZone String
    The diversity zone of the partner port.
    locationId Double
    The unique identifier of the location of the partner port.
    productName String
    The name of the partner port.
    companyName string
    The name of the company that owns the partner port.
    companyUid string
    The unique identifier of the company that owns the partner port.
    connectType string
    The type of connection for the partner port. Filters the locations based on the cloud providers, such as AWS (for Hosted VIF), AWSHC (for Hosted Connection), AZURE, GOOGLE, ORACLE, OUTSCALE, and IBM. Use TRANSIT fto display Ports that support a Megaport Internet connection. Use FRANCEIX to display France-IX Ports that you can connect to.
    diversityZone string
    The diversity zone of the partner port.
    locationId number
    The unique identifier of the location of the partner port.
    productName string
    The name of the partner port.
    company_name str
    The name of the company that owns the partner port.
    company_uid str
    The unique identifier of the company that owns the partner port.
    connect_type str
    The type of connection for the partner port. Filters the locations based on the cloud providers, such as AWS (for Hosted VIF), AWSHC (for Hosted Connection), AZURE, GOOGLE, ORACLE, OUTSCALE, and IBM. Use TRANSIT fto display Ports that support a Megaport Internet connection. Use FRANCEIX to display France-IX Ports that you can connect to.
    diversity_zone str
    The diversity zone of the partner port.
    location_id float
    The unique identifier of the location of the partner port.
    product_name str
    The name of the partner port.
    companyName String
    The name of the company that owns the partner port.
    companyUid String
    The unique identifier of the company that owns the partner port.
    connectType String
    The type of connection for the partner port. Filters the locations based on the cloud providers, such as AWS (for Hosted VIF), AWSHC (for Hosted Connection), AZURE, GOOGLE, ORACLE, OUTSCALE, and IBM. Use TRANSIT fto display Ports that support a Megaport Internet connection. Use FRANCEIX to display France-IX Ports that you can connect to.
    diversityZone String
    The diversity zone of the partner port.
    locationId Number
    The unique identifier of the location of the partner port.
    productName String
    The name of the partner port.

    getPartner Result

    The following output properties are available:

    CompanyName string
    The name of the company that owns the partner port.
    CompanyUid string
    The unique identifier of the company that owns the partner port.
    ConnectType string
    The type of connection for the partner port. Filters the locations based on the cloud providers, such as AWS (for Hosted VIF), AWSHC (for Hosted Connection), AZURE, GOOGLE, ORACLE, OUTSCALE, and IBM. Use TRANSIT fto display Ports that support a Megaport Internet connection. Use FRANCEIX to display France-IX Ports that you can connect to.
    DiversityZone string
    The diversity zone of the partner port.
    Id string
    The provider-assigned unique ID for this managed resource.
    LocationId double
    The unique identifier of the location of the partner port.
    ProductName string
    The name of the partner port.
    ProductUid string
    The unique identifier of the partner port.
    Rank double
    The rank of the partner port.
    Speed double
    The speed of the partner port.
    VxcPermitted bool
    Whether VXCs are permitted on the partner port. If false, you can not create a VXC on this port. If true, you can create a VXC on this port.
    CompanyName string
    The name of the company that owns the partner port.
    CompanyUid string
    The unique identifier of the company that owns the partner port.
    ConnectType string
    The type of connection for the partner port. Filters the locations based on the cloud providers, such as AWS (for Hosted VIF), AWSHC (for Hosted Connection), AZURE, GOOGLE, ORACLE, OUTSCALE, and IBM. Use TRANSIT fto display Ports that support a Megaport Internet connection. Use FRANCEIX to display France-IX Ports that you can connect to.
    DiversityZone string
    The diversity zone of the partner port.
    Id string
    The provider-assigned unique ID for this managed resource.
    LocationId float64
    The unique identifier of the location of the partner port.
    ProductName string
    The name of the partner port.
    ProductUid string
    The unique identifier of the partner port.
    Rank float64
    The rank of the partner port.
    Speed float64
    The speed of the partner port.
    VxcPermitted bool
    Whether VXCs are permitted on the partner port. If false, you can not create a VXC on this port. If true, you can create a VXC on this port.
    companyName String
    The name of the company that owns the partner port.
    companyUid String
    The unique identifier of the company that owns the partner port.
    connectType String
    The type of connection for the partner port. Filters the locations based on the cloud providers, such as AWS (for Hosted VIF), AWSHC (for Hosted Connection), AZURE, GOOGLE, ORACLE, OUTSCALE, and IBM. Use TRANSIT fto display Ports that support a Megaport Internet connection. Use FRANCEIX to display France-IX Ports that you can connect to.
    diversityZone String
    The diversity zone of the partner port.
    id String
    The provider-assigned unique ID for this managed resource.
    locationId Double
    The unique identifier of the location of the partner port.
    productName String
    The name of the partner port.
    productUid String
    The unique identifier of the partner port.
    rank Double
    The rank of the partner port.
    speed Double
    The speed of the partner port.
    vxcPermitted Boolean
    Whether VXCs are permitted on the partner port. If false, you can not create a VXC on this port. If true, you can create a VXC on this port.
    companyName string
    The name of the company that owns the partner port.
    companyUid string
    The unique identifier of the company that owns the partner port.
    connectType string
    The type of connection for the partner port. Filters the locations based on the cloud providers, such as AWS (for Hosted VIF), AWSHC (for Hosted Connection), AZURE, GOOGLE, ORACLE, OUTSCALE, and IBM. Use TRANSIT fto display Ports that support a Megaport Internet connection. Use FRANCEIX to display France-IX Ports that you can connect to.
    diversityZone string
    The diversity zone of the partner port.
    id string
    The provider-assigned unique ID for this managed resource.
    locationId number
    The unique identifier of the location of the partner port.
    productName string
    The name of the partner port.
    productUid string
    The unique identifier of the partner port.
    rank number
    The rank of the partner port.
    speed number
    The speed of the partner port.
    vxcPermitted boolean
    Whether VXCs are permitted on the partner port. If false, you can not create a VXC on this port. If true, you can create a VXC on this port.
    company_name str
    The name of the company that owns the partner port.
    company_uid str
    The unique identifier of the company that owns the partner port.
    connect_type str
    The type of connection for the partner port. Filters the locations based on the cloud providers, such as AWS (for Hosted VIF), AWSHC (for Hosted Connection), AZURE, GOOGLE, ORACLE, OUTSCALE, and IBM. Use TRANSIT fto display Ports that support a Megaport Internet connection. Use FRANCEIX to display France-IX Ports that you can connect to.
    diversity_zone str
    The diversity zone of the partner port.
    id str
    The provider-assigned unique ID for this managed resource.
    location_id float
    The unique identifier of the location of the partner port.
    product_name str
    The name of the partner port.
    product_uid str
    The unique identifier of the partner port.
    rank float
    The rank of the partner port.
    speed float
    The speed of the partner port.
    vxc_permitted bool
    Whether VXCs are permitted on the partner port. If false, you can not create a VXC on this port. If true, you can create a VXC on this port.
    companyName String
    The name of the company that owns the partner port.
    companyUid String
    The unique identifier of the company that owns the partner port.
    connectType String
    The type of connection for the partner port. Filters the locations based on the cloud providers, such as AWS (for Hosted VIF), AWSHC (for Hosted Connection), AZURE, GOOGLE, ORACLE, OUTSCALE, and IBM. Use TRANSIT fto display Ports that support a Megaport Internet connection. Use FRANCEIX to display France-IX Ports that you can connect to.
    diversityZone String
    The diversity zone of the partner port.
    id String
    The provider-assigned unique ID for this managed resource.
    locationId Number
    The unique identifier of the location of the partner port.
    productName String
    The name of the partner port.
    productUid String
    The unique identifier of the partner port.
    rank Number
    The rank of the partner port.
    speed Number
    The speed of the partner port.
    vxcPermitted Boolean
    Whether VXCs are permitted on the partner port. If false, you can not create a VXC on this port. If true, you can create a VXC on this port.

    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