Snapshots

  • Updated on Sep 12, 2025
  • Published on Apr 16, 2025
  • 3 minute(s) read
Prev Next

Get-LiquitPackageSnapshot

Synopsis

This command displays a list of all the snapshots belonging to an Application Workspace package.

Syntax

 Get-LiquitPackageSnapshot 
	[-Package] <Package> 
	[-LiquitContext <LiquitContext>]  
	[<CommonParameters>]

 Get-LiquitPackageSnapshot 
	[-Package] <Package> 
	[-Type] {Archived | Cancelled | Development | Test | Acceptance | Production}
	[-LiquitContext <LiquitContext>]  
	[<CommonParameters>]

 Get-LiquitPackageSnapshot 
	[-Package] <Package> 
	[-ID] <guid[]> 
	[-LiquitContext <LiquitContext>]  
	[<CommonParameters>]

 Get-LiquitPackageSnapshot 
	[-Package] <Package> 
	[-EntityRef] <EntityRef[]> 
	[-LiquitContext <LiquitContext>]  
	[<CommonParameters>]
    
Get-LiquitPackageSnapshot 
    [-Package] <Package> 
    [-Search] <string> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Get-LiquitPackageSnapshot 
    [-Package] <Package> 
    [-Name] <string> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Examples

The following script lists all available snapshots of a package:

 $package = Get-LiquitPackage -id 00000000-0000-0000-0000-000000000000
 Get-LiquitPackageSnapshot -Package $package

The following script selects only the development snapshot of the package:

 $package = Get-LiquitPackage -id 00000000-0000-0000-0000-000000000000
 Get-LiquitPackageSnapshot -package $package -type 'Development'

The following script selects the snapshot with the id 00000000-0000-0000-0000-000000000000:

 $package = Get-LiquitPackage -id 00000000-0000-0000-0000-000000000000
 Get-LiquitPackageSnapshot -package $package -id 00000000-0000-0000-0000-000000000000

Parameters

Name Value Description Required Default value
Type {Archived | Cancelled | Development | Test | Acceptance | Production} The type of the package snapshot.
Search <string> You can search by the name and description of the snapshots, using a wildcard.
Name <string> Searches on the package snapshot name itself.
LiquitContext <LiquitContext> Determines the selected zone. No Default

New-LiquitPackageSnapshot

Synopsis

This command creates a new snapshot.

Syntax

 New-LiquitPackageSnapshot 
	[-Package] <Package> 
	[-Name <string>] 
	[-Description <string>] 
	[-LiquitContext <LiquitContext>] 
	[-WhatIf]
	[-Confirm]  
	[<CommonParameters>]

Example

The following script creates a new snapshot. Newly created snapshots are always of the development type:

 $package = Get-LiquitPackage -id 00000000-0000-0000-0000-000000000000
 New-LiquitPackageSnapshot -Package $package

Parameters

Name Value Description Required Default value
Package <Package> The package for which you want to create a new snapshot. Yes
Name <string> Provide a name for the snapshot. No
Description <string> Provide a description for the snapshot. No
LiquitContext <LiquitContext> Determines the selected zone. No Default

Set-LiquitPackageSnapshot

Synopsis

This command lets you edit the properties of a snapshot.

Syntax

 Set-LiquitPackageSnapshot 
	[-Snapshot] <PackageSnapshot[]> 
	[-Name <string>] 
	[-Description <string>] 
	[-LiquitContext <LiquitContext>]
	[-WhatIf] 
	[-Confirm]  
	[<CommonParameters>]

Example

The following script renames an existing snapshot as "Updated PowerShell Package Snapshot":

 $package = Get-LiquitPackage -id 00000000-0000-0000-0000-000000000000
 Get-LiquitPackageSnapshot -package $package -id 00000000-0000-0000-0000-000000000000
 Set-LiquitPackageSnapshot -Snapshot $snapshot -name "Updated PowerShell Package Snapshot"

Parameters

Name Value Description Required Default value
Snapshot <PackageSnapshot> The snapshot to be updated. Yes
Name <string> Provide a name for the snapshot. No
Description <string> Provide a description for the snapshot. No
LiquitContext <LiquitContext> Determines the selected zone. No Default

Publish-LiquitPackageSnapshot

Synopsis

Publishes the snapshot in a defined stage, this can be either development, test, acceptance or production.

Syntax

 Publish-LiquitPackageSnapshot 
	[-Snapshot] <PackageSnapshot[]> 
	[[-Stage] {Development | Test | Acceptance | Production}] 
	[-Name <string>] 
	[-Description <string>] 
	[-LiquitContext <LiquitContext>] 
	[-WhatIf] 
	[-Confirm]  
	[<CommonParameters>]

Example

The following script moves the snapshot to the Test stage. If a snapshot was already present in the Test stage, it will be archived as Cancelled:

 $package = Get-LiquitPackage -id 00000000-0000-0000-0000-000000000000
 $snapshot = Get-LiquitPackageSnapshot -package $package -id 00000000-0000-0000-0000-000000000000
 Publish-LiquitPackageSnapshot -Snapshot $snapshot -stage Test

Parameters

Name Value Description Required Default value
Snapshot <PackageSnapshot> The snapshot to be updated. Yes
Stage {Development | Test | Acceptance | Production} The stage to which the snapshot needs to be published. The following options are available:
  • Development
  • Test
  • Acceptance
  • Production
Name <string> Provide a name for the snapshot. No
Description <string> Provide a description for the snapshot. No
LiquitContext <LiquitContext> Determines the selected zone. No Default

Remove-LiquitPackageSnapshot

Synopsis

This command removes a snapshot from the Application Workspace.

Syntax

 Remove-LiquitPackageSnapshot
	[-Snapshot] <PackageSnapshot[]> 
	[-LiquitContext <LiquitContext>] 
	[-WhatIf] 
	[-Confirm]
	[<CommonParameters>]

Example

The following script removes the selected snapshot from the Application Workspace:

 $package = Get-LiquitPackage -id 00000000-0000-0000-0000-000000000000
 $snapshot = Get-LiquitPackageSnapshot -package $package -id 00000000-0000-0000-0000-000000000000
 Remove-LiquitPackage -Snapshot $snapshot

Parameters

Name Value Description Required Default value
Snapshot <Snapshot[]> The snapshot you wish to remove. Yes
LiquitContext <LiquitContext> Determines the selected zone. No Default