Error while updating VSTS release definition from powershell

Question

I use the APIs listed in the VSTS API documentation here. On modifying a variable and saving the definition the error I get from the server is VS402982: Retention policy is not set for the environment 'environmentName'.

The portion of the PS script that performs the update is -

$c = Invoke-WebRequest 'https://accountname.vsrm.visualstudio.com/projectname/_apis/release/definitions/definitionId' -Method Get -Headers @{Authorization = 'Bearer ' + $authtoken} 
$jsonObj = $c | ConvertFrom-Json
$url3 = "https://accountname.vsrm.visualstudio.com/projectname/_apis/release/definitions/definitionId?api-version=4.1-preview.3";

$contentType3 = "application/json"      
$headers3 = @{
    Authorization = 'Bearer ' + $authtoken
};

$d = $jsonObj | ConvertTo-Json;
Invoke-RestMethod -Method PUT -Uri $url3 -ContentType $contentType3 -Headers $headers3 -Body $d;

What could be wrong here?

divyanshm · Accepted Answer · 2018-06-29 05:12:24Z

This problem has been reported a couple of times in different forms, and is mostly related to a small problem with the powershell code in the question.

If you see error like the one mentioned in the question or this - VS402903: The specified value is not convertible to type ReleaseDefinition. Make sure it is convertible to type ReleaseDefinition and try again it means that there is a problem in the JSON object that you are posting to the server. Easiest problem will be to capture the request payload and analyse it for issues.

However, in the code mentioned in the question, the problem lies with powershell's ConvertTo-JSON method. Do note, the release definition has multiple layers of nested objects, definition -> environment -> steps/approvals etc, and ConvertTo-JSON by default goes only 2 levels deep to form a JSON object, which means you are missing some vital properties while calling the VSTS APIs. The fix would be to specify a large value for the -Depth parameter so that you do not miss any properties while calling the service.

eg. ConvertTo-Json -Depth 100

More details on the problem and how it's fixed in the script can be seen here.

Sven · Accepted Answer · 2021-05-18 09:37:33Z

0

Additionally to divyanshm's solution make sure encoding is correct:

$d = [Text.Encoding]::UTF8.GetBytes($d)

answered May 18, 2021 at 9:37

Sven

11.9k2 gold badges22 silver badges21 bronze badges

Collectives™ on Stack Overflow

Error while updating VSTS release definition from powershell

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related