-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathRemove-AzDoExtension.ps1
More file actions
70 lines (57 loc) · 2.62 KB
/
Remove-AzDoExtension.ps1
File metadata and controls
70 lines (57 loc) · 2.62 KB
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
function Remove-AzDoExtension {
<#
.SYNOPSIS
Removes an Azure DevOps extension from an organization.
.DESCRIPTION
The `Remove-AzDoExtension` cmdlet removes an Azure DevOps extension from a specified organization.
It uses the Azure DevOps REST API to perform the deletion.
.PARAMETER CollectionUri
Specifies the URI of the Azure DevOps organization. This parameter is mandatory and accepts a string.
.PARAMETER ExtensionId
Specifies the ID of the extension to be removed. This parameter is mandatory and accepts a string.
.PARAMETER ExtensionPublisherId
Specifies the publisher ID of the extension to be removed. This parameter is mandatory and accepts a string.
.EXAMPLE
PS> Remove-AzDoExtension -CollectionUri "https://dev.azure.com/yourorganization" -ExtensionId "yourExtensionId" -ExtensionPublisherId "yourPublisherId"
This command removes the specified extension from the specified Azure DevOps organization.
.NOTES
For more information on the Azure DevOps REST API, see:
https://learn.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed-extensions/get?view=azure-devops-rest-7.1&tabs=HTTP
#>
[CmdletBinding(SupportsShouldProcess)]
param (
# Collection Uri of the organization
[Parameter(Mandatory, ValueFromPipelineByPropertyName)]
[ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
[string]
$CollectionUri,
# Name(s) of the extension(s) to look for
[Parameter(Mandatory, ValueFromPipelineByPropertyName, ValueFromPipeline)]
[string]
$ExtensionId,
# Id(s) of the extension(s) to look for
[Parameter(Mandatory, ValueFromPipelineByPropertyName, ValueFromPipeline)]
[string]
$ExtensionPublisherId
)
begin {
Write-Verbose "Starting function: Remove-AzDoExtension"
}
process {
# For extensions a different base URI is used: https://learn.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed-extensions/get?view=azure-devops-rest-7.1&tabs=HTTP
$extensionCollectionUri = $CollectionUri -replace "//dev", "//extmgmt.dev"
$params = @{
uri = "$extensionCollectionUri/_apis/extensionmanagement/installedextensionsbyname/$ExtensionPublisherId/$ExtensionId"
version = "7.1-preview.1"
method = "DELETE"
}
if ($PSCmdlet.ShouldProcess($CollectionUri, "Remove $ExtensionId from organization $CollectionUri")) {
$result = (Invoke-AzDoRestMethod @params).value
} else {
Write-Verbose "Calling Invoke-AzDoRestMethod with $($params| ConvertTo-Json -Depth 10)"
}
}
end {
$result
}
}