Set-FilesBehavior
Update Behavior.
Syntax
Id (Default)
InputObject
Description
Update Behavior.
The command accepts behaviors 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.
File parameters take a FilesAttachment: a local file from Get-Item, such as (Get-Item ./logo.png), or one New-FilesAttachment makes from a file, bytes or a stream. The file goes in the same request as the other parameters, whose values are sent exactly as they would be without it; a local file is opened, and a stream read, only when the command goes ahead with the change: never under -WhatIf or when a confirmation is declined. A stream is borrowed: the command leaves it open.
Examples
Example 1: Update Behavior
Writes the behavior as Files.com returns it.
Example 2: Act on behaviors from the pipeline
Takes the behavior 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
Behavior ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-Value
This field stores data specific to the type of behavior. See The Behavior Types section for the accepted value for each type of behavior. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
Id,InputObject
-AttachmentFile
Certain behaviors may require a file, for instance, the watermark behavior requires a watermark image. Attach that file here. Give a FilesAttachment, such as (Get-Item ./file.png) or one from New-FilesAttachment.
- Type:
FilesCom.PowerShell.FilesAttachment - Parameter sets:
Id,InputObject
-DisableParentFolderBehavior
If true, disables the inherited behavior for this folder and its children. Valid only for behavior types that child folders may override, and requires recursive to be true. Rejected for all other behavior types.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-Recursive
Whether the behavior should apply to child folders. This is only configurable for behavior types whose recursion mode is sometimes; always behaviors stay recursive and never behaviors stay non-recursive.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-Name
Name for this behavior.
- Type:
System.String - Parameter sets:
Id,InputObject
-Description
Description for this behavior.
- Type:
System.String - Parameter sets:
Id,InputObject
-AttachmentDelete
If true, delete the file stored in attachment.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-InputObject
The behavior 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.Behavior - 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.Behavior: a behavior from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.Behavior: the behavior 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.