forked from StartAutomating/PSDevOps
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Get-ADOWorkItemType.ps1
237 lines (208 loc) · 9.51 KB
/
Get-ADOWorkItemType.ps1
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
function Get-ADOWorkItemType
{
<#
.Synopsis
Gets work item types
.Description
Gets work item types from Azure DevOps
.Example
Get-ADOWorkProcess -Organization StartAutomating -Project PSDevOps |
Get-ADOWorkItemType
.Example
Get-ADOWorkItemType -Organization StartAutomating -Icon
.Example
Get-ADOWorkItemType -Organization StartAutomating -Project PSDevOps
.Link
Get-ADOWorkProcess
#>
[OutputType('PSDevOps.WorkItemType',
'PSDevOps.State',
'PSDevOps.Rule',
'PSDevOps.Behavior',
'PSDevOps.Layout',
'PSDevOps.ProcessField')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("Test-ForParameterSetAmbiguity", "", Justification="Ambiguity Desired")]
param(
# The Organization.
[Parameter(Mandatory,ValueFromPipelineByPropertyName)]
[Alias('Org')]
[string]
$Organization,
# The ProcessID. This is returned from Get-ADOWorkProcess.
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes')]
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}')]
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/layout')]
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/states')]
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/rules')]
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/fields')]
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypesbehaviors/{ReferenceName}/behaviors')]
[Alias('TypeID')]
[string]
$ProcessID,
# The Reference Name of the Work Item Type. This can be provided by piping Get-ADOWorkItemType to itself.
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}')]
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/layout')]
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/states')]
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/rules')]
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/fields')]
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypesbehaviors/{ReferenceName}/behaviors')]
[string]
$ReferenceName,
# If set, will get the layout associated with a given work item type.
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/layout')]
[switch]
$Layout,
# If set, will get the pages within a given work item type layout.
[Parameter(ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/layout')]
[Alias('Pages')]
[switch]
$Page,
# If set, will get the states associated with a given work item type.
[Parameter(Mandatory,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/states')]
[Alias('States')]
[switch]
$State,
# If set, will get the rules associated with a given work item type.
[Parameter(Mandatory,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/rules')]
[Alias('Rules')]
[switch]
$Rule,
# If set, will get the behaviors associated with a given work item type.
[Parameter(Mandatory,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypesbehaviors/{ReferenceName}/behaviors')]
[Alias('Behaviors')]
[switch]
$Behavior,
# If set, will get the fields associated with a given work item type.
[Parameter(Mandatory,
ParameterSetName='/{organization}/_apis/work/processes/{processId}/workitemtypes/{ReferenceName}/fields')]
[Alias('Fields')]
[switch]
$Field,
# The name of the project. If provided, will get work item type information related to the project.
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='/{organization}/{Project}/_apis/wit/workitemtypes')]
[string]
$Project,
# If set, will get work item icons available to the organization.
[Parameter(Mandatory,
ParameterSetName='/{Organization}/_apis/wit/workitemicons')]
[Alias('Icons')]
[switch]
$Icon,
# The server. By default https://dev.azure.com/.
# To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs).
[Parameter(ValueFromPipelineByPropertyName)]
[uri]
$Server = "https://dev.azure.com/",
# The api version. By default, 5.1.
# If targeting TFS, this will need to change to match your server version.
# See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops
[string]
$ApiVersion = "5.1-preview")
dynamicParam { . $GetInvokeParameters -DynamicParameter }
begin {
#region Copy Invoke-ADORestAPI parameters
$invokeParams = . $getInvokeParameters $PSBoundParameters
#endregion Copy Invoke-ADORestAPI parameters
$q = [Collections.Queue]::new()
}
process {
$in = $_
$psParameterSet = $PSCmdlet.ParameterSetName
if ($in.TypeID -and $ReferenceName) { # If we're piping in a work process, clear reference name
$psBoundParameters['ReferenceName'] = $ReferenceName = ''
$psParameterSet = $MyInvocation.MyCommand.Parameters['ProcessID'].ParameterSets.Keys |
Sort-Object Length |
Select-Object -First 1
}
$q.Enqueue(@{psParameterSet = $psParameterSet}+ $psBoundParameters)
}
end {
$c, $t, $progId = 0, $q.Count, [Random]::new().Next()
while ($q.Count) {
. $dq $q
$uri =
"$Server".TrimEnd('/') +
(. $ReplaceRouteParameter $psParameterSet) +
'?'
if ($Server -ne 'https://dev.azure.com/' -and
-not $psBoundParameters['apiVersion']) {
$ApiVersion = '2.0'
}
if ($Field) {
$ApiVersion = '6.0-preview.2'
}
$uri +=
@(
if ($ApiVersion) {
"api-version=$ApiVersion"
}
) -join '&'
$typeName = @($psParameterSet -split '/' -notlike '{*}')[-1].ToString().TrimEnd('s') -replace
'Field','WorkProcess.Field'
$typeNames = @(
"$Organization.$typename"
if ($Project) { "$Organization.$Project.$typeName" }
"PSDevOps.$typeName"
)
if ($t -gt 1) {
$c++
Write-Progress "Getting $typeName" "[$c / $t] $uri" -PercentComplete ($c* 100 /$t) -Id $progId
}
$AddProperty = @{Organization=$Organization}
if ($ProcessID) {
$AddProperty['ProcessID'] = $ProcessID
}
if ($ReferenceName) {
$AddProperty['ReferenceName'] = $ReferenceName
}
if ($Project) {
$AddProperty['Project'] = $Project
}
if ($Page) {
$invokeParams.ExpandProperty = 'pages'
}
$restResponse = Invoke-ADORestAPI @invokeParams -uri $uri -PSTypeName $typeNames -Property $AddProperty
if ($restResponse -is [string]) {
$restResponse =
$restResponse -replace '"":', '"_blank":' |
ConvertFrom-Json |
Select-Object -ExpandProperty Value |
& { process {
$in = $_
$in.pstypenames.clear()
foreach ($tn in $typeNames) {
$in.pstypenames.add($tn)
}
foreach ($ap in $AddProperty.GetEnumerator()) {
$in | Add-Member NoteProperty $ap.Key $ap.Value -Force
}
$in
} }
}
$restResponse
}
if ($t -gt 1) {
$c++
Write-Progress "Getting $typeName" "[$c / $t]" -Completed -Id $progId
}
}
}