1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
. "${PSScriptRoot}\logging.ps1"
$DevOpsAPIBaseURI = "https://dev.azure.com/{0}/{1}/_apis/{2}/{3}?{4}api-version=6.0"
function Get-Base64EncodedToken([string]$AuthToken)
{
$unencodedAuthToken = "nobody:$AuthToken"
$unencodedAuthTokenBytes = [System.Text.Encoding]::UTF8.GetBytes($unencodedAuthToken)
$encodedAuthToken = [System.Convert]::ToBase64String($unencodedAuthTokenBytes)
if (Test-SupportsDevOpsLogging) {
# Mark the encoded value as a secret so that DevOps will star any references to it that might end up in the logs
Write-Host "##vso[task.setvariable variable=_throwawayencodedaccesstoken;issecret=true;]$($encodedAuthToken)"
}
return $encodedAuthToken
}
# The Base64EncodedToken would be from a PAT that was passed in and the header requires Basic authorization
# The AccessToken would be the querying the Azure resource with the following command:
# az account get-access-token --resource "499b84ac-1321-427f-aa17-267ca6975798" --query "accessToken" --output tsv
# The header for an AccessToken requires Bearer authorization
function Get-DevOpsApiHeaders {
param (
$Base64EncodedToken=$null,
$BearerToken=$null
)
$headers = $null
if (![string]::IsNullOrWhiteSpace($Base64EncodedToken)) {
$headers = @{
Authorization = "Basic $Base64EncodedToken"
}
} elseif (![string]::IsNullOrWhiteSpace($BearerToken)) {
$headers = @{
Authorization = "Bearer $BearerToken"
}
} else {
LogError "Get-DevOpsApiHeaders::Unable to set the Authentication in the header because neither Base64EncodedToken nor BearerToken are set."
exit 1
}
return $headers
}
function Start-DevOpsBuild {
param (
$Organization="azure-sdk",
$Project="internal",
$SourceBranch,
[Parameter(Mandatory = $true)]
$DefinitionId,
$Base64EncodedToken=$null,
$BearerToken=$null,
[Parameter(Mandatory = $false)]
[string]$BuildParametersJson
)
$uri = "$DevOpsAPIBaseURI" -F $Organization, $Project , "build" , "builds", ""
$parameters = @{
sourceBranch = $SourceBranch
definition = @{ id = $DefinitionId }
parameters = $BuildParametersJson
}
$headers = (Get-DevOpsApiHeaders -Base64EncodedToken $Base64EncodedToken -BearerToken $BearerToken)
return Invoke-RestMethod `
-Method POST `
-Body ($parameters | ConvertTo-Json) `
-Uri $uri `
-Headers $headers `
-MaximumRetryCount 3 `
-ContentType "application/json"
}
function Update-DevOpsBuild {
param (
$Organization="azure-sdk",
$Project="internal",
[ValidateNotNullOrEmpty()]
[Parameter(Mandatory = $true)]
$BuildId,
$Status, # pass canceling to cancel build
$Base64EncodedToken=$null,
$BearerToken=$null
)
$uri = "$DevOpsAPIBaseURI" -F $Organization, $Project, "build", "builds/$BuildId", ""
$parameters = @{}
if ($Status) { $parameters["status"] = $Status}
$headers = (Get-DevOpsApiHeaders -Base64EncodedToken $Base64EncodedToken -BearerToken $BearerToken)
return Invoke-RestMethod `
-Method PATCH `
-Body ($parameters | ConvertTo-Json) `
-Uri $uri `
-Headers $headers `
-MaximumRetryCount 3 `
-ContentType "application/json"
}
function Get-DevOpsBuilds {
param (
$Organization="azure-sdk",
$Project="internal",
$BranchName, # Should start with 'refs/heads/'
$Definitions, # Comma seperated string of definition IDs
$StatusFilter, # Comma seperated string 'cancelling, completed, inProgress, notStarted'
$Base64EncodedToken=$null,
$BearerToken=$null
)
$query = ""
if ($BranchName) { $query += "branchName=$BranchName&" }
if ($Definitions) { $query += "definitions=$Definitions&" }
if ($StatusFilter) { $query += "statusFilter=$StatusFilter&" }
$uri = "$DevOpsAPIBaseURI" -F $Organization, $Project , "build" , "builds", $query
$headers = (Get-DevOpsApiHeaders -Base64EncodedToken $Base64EncodedToken -BearerToken $BearerToken)
return Invoke-RestMethod `
-Method GET `
-Uri $uri `
-Headers $headers `
-MaximumRetryCount 3
}
function Delete-RetentionLease {
param (
$Organization,
$Project,
$LeaseId,
$Base64EncodedToken=$null,
$BearerToken=$null
)
$uri = "https://dev.azure.com/$Organization/$Project/_apis/build/retention/leases?ids=$LeaseId&api-version=6.0-preview.1"
$headers = (Get-DevOpsApiHeaders -Base64EncodedToken $Base64EncodedToken -BearerToken $BearerToken)
return Invoke-RestMethod `
-Method DELETE `
-Uri $uri `
-Headers $headers `
-MaximumRetryCount 3
}
function Get-RetentionLeases {
param (
$Organization,
$Project,
$DefinitionId,
$RunId,
$OwnerId,
$Base64EncodedToken=$null,
$BearerToken=$null
)
$uri = "https://dev.azure.com/$Organization/$Project/_apis/build/retention/leases?ownerId=$OwnerId&definitionId=$DefinitionId&runId=$RunId&api-version=6.0-preview.1"
$headers = (Get-DevOpsApiHeaders -Base64EncodedToken $Base64EncodedToken -BearerToken $BearerToken)
return Invoke-RestMethod `
-Method GET `
-Uri $uri `
-Headers $headers `
-MaximumRetryCount 3
}
function Add-RetentionLease {
param (
$Organization,
$Project,
$DefinitionId,
$RunId,
$OwnerId,
$DaysValid,
$Base64EncodedToken=$null,
$BearerToken=$null
)
$parameter = @{}
$parameter["definitionId"] = $DefinitionId
$parameter["runId"] = $RunId
$parameter["ownerId"] = $OwnerId
$parameter["daysValid"] = $DaysValid
$body = $parameter | ConvertTo-Json
$uri = "https://dev.azure.com/$Organization/$Project/_apis/build/retention/leases?api-version=6.0-preview.1"
$headers = (Get-DevOpsApiHeaders -Base64EncodedToken $Base64EncodedToken -BearerToken $BearerToken)
return Invoke-RestMethod `
-Method POST `
-Body "[$body]" `
-Uri $uri `
-Headers $headers `
-MaximumRetryCount 3 `
-ContentType "application/json"
}
|
