New-FilesPartnerChannel

Create Partner Channel.

Syntax

New-FilesPartnerChannel [-Direction <System.String>] [-UseChannelRoot <System.Boolean>] [-FromPartnerFolderName <System.String>] [-FromPartnerManagedFolderPaths <System.String[]>] [-FromPartnerRoutePath <System.String>] [-ToPartnerFolderName <System.String>] [-ToPartnerManagedFolderPaths <System.String[]>] [-ToPartnerRoutePath <System.String>] -PartnerId <System.Int64> -Path <System.String> [-WorkspaceId <System.Int64>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Create Partner Channel.

The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.

Examples

Example 1: Create Partner Channel

New-FilesPartnerChannel -PartnerId 1 -Path 'claims/medical' -Direction 'two_way' -FromPartnerFolderName 'incoming'

Writes the partner channel returned.

Example 2: Preview the change

New-FilesPartnerChannel -PartnerId 1 -Path 'claims/medical' -Direction 'two_way' -FromPartnerFolderName 'incoming' -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Direction

Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.

  • Type: System.String
  • Parameter sets: (All)

-UseChannelRoot

Use the Channel folder directly for a one-way exchange. Defaults to false. Cannot be changed after creation. Folder name overrides must be blank when enabled, and the Channel must remain one-way.

  • Type: System.Boolean
  • Parameter sets: (All)

-FromPartnerFolderName

Optional Channel-level from-Partner folder name override.

  • Type: System.String
  • Parameter sets: (All)

-FromPartnerManagedFolderPaths

Managed folder paths inside the from-Partner folder.

  • Type: System.String[]
  • Parameter sets: (All)

-FromPartnerRoutePath

Optional route path for files uploaded by the Partner.

  • Type: System.String
  • Parameter sets: (All)

-ToPartnerFolderName

Optional Channel-level to-Partner folder name override.

  • Type: System.String
  • Parameter sets: (All)

-ToPartnerManagedFolderPaths

Managed folder paths inside the to-Partner folder.

  • Type: System.String[]
  • Parameter sets: (All)

-ToPartnerRoutePath

Optional route path for files delivered to the Partner.

  • Type: System.String
  • Parameter sets: (All)

-PartnerId

ID of the Partner this Channel belongs to.

  • Type: System.Int64
  • Parameter sets: (All) (required)

-Path

Channel path relative to the Partner root folder.

  • Type: System.String
  • Parameter sets: (All) (required)

-WorkspaceId

ID of the Workspace associated with this Partner Channel.

  • Type: System.Int64
  • Parameter sets: (All)

-Connection

The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.

  • Type: FilesCom.PowerShell.FilesConnection
  • Parameter sets: (All)

-WorkspaceScope

Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.

  • Type: System.Int64
  • Parameter sets: (All)

-NoWorkspaceScope

Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.

  • Type: System.Management.Automation.SwitchParameter
  • Parameter sets: (All)

-Confirm

Prompts you for confirmation before running the cmdlet.

  • Type: System.Management.Automation.SwitchParameter
  • Confirm impact: Medium. At the default $ConfirmPreference of High, the command runs without asking; -Confirm makes it ask before each change.

-WhatIf

Shows what the cmdlet would change without sending anything to Files.com.

  • Type: System.Management.Automation.SwitchParameter

Common Parameters

This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.

Inputs

None. The command takes no pipeline input.

Outputs

  • FilesCom.PowerShell.Models.PartnerChannel: the partner channel as Files.com returned it.

Notes

Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.