Set-FilesSnapshot

Update Snapshot.

Syntax

Id (Default)

Set-FilesSnapshot [-Id] <System.Int64> [-ExpiresAt <System.DateTimeOffset>] [-Name <System.String>] [-Paths <System.String[]>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Set-FilesSnapshot [-ExpiresAt <System.DateTimeOffset>] [-Name <System.String>] [-Paths <System.String[]>] -InputObject <FilesCom.PowerShell.Models.Snapshot> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Update Snapshot.

The command accepts snapshots 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 Snapshot

Set-FilesSnapshot -Id 1 -ExpiresAt (Get-Date).AddDays(30) -Name 'My Snapshot'

Writes the snapshot as Files.com returns it.

Example 2: Act on snapshots from the pipeline

Get-FilesSnapshot -Id 1 | Set-FilesSnapshot -ExpiresAt (Get-Date).AddDays(30) -Name 'My Snapshot'

Takes the snapshot from the pipeline and uses its Id and connection.

Example 3: Preview the change

Set-FilesSnapshot -Id 1 -ExpiresAt (Get-Date).AddDays(30) -Name 'My Snapshot' -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Id

Snapshot ID.

  • Type: System.Int64
  • Parameter sets: Id (required, position 0)

-ExpiresAt

When the snapshot expires. Give a DateTime from Get-Date, a DateTimeOffset, or ISO 8601 text with an offset such as 2026-01-31T14:00:00Z.

  • Type: System.DateTimeOffset
  • Parameter sets: Id, InputObject

-Name

A name for the snapshot.

  • Type: System.String
  • Parameter sets: Id, InputObject

-Paths

An array of paths to add to the snapshot.

  • Type: System.String[]
  • Parameter sets: Id, InputObject

-InputObject

The snapshot 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.Snapshot
  • 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 $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

  • FilesCom.PowerShell.Models.Snapshot: a snapshot from another command of the module, as -InputObject.

Outputs

  • FilesCom.PowerShell.Models.Snapshot: the snapshot 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.