1. Packages
  2. Packages
  3. Scaleway
  4. API Docs
  5. interlink
  6. getPartners
Viewing docs for Scaleway v1.48.0
published on Wednesday, Apr 29, 2026 by pulumiverse
scaleway logo
Viewing docs for Scaleway v1.48.0
published on Wednesday, Apr 29, 2026 by pulumiverse

    Gets information about multiple Interlink Partners.

    A partner is an organization that provides shared connections at PoPs. Use this data source to list and filter available partners for creating hosted links.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    // List all partners in a region
    const all = scaleway.interlink.getPartners({
        region: "fr-par",
    });
    // List partners available at specific PoPs
    const atPops = scaleway.interlink.getPartners({
        popIds: [main.id],
    });
    
    import pulumi
    import pulumi_scaleway as scaleway
    
    # List all partners in a region
    all = scaleway.interlink.get_partners(region="fr-par")
    # List partners available at specific PoPs
    at_pops = scaleway.interlink.get_partners(pop_ids=[main["id"]])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/interlink"
    )
    func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
    // List all partners in a region
    _, err := interlink.GetPartners(ctx, &interlink.GetPartnersArgs{
    Region: pulumi.StringRef("fr-par"),
    }, nil);
    if err != nil {
    return err
    }
    // List partners available at specific PoPs
    _, err = interlink.GetPartners(ctx, &interlink.GetPartnersArgs{
    PopIds: interface{}{
    main.Id,
    },
    }, nil);
    if err != nil {
    return err
    }
    return nil
    })
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumiverse.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        // List all partners in a region
        var all = Scaleway.Interlink.GetPartners.Invoke(new()
        {
            Region = "fr-par",
        });
    
        // List partners available at specific PoPs
        var atPops = Scaleway.Interlink.GetPartners.Invoke(new()
        {
            PopIds = new[]
            {
                main.Id,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.interlink.InterlinkFunctions;
    import com.pulumi.scaleway.interlink.inputs.GetPartnersArgs;
    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) {
            // List all partners in a region
            final var all = InterlinkFunctions.getPartners(GetPartnersArgs.builder()
                .region("fr-par")
                .build());
    
            // List partners available at specific PoPs
            final var atPops = InterlinkFunctions.getPartners(GetPartnersArgs.builder()
                .popIds(main.id())
                .build());
    
        }
    }
    
    variables:
      # List all partners in a region
      all:
        fn::invoke:
          function: scaleway:interlink:getPartners
          arguments:
            region: fr-par
      # List partners available at specific PoPs
      atPops:
        fn::invoke:
          function: scaleway:interlink:getPartners
          arguments:
            popIds:
              - ${main.id}
    

    Using getPartners

    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 getPartners(args: GetPartnersArgs, opts?: InvokeOptions): Promise<GetPartnersResult>
    function getPartnersOutput(args: GetPartnersOutputArgs, opts?: InvokeOptions): Output<GetPartnersResult>
    def get_partners(pop_ids: Optional[Sequence[str]] = None,
                     region: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPartnersResult
    def get_partners_output(pop_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     region: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPartnersResult]
    func GetPartners(ctx *Context, args *GetPartnersArgs, opts ...InvokeOption) (*GetPartnersResult, error)
    func GetPartnersOutput(ctx *Context, args *GetPartnersOutputArgs, opts ...InvokeOption) GetPartnersResultOutput

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

    public static class GetPartners 
    {
        public static Task<GetPartnersResult> InvokeAsync(GetPartnersArgs args, InvokeOptions? opts = null)
        public static Output<GetPartnersResult> Invoke(GetPartnersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPartnersResult> getPartners(GetPartnersArgs args, InvokeOptions options)
    public static Output<GetPartnersResult> getPartners(GetPartnersArgs args, InvokeOptions options)
    
    fn::invoke:
      function: scaleway:interlink/getPartners:getPartners
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PopIds List<string>
    Filter for partners present (offering a connection) in one of these PoPs.
    Region string
    region) The region to list partners from.
    PopIds []string
    Filter for partners present (offering a connection) in one of these PoPs.
    Region string
    region) The region to list partners from.
    popIds List<String>
    Filter for partners present (offering a connection) in one of these PoPs.
    region String
    region) The region to list partners from.
    popIds string[]
    Filter for partners present (offering a connection) in one of these PoPs.
    region string
    region) The region to list partners from.
    pop_ids Sequence[str]
    Filter for partners present (offering a connection) in one of these PoPs.
    region str
    region) The region to list partners from.
    popIds List<String>
    Filter for partners present (offering a connection) in one of these PoPs.
    region String
    region) The region to list partners from.

    getPartners Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Partners List<Pulumiverse.Scaleway.Interlink.Outputs.GetPartnersPartner>
    List of partners matching the filters. Each entry contains:
    PopIds List<string>
    Region string
    Id string
    The provider-assigned unique ID for this managed resource.
    Partners []GetPartnersPartner
    List of partners matching the filters. Each entry contains:
    PopIds []string
    Region string
    id String
    The provider-assigned unique ID for this managed resource.
    partners List<GetPartnersPartner>
    List of partners matching the filters. Each entry contains:
    popIds List<String>
    region String
    id string
    The provider-assigned unique ID for this managed resource.
    partners GetPartnersPartner[]
    List of partners matching the filters. Each entry contains:
    popIds string[]
    region string
    id str
    The provider-assigned unique ID for this managed resource.
    partners Sequence[GetPartnersPartner]
    List of partners matching the filters. Each entry contains:
    pop_ids Sequence[str]
    region str
    id String
    The provider-assigned unique ID for this managed resource.
    partners List<Property Map>
    List of partners matching the filters. Each entry contains:
    popIds List<String>
    region String

    Supporting Types

    GetPartnersPartner

    ContactEmail string
    Contact email address.
    CreatedAt string
    Creation date.
    Id string
    ID of the partner.
    LogoUrl string
    URL of the partner's logo.
    Name string
    Name of the partner.
    PortalUrl string
    URL of the partner's portal.
    UpdatedAt string
    Last update date.
    ContactEmail string
    Contact email address.
    CreatedAt string
    Creation date.
    Id string
    ID of the partner.
    LogoUrl string
    URL of the partner's logo.
    Name string
    Name of the partner.
    PortalUrl string
    URL of the partner's portal.
    UpdatedAt string
    Last update date.
    contactEmail String
    Contact email address.
    createdAt String
    Creation date.
    id String
    ID of the partner.
    logoUrl String
    URL of the partner's logo.
    name String
    Name of the partner.
    portalUrl String
    URL of the partner's portal.
    updatedAt String
    Last update date.
    contactEmail string
    Contact email address.
    createdAt string
    Creation date.
    id string
    ID of the partner.
    logoUrl string
    URL of the partner's logo.
    name string
    Name of the partner.
    portalUrl string
    URL of the partner's portal.
    updatedAt string
    Last update date.
    contact_email str
    Contact email address.
    created_at str
    Creation date.
    id str
    ID of the partner.
    logo_url str
    URL of the partner's logo.
    name str
    Name of the partner.
    portal_url str
    URL of the partner's portal.
    updated_at str
    Last update date.
    contactEmail String
    Contact email address.
    createdAt String
    Creation date.
    id String
    ID of the partner.
    logoUrl String
    URL of the partner's logo.
    name String
    Name of the partner.
    portalUrl String
    URL of the partner's portal.
    updatedAt String
    Last update date.

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Viewing docs for Scaleway v1.48.0
    published on Wednesday, Apr 29, 2026 by pulumiverse
      Try Pulumi Cloud free. Your team will thank you.