forked from StartAutomating/PSDevOps
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Remove-ADODashboard.ps1
125 lines (109 loc) · 4.76 KB
/
Remove-ADODashboard.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
function Remove-ADODashboard {
<#
.Synopsis
Removes Dashboards and Widgets
.Description
Removes Dashboards from Azure DevOps, or Removes Widgets from a Dashboard in Azure Devops.
.Example
Get-ADODashboard -Organization MyOrg -Project MyProject -Team MyTeam | Remove-ADODashboard
.Example
Get-ADODashboard -Organization MyOrg -Project MyProject -Team MyTeam -Widget | Remove-ADODashboard
.Link
Get-ADODashboard
#>
[CmdletBinding(SupportsShouldProcess,ConfirmImpact='High')]
[OutputType([Nullable],[Hashtable])]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("Test-ForParameterSetAmbiguity", "", Justification="Ambiguity Desired")]
param(
# The Organization.
[Parameter(Mandatory,ValueFromPipelineByPropertyName)]
[Alias('Org')]
[string]
$Organization,
# The Project.
[Parameter(Mandatory,ValueFromPipelineByPropertyName)]
[string]
$Project,
# The Team.
[Parameter(ValueFromPipelineByPropertyName)]
[string]
$Team,
# The DashboardID.
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='dashboard/dashboards/{DashboardId}')]
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='dashboard/dashboards/{DashboardId}/widgets/{WidgetId}')]
[string]
$DashboardID,
# The WidgetID.
[Parameter(Mandatory,ValueFromPipelineByPropertyName,
ParameterSetName='dashboard/dashboards/{DashboardId}/widgets/{WidgetId}')]
[string]
$WidgetID,
# 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-preview.
# 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 {
$ParameterSet = $psCmdlet.ParameterSetName
$q.Enqueue(@{ParameterSet=$ParameterSet} + $PSBoundParameters)
}
end {
$c, $t, $id = 0, $q.Count, [Random]::new().Next()
while ($q.Count) {
. $DQ $q # Pop one off the queue and declare all of it's variables (see /parts/DQ.ps1).
$c++
Write-Progress "Removing $(@($ParameterSet -split '/' -notlike '{*}')[-1])" "$Organization $Project $Team" -Id $id -PercentComplete ($c * 100/$t)
$uri = # The URI is comprised of:
@(
"$server".TrimEnd('/') # the Server (minus any trailing slashes),
$Organization # the Organization,
$Project
if ($Team) { $team }
'_apis' # the API Root ('_apis'),
(. $ReplaceRouteParameter $ParameterSet)
# and any parameterized URLs in this parameter set.
) -as [string[]] -ne '' -join '/'
$uri += '?' # The URI has a query string containing:
$uri += @(
if ($Server -ne 'https://dev.azure.com/' -and
-not $PSBoundParameters.ApiVersion) {
$ApiVersion = '2.0'
}
if ($ApiVersion) { # the api-version
"api-version=$apiVersion"
}
) -join '&'
$invokeParams.Uri = $uri
$invokeParams.Method = 'DELETE'
if ($WidgetID) { # If we're passing a widget to delete, the API will return the dashboard.
$additionalProperty = @{Organization=$Organization;Project=$Project}
if ($Team) { $additionalProperty += @{Team=$team} }
$invokeParams.PSTypeName = "$Organization.Dashboard", "$Organization.$project.Dashboard", 'PSDevOps.Dashboard'
$invokeParams.Property = $additionalProperty
}
if ($WhatIfPreference) {
$invokeParams.Remove('PersonalAccessToken')
$invokeParams
continue
}
if (-not $psCmdlet.ShouldProcess("DELETE $($invokeParams.uri)")) {continue }
Invoke-ADORestAPI @invokeParams
}
Write-Progress "Removing $(@($ParameterSet -split '/' -notlike '{*}')[-1])" "$Organization $Project $Team" -Id $id -Completed
}
}