1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getPartnerChannel
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

    A PartnerChannel defines a structured communication path within a Partner root folder, including directional folder names and partner-scoped routing configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const examplePartnerChannel = filescom.getPartnerChannel({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_partner_channel = filescom.get_partner_channel(id=1)
    
    package main
    
    import (
    	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := filescom.GetPartnerChannel(ctx, &filescom.LookupPartnerChannelArgs{
    			Id: 1,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Filescom = Jschady.Filescom;
    
    return await Deployment.RunAsync(() => 
    {
        var examplePartnerChannel = Filescom.GetPartnerChannel.Invoke(new()
        {
            Id = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.FilescomFunctions;
    import com.pulumi.filescom.inputs.GetPartnerChannelArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 examplePartnerChannel = FilescomFunctions.getPartnerChannel(GetPartnerChannelArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      examplePartnerChannel:
        fn::invoke:
          function: filescom:getPartnerChannel
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getpartnerchannel" "examplePartnerChannel" {
      id = 1
    }
    

    Using getPartnerChannel

    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 getPartnerChannel(args: GetPartnerChannelArgs, opts?: InvokeOptions): Promise<GetPartnerChannelResult>
    function getPartnerChannelOutput(args: GetPartnerChannelOutputArgs, opts?: InvokeOutputOptions): Output<GetPartnerChannelResult>
    def get_partner_channel(id: Optional[int] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPartnerChannelResult
    def get_partner_channel_output(id: pulumi.Input[Optional[int]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetPartnerChannelResult]
    func LookupPartnerChannel(ctx *Context, args *LookupPartnerChannelArgs, opts ...InvokeOption) (*LookupPartnerChannelResult, error)
    func LookupPartnerChannelOutput(ctx *Context, args *LookupPartnerChannelOutputArgs, opts ...InvokeOption) LookupPartnerChannelResultOutput

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

    public static class GetPartnerChannel 
    {
        public static Task<GetPartnerChannelResult> InvokeAsync(GetPartnerChannelArgs args, InvokeOptions? opts = null)
        public static Output<GetPartnerChannelResult> Invoke(GetPartnerChannelInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetPartnerChannelResult> Invoke(GetPartnerChannelInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetPartnerChannelResult> getPartnerChannel(GetPartnerChannelArgs args, InvokeOptions options)
    public static Output<GetPartnerChannelResult> getPartnerChannel(GetPartnerChannelArgs args, InvokeOptions options)
    public static Output<GetPartnerChannelResult> getPartnerChannel(GetPartnerChannelArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getPartnerChannel:getPartnerChannel
      arguments:
        # arguments dictionary
    data "filescom_get_partner_channel" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    The unique ID of the Partner Channel.
    Id int
    The unique ID of the Partner Channel.
    id number
    The unique ID of the Partner Channel.
    id Integer
    The unique ID of the Partner Channel.
    id number
    The unique ID of the Partner Channel.
    id int
    The unique ID of the Partner Channel.
    id Number
    The unique ID of the Partner Channel.

    getPartnerChannel Result

    The following output properties are available:

    ChannelPath string
    Resolved Channel folder path.
    EffectiveFromPartnerFolderName string
    Resolved from-Partner folder name after Channel override and default.
    EffectiveToPartnerFolderName string
    Resolved to-Partner folder name after Channel override and default.
    FromPartnerFolderName string
    Optional Channel-level from-Partner folder name override.
    FromPartnerFolderPath string
    Resolved from-Partner folder path.
    FromPartnerManagedFolderPaths List<string>
    Managed folder paths inside the from-Partner folder.
    FromPartnerRoutePath string
    Optional route path for files uploaded by the Partner.
    Id int
    The unique ID of the Partner Channel.
    PartnerChannelTemplateId int
    ID of the Partner Channel Template that manages this Channel, if any.
    PartnerId int
    ID of the Partner this Channel belongs to.
    Path string
    Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    ToPartnerFolderName string
    Optional Channel-level to-Partner folder name override.
    ToPartnerFolderPath string
    Resolved to-Partner folder path.
    ToPartnerManagedFolderPaths List<string>
    Managed folder paths inside the to-Partner folder.
    ToPartnerRoutePath string
    Optional route path for files delivered to the Partner.
    WorkspaceId int
    ID of the Workspace associated with this Partner Channel.
    ChannelPath string
    Resolved Channel folder path.
    EffectiveFromPartnerFolderName string
    Resolved from-Partner folder name after Channel override and default.
    EffectiveToPartnerFolderName string
    Resolved to-Partner folder name after Channel override and default.
    FromPartnerFolderName string
    Optional Channel-level from-Partner folder name override.
    FromPartnerFolderPath string
    Resolved from-Partner folder path.
    FromPartnerManagedFolderPaths []string
    Managed folder paths inside the from-Partner folder.
    FromPartnerRoutePath string
    Optional route path for files uploaded by the Partner.
    Id int
    The unique ID of the Partner Channel.
    PartnerChannelTemplateId int
    ID of the Partner Channel Template that manages this Channel, if any.
    PartnerId int
    ID of the Partner this Channel belongs to.
    Path string
    Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    ToPartnerFolderName string
    Optional Channel-level to-Partner folder name override.
    ToPartnerFolderPath string
    Resolved to-Partner folder path.
    ToPartnerManagedFolderPaths []string
    Managed folder paths inside the to-Partner folder.
    ToPartnerRoutePath string
    Optional route path for files delivered to the Partner.
    WorkspaceId int
    ID of the Workspace associated with this Partner Channel.
    channel_path string
    Resolved Channel folder path.
    effective_from_partner_folder_name string
    Resolved from-Partner folder name after Channel override and default.
    effective_to_partner_folder_name string
    Resolved to-Partner folder name after Channel override and default.
    from_partner_folder_name string
    Optional Channel-level from-Partner folder name override.
    from_partner_folder_path string
    Resolved from-Partner folder path.
    from_partner_managed_folder_paths list(string)
    Managed folder paths inside the from-Partner folder.
    from_partner_route_path string
    Optional route path for files uploaded by the Partner.
    id number
    The unique ID of the Partner Channel.
    partner_channel_template_id number
    ID of the Partner Channel Template that manages this Channel, if any.
    partner_id number
    ID of the Partner this Channel belongs to.
    path string
    Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    to_partner_folder_name string
    Optional Channel-level to-Partner folder name override.
    to_partner_folder_path string
    Resolved to-Partner folder path.
    to_partner_managed_folder_paths list(string)
    Managed folder paths inside the to-Partner folder.
    to_partner_route_path string
    Optional route path for files delivered to the Partner.
    workspace_id number
    ID of the Workspace associated with this Partner Channel.
    channelPath String
    Resolved Channel folder path.
    effectiveFromPartnerFolderName String
    Resolved from-Partner folder name after Channel override and default.
    effectiveToPartnerFolderName String
    Resolved to-Partner folder name after Channel override and default.
    fromPartnerFolderName String
    Optional Channel-level from-Partner folder name override.
    fromPartnerFolderPath String
    Resolved from-Partner folder path.
    fromPartnerManagedFolderPaths List<String>
    Managed folder paths inside the from-Partner folder.
    fromPartnerRoutePath String
    Optional route path for files uploaded by the Partner.
    id Integer
    The unique ID of the Partner Channel.
    partnerChannelTemplateId Integer
    ID of the Partner Channel Template that manages this Channel, if any.
    partnerId Integer
    ID of the Partner this Channel belongs to.
    path String
    Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    toPartnerFolderName String
    Optional Channel-level to-Partner folder name override.
    toPartnerFolderPath String
    Resolved to-Partner folder path.
    toPartnerManagedFolderPaths List<String>
    Managed folder paths inside the to-Partner folder.
    toPartnerRoutePath String
    Optional route path for files delivered to the Partner.
    workspaceId Integer
    ID of the Workspace associated with this Partner Channel.
    channelPath string
    Resolved Channel folder path.
    effectiveFromPartnerFolderName string
    Resolved from-Partner folder name after Channel override and default.
    effectiveToPartnerFolderName string
    Resolved to-Partner folder name after Channel override and default.
    fromPartnerFolderName string
    Optional Channel-level from-Partner folder name override.
    fromPartnerFolderPath string
    Resolved from-Partner folder path.
    fromPartnerManagedFolderPaths string[]
    Managed folder paths inside the from-Partner folder.
    fromPartnerRoutePath string
    Optional route path for files uploaded by the Partner.
    id number
    The unique ID of the Partner Channel.
    partnerChannelTemplateId number
    ID of the Partner Channel Template that manages this Channel, if any.
    partnerId number
    ID of the Partner this Channel belongs to.
    path string
    Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    toPartnerFolderName string
    Optional Channel-level to-Partner folder name override.
    toPartnerFolderPath string
    Resolved to-Partner folder path.
    toPartnerManagedFolderPaths string[]
    Managed folder paths inside the to-Partner folder.
    toPartnerRoutePath string
    Optional route path for files delivered to the Partner.
    workspaceId number
    ID of the Workspace associated with this Partner Channel.
    channel_path str
    Resolved Channel folder path.
    effective_from_partner_folder_name str
    Resolved from-Partner folder name after Channel override and default.
    effective_to_partner_folder_name str
    Resolved to-Partner folder name after Channel override and default.
    from_partner_folder_name str
    Optional Channel-level from-Partner folder name override.
    from_partner_folder_path str
    Resolved from-Partner folder path.
    from_partner_managed_folder_paths Sequence[str]
    Managed folder paths inside the from-Partner folder.
    from_partner_route_path str
    Optional route path for files uploaded by the Partner.
    id int
    The unique ID of the Partner Channel.
    partner_channel_template_id int
    ID of the Partner Channel Template that manages this Channel, if any.
    partner_id int
    ID of the Partner this Channel belongs to.
    path str
    Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    to_partner_folder_name str
    Optional Channel-level to-Partner folder name override.
    to_partner_folder_path str
    Resolved to-Partner folder path.
    to_partner_managed_folder_paths Sequence[str]
    Managed folder paths inside the to-Partner folder.
    to_partner_route_path str
    Optional route path for files delivered to the Partner.
    workspace_id int
    ID of the Workspace associated with this Partner Channel.
    channelPath String
    Resolved Channel folder path.
    effectiveFromPartnerFolderName String
    Resolved from-Partner folder name after Channel override and default.
    effectiveToPartnerFolderName String
    Resolved to-Partner folder name after Channel override and default.
    fromPartnerFolderName String
    Optional Channel-level from-Partner folder name override.
    fromPartnerFolderPath String
    Resolved from-Partner folder path.
    fromPartnerManagedFolderPaths List<String>
    Managed folder paths inside the from-Partner folder.
    fromPartnerRoutePath String
    Optional route path for files uploaded by the Partner.
    id Number
    The unique ID of the Partner Channel.
    partnerChannelTemplateId Number
    ID of the Partner Channel Template that manages this Channel, if any.
    partnerId Number
    ID of the Partner this Channel belongs to.
    path String
    Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    toPartnerFolderName String
    Optional Channel-level to-Partner folder name override.
    toPartnerFolderPath String
    Resolved to-Partner folder path.
    toPartnerManagedFolderPaths List<String>
    Managed folder paths inside the to-Partner folder.
    toPartnerRoutePath String
    Optional route path for files delivered to the Partner.
    workspaceId Number
    ID of the Workspace associated with this Partner Channel.

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial