New-FilesLock
Create Lock.
Syntax
Description
Create Lock.
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 Lock
Writes the lock returned.
Example 2: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Path
Path
- Type:
System.String - Parameter sets:
(All)(required, position 0)
-Token
Lock token. With expected_token, use the same value to refresh or a different value to replace the existing token. Give a SecureString, such as one from Read-Host -AsSecureString or Get-Secret; text typed on the command line, even inside ConvertTo-SecureString, stays in command history.
- Type:
System.Security.SecureString - Parameter sets:
(All)
-ExpectedToken
Require this existing, unexpired token before refreshing or replacing a lock. Set token to the same value to refresh, or a different value to replace. Give a SecureString, such as one from Read-Host -AsSecureString or Get-Secret; text typed on the command line, even inside ConvertTo-SecureString, stays in command history.
- Type:
System.Security.SecureString - Parameter sets:
(All)
-AllowAccessByAnyUser
Can lock be modified by users other than its creator?
- Type:
System.Boolean - Parameter sets:
(All)
-Exclusive
Is lock exclusive?
- Type:
System.Boolean - Parameter sets:
(All)
-Recursive
Does lock apply to subfolders?
- Type:
System.Boolean - Parameter sets:
(All)
-Owner
Arbitrary descriptive label for the lock. Does not change the lock creator or permissions.
- Type:
System.String - Parameter sets:
(All)
-Timeout
Lock timeout in seconds
- 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
$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
None. The command takes no pipeline input.
Outputs
FilesCom.PowerShell.Models.Lock: the lock 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.