Filter variables in library variable set based on the environment and tenant scoping

chandramouli429 · 31 March 2021 05:08

HI Team,

I wanted to check if we can get the value of a variable from library variable set based on the scoping of environment and tenant through api, i need this to use this as part of creating automation script.

Thanks
Mouli.

paul.calvert · 31 March 2021 07:03

Hi Mouli,

Thanks for getting in touch!

Retrieving a list of variables with specific environment scoping should be possible,
We don’t have a script that performs this precise function, however, this one may serve as a good starting point. It will retrieve all of the variables from a particular variable set. You can then add an additional filter for the environment scope.

github.com

OctopusDeploy/OctopusDeploy-Api/blob/master/REST/PowerShell/Variables/GetVariablesFromVariableSet.ps1

##Config
$OctopusAPIkey = ""#Octopus API Key

$OctopusURL = ""#Octopus URL

$variableSetName = "Whatever" #Name of the variable set

$header = @{ "X-Octopus-ApiKey" = $octopusAPIKey }

##Process
$VariableSet = (Invoke-WebRequest "$OctopusURL/api/libraryvariablesets?contentType=Variables" -Headers $header).content | ConvertFrom-Json | select -ExpandProperty Items | ?{$_.name -eq $variableSetName}

$variables = (Invoke-WebRequest "$OctopusURL/$($VariableSet.Links.Variables)" -Headers $header).content | ConvertFrom-Json | select -ExpandProperty Variables

$variables #<--- Collection of variables of the variable set

You mention tenant scoping too. If this is done using tenant tags then you could add that as a filter to the above script along with the environment.
However, if you’re using variable templates and are wanting to retrieve the values of those templates from specific tenants then you would need additional scripting to query each tenant in turn for those values.

Regards,
Paul

system · 1 May 2021 07:04

This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.