Deployments

  • Published on Apr 16, 2025
  • 2 minute(s) read
Prev Next

Get-LiquitDeployment

Synopsis

This command displays a list of all deployments known within the Recast Software zone, or you can select a deployment in particular.

Syntax

Get-LiquitDeployment 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Get-LiquitDeployment 
    [-ID] <guid[]> 
    [-LiquitContext <LiquitContext>] 
    [<CommonParameters>]

Get-LiquitDeployment 
    [-EntityRef] <EntityRef[]> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]
    
Get-LiquitDeployment
    [-Search] <string> 
    [-LiquitContext <LiquitContext>]
    [<CommonParameters>]

Get-LiquitDeployment
    [-Name] <string> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Examples

Example 1: Get-LiquitDeployment

Get-LiquitDeployment | Select id, name

This command displays a table with all deployments showing the "ID" and "Name" columns.

Example 2: Get-LiquitDeployment

Get-LiquitDeployment -id 00000000-0000-0000-0000-000000000000

This command selects a specific deployment.

Parameters

Name Value Description Required Default value
Search <string> This parameter serves a similar purpose to the search box found in the deployments table from the Application Workspace UI. It enables users to search multiple columns within the table, such as Name and Description. When a search term is provided, the parameter filters records by matching values in these indexed columns. However, it's important to note that not all columns in the table are indexed, meaning that searches for values in these non-indexed columns will not return results. Non-indexed columns include for example the ID and columns containing checkboxes.
Name <string> Searches on the deployment name itself.
LiquitContext <LiquitContext> Determines the selected zone. No Default

New-LiquitDeployment

Synopsis

This command creates a new deployment.

Syntax

New-LiquitDeployment 
	[-Name] <string> 
	[-Description <string>] 
	[-Enabled <bool>] 
	[-LiquitContext <LiquitContext>] 
	[-WhatIf] 
	[-Confirm]  
	[<CommonParameters>]

Example

New-LiquitDeployment -name 'PowerShell Deployment' -Description 'Added with PowerShell' -Enabled $true

This command creates a new deployment with the name "PowerShell Deployment".

Parameters

Name Value Description Required Default value
Name <string> Provide a name for the deployment. Yes
Description <string> Provide a description for the deployment. No
Enabled <bool> Determines whether or not the deployment is enabled. No True
LiquitContext <LiquitContext> Determines the selected zone. No Default

Set-LiquitDeployment

Synopsis

This command lets you edit the properties of a deployment.

Syntax

Set-LiquitDeployment 
	[-Deployment] <Deployment[]> 
	[-Name <string>] 
	[-Description <string>] 
	[-Enabled <bool>] 
	[-LiquitContext <LiquitContext>] 
	[-WhatIf]
	[-Confirm]  
	[<CommonParameters>]

Example

$deployment = Get-LiquitDeployment -id 00000000-0000-0000-0000-000000000000
Set-LiquitDeployment -Deployment $deployment -Name "Updated PowerShell Deployment"

This command updates the name of the deployment to "Updated PowerShell Deployment".

Parameters

Name Value Description Required Default value
Deployment <Deployment> The deployment to be updated. Yes
Name <string> Provide a name for the deployment. No
Description <string> Provide a description for the deployment. No
Enabled <bool> Determines whether or not the deployment is enabled. No True
LiquitContext <LiquitContext> Determines the selected zone. No Default

Remove-LiquitDeployment

Synopsis

This command removes a deployment from the Application Workspace.

Syntax

Remove-LiquitDeployment 
	[-Deployment] <Deployment[]> 
	[-LiquitContext <LiquitContext>] 
	[-WhatIf] 
	[-Confirm]  
	[<CommonParameters>]

Example

$deployment = Get-LiquitDeployment -id 00000000-0000-0000-0000-000000000000
Remove-LiquitDeployment -Deployment $deployment

This command removes the selected deployment from the Application Workspace.

Parameters

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

Copy-LiquitDeployment

Synopsis

This command copies a deployment.

Syntax:

Copy-LiquitDeployment 
    [-Deployment] <Deployment> 
    [-Name] <string> 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters]

Example

$deployment = Get-LiquitDeployment -ID 00000000-0000-0000-0000-000000000000 
Copy-LiquitDeployment -Deployment $deployment -Name PowerShellDeployment

Parameters

Name Value Description Required Default value
Deployment <Deployment> The deployment you want to copy. Yes
Name <string> The name of the new deployment. Yes
LiquitContext <LiquitContext> Determines the selected zone. Yes Default