Set-FilesPartnerChannel
Update Partner Channel.
Syntax
Id (Default)
InputObject
Description
Update Partner Channel.
The command accepts partner channels from the pipeline as -InputObject, and uses each one's Id and the connection that fetched it.
When given -InputObject, the command updates that object with the values Files.com returns and writes it.
The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.
Examples
Example 1: Update Partner Channel
Writes the partner channel as Files.com returns it.
Example 2: Act on partner channels from the pipeline
Takes the partner channel from the pipeline and uses its Id and connection.
Example 3: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Id
Partner Channel ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-Direction
Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.
- Type:
System.String - Parameter sets:
Id,InputObject
-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:
Id,InputObject
-FromPartnerFolderName
Optional Channel-level from-Partner folder name override.
- Type:
System.String - Parameter sets:
Id,InputObject
-FromPartnerManagedFolderPaths
Managed folder paths inside the from-Partner folder.
- Type:
System.String[] - Parameter sets:
Id,InputObject
-FromPartnerRoutePath
Optional route path for files uploaded by the Partner.
- Type:
System.String - Parameter sets:
Id,InputObject
-ToPartnerFolderName
Optional Channel-level to-Partner folder name override.
- Type:
System.String - Parameter sets:
Id,InputObject
-ToPartnerManagedFolderPaths
Managed folder paths inside the to-Partner folder.
- Type:
System.String[] - Parameter sets:
Id,InputObject
-ToPartnerRoutePath
Optional route path for files delivered to the Partner.
- Type:
System.String - Parameter sets:
Id,InputObject
-Path
Channel path relative to the Partner root folder.
- Type:
System.String - Parameter sets:
Id,InputObject
-InputObject
The partner channel to act on, such as one written by another command of the module, from the pipeline. The command uses its Id and the connection that fetched it.
- Type:
FilesCom.PowerShell.Models.PartnerChannel - Parameter sets:
InputObject(required)
-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
$ConfirmPreferenceofHigh, the command runs without asking;-Confirmmakes 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
FilesCom.PowerShell.Models.PartnerChannel: a partner channel from another command of the module, as-InputObject.
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.