Removing Library Variable Sets via API

puk.it.scm · 14 July 2023 17:26

Hi,

we are trying to loop through a set of projects and remove a Library Variable Set, Can you able provide an alternative for below
$project.IncludedLibraryVariableSetIds -= $librarySet.Id

Basically Need an undo script for the below script

github.com

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

$ErrorActionPreference = "Stop";

# Define working variables
$octopusURL = "https://youroctourl"
$octopusAPIKey = "API-YOURAPIKEY"
$header = @{ "X-Octopus-ApiKey" = $octopusAPIKey }
$projectName = "MyProject"
$librarySetName = "MyLibrarySet"

# Get space
$space = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/spaces/all" -Headers $header) | Where-Object {$_.Name -eq $spaceName}

# Get project
$project = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/projects/all" -Headers $header) | Where-Object {$_.Name -eq $projectName}

# Get library set
$librarySet = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/libraryvariablesets/all" -Headers $header) | Where-Object {$_.Name -eq $librarySetName}

# Add the libarary set
$project.IncludedLibraryVariableSetIds += $librarySet.Id

This file has been truncated. show original

britton.riggs · 14 July 2023 22:48

Hi @puk.it.scm,

Thanks for reaching out, and I would be happy to help with your request!

As an initial step, I looked around and could not find an existing script for this in our Octopus API GitHub repository, so I went ahead and wrote a PowerShell script for this, which you can find at the following link:

github.com

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

$ErrorActionPreference = "Stop";

# Define working variables
$octopusURL = "https://your.octopus.app"
$octopusAPIKey = "API-x"
$header = @{ "X-Octopus-ApiKey" = $octopusAPIKey }
$projectName = ""
$spaceName = ""
$librarySetName = ""

# Get space
$space = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/spaces/all" -Headers $header) | Where-Object {$_.Name -eq $spaceName}

# Get project
$project = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/projects/all" -Headers $header) | Where-Object {$_.Name -eq $projectName}

# Get library set
$librarySet = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/libraryvariablesets/all" -Headers $header) | Where-Object {$_.Name -eq $librarySetName}

# New empty array to house modified library variable sets

This file has been truncated. show original

You’ll need to supply the working variables at the top of the script, but once filled out, this script will remove a specific library variable set from a project. Although I’ve done some testing with this script and things worked as expected on my end, I recommend testing this against a sample before running it against production resources.

This script is limited to running against a single project, but you can adjust this to be more encompassing by modifying the filters at the top of the script as needed.

I hope this helps,

Britton

puk.it.scm · 17 July 2023 09:22

Thank you @britton.riggs, Have tested this script in test environment and working fine. Thanks for that again.