Getting Started
  • 29 Nov 2022
  • 1 Minute to read
  • Dark
    Light
  • PDF

Getting Started

  • Dark
    Light
  • PDF

The latest version of the Liquit Workspace PowerShell module can be found at the following location: https://www.liquit.com/downloads/ or as NuGet package.

To run cmdlets against Liquit Workspace, and perform administration or monitoring tasks, you must establish a connection to your Liquit Workspace environment.
Liquit Workspace connectivity is stored in an Context object, which makes it possible to manage multiple environments within a single script.

Using PowerShell

To use the Liquit commands you can start PowerShell with the shortcut named "Liquit PowerShell" in Start created after installation, or by manually loading the Liquit PowerShell module.

To create a default context object, first run Connect-LiquitWorkspace with the liquit URI and valid credentials. The username should use the following syntax: "Identity source name\username":

$liquitContext = Connect-LiquitWorkspace -URI https://workspace.liquit.com -Credential (Get-Credential)

After establishing a connection, all available cmdlet commands will use this default context. Unless explicitly specified by the LiquitContext parameter on every Liquit cmdlet.


If there are spaces in the identity source name, then Get-Credential will fail as username validation doesn't allow spaces. In this case, you can use the following code to still use spaces within the identity source name:

$username = "Azure AD\username@liquit.com"
$password = Read-Host "Enter Password" -AsSecureString
$credentials = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $username, $password

$liquitContext = Connect-LiquitWorkspace -URI "https://workspace.liquit.com" -Credential $credentials

Was this article helpful?