-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
mdejulia
authored and
mdejulia
committed
Aug 17, 2020
1 parent
3f764f5
commit 759bdb5
Showing
6 changed files
with
783 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,181 @@ | ||
function Get-APPermissionReport | ||
{ | ||
<# | ||
.SYNOPSIS | ||
Returns a an Azure Pipeline permission report. | ||
.DESCRIPTION | ||
Returns a an Azure Pipeline permission report based on report id. | ||
The report id can be returned by Get-APPermissionReportList. | ||
.PARAMETER Instance | ||
The Team Services account or TFS server. | ||
.PARAMETER Collection | ||
For Azure DevOps the value for collection should be the name of your orginization. | ||
For both Team Services and TFS The value should be DefaultCollection unless another collection has been created. | ||
.PARAMETER ApiVersion | ||
Version of the api to use. | ||
.PARAMETER PersonalAccessToken | ||
Personal access token used to authenticate that has been converted to a secure string. | ||
It is recomended to uses an Azure Pipelines PS session to pass the personal access token parameter among funcitons, See New-APSession. | ||
https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=vsts | ||
.PARAMETER Credential | ||
Specifies a user account that has permission to send the request. | ||
.PARAMETER Proxy | ||
Use a proxy server for the request, rather than connecting directly to the Internet resource. Enter the URI of a network proxy server. | ||
.PARAMETER ProxyCredential | ||
Specifie a user account that has permission to use the proxy server that is specified by the -Proxy parameter. The default is the current user. | ||
.PARAMETER Session | ||
Azure DevOps PS session, created by New-APSession. | ||
.PARAMETER ReportId | ||
Id (guid) of the report to get. | ||
.INPUTS | ||
None, does not support pipeline. | ||
.OUTPUTS | ||
PSObject, Azure Pipelines permission report(s) | ||
.EXAMPLE | ||
Returns AP permission report for 'myCollection' with the id of '7'. | ||
Get-APPermissionReportList -Instance 'https://dev.azure.com' -Collection 'myCollection' -ReportId '7' | ||
.LINK | ||
https://docs.microsoft.com/en-us/rest/api/azure/devops/permissionsreport/permissions%20report/get?view=azure-devops-rest-6.0&viewFallbackFrom=azure-devops-rest-6.1 | ||
#> | ||
[CmdletBinding(DefaultParameterSetName = 'ByPersonalAccessToken')] | ||
Param | ||
( | ||
[Parameter(Mandatory, | ||
ParameterSetName = 'ByPersonalAccessToken')] | ||
[Parameter(Mandatory, | ||
ParameterSetName = 'ByCredential')] | ||
[uri] | ||
$Instance, | ||
|
||
[Parameter(Mandatory, | ||
ParameterSetName = 'ByPersonalAccessToken')] | ||
[Parameter(Mandatory, | ||
ParameterSetName = 'ByCredential')] | ||
[string] | ||
$Collection, | ||
|
||
[Parameter(Mandatory, | ||
ParameterSetName = 'ByPersonalAccessToken')] | ||
[Parameter(Mandatory, | ||
ParameterSetName = 'ByCredential')] | ||
[string] | ||
$ApiVersion, | ||
|
||
[Parameter(ParameterSetName = 'ByPersonalAccessToken')] | ||
[Security.SecureString] | ||
$PersonalAccessToken, | ||
|
||
[Parameter(ParameterSetName = 'ByCredential')] | ||
[pscredential] | ||
$Credential, | ||
|
||
[Parameter(ParameterSetName = 'ByPersonalAccessToken')] | ||
[Parameter(ParameterSetName = 'ByCredential')] | ||
[string] | ||
$Proxy, | ||
|
||
[Parameter(ParameterSetName = 'ByPersonalAccessToken')] | ||
[Parameter(ParameterSetName = 'ByCredential')] | ||
[pscredential] | ||
$ProxyCredential, | ||
|
||
[Parameter(Mandatory, | ||
ParameterSetName = 'BySession')] | ||
[object] | ||
$Session, | ||
|
||
[Parameter(Mandatory)] | ||
[string] | ||
$ReportId | ||
) | ||
|
||
begin | ||
{ | ||
If ($PSCmdlet.ParameterSetName -eq 'BySession') | ||
{ | ||
$currentSession = $Session | Get-APSession | ||
If ($currentSession) | ||
{ | ||
$Instance = $currentSession.Instance | ||
$Collection = $currentSession.Collection | ||
$PersonalAccessToken = $currentSession.PersonalAccessToken | ||
$Credential = $currentSession.Credential | ||
$Proxy = $currentSession.Proxy | ||
$ProxyCredential = $currentSession.ProxyCredential | ||
If ($currentSession.Version) | ||
{ | ||
$ApiVersion = (Get-APApiVersion -Version $currentSession.Version) | ||
} | ||
else | ||
{ | ||
$ApiVersion = $currentSession.ApiVersion | ||
} | ||
} | ||
} | ||
} | ||
|
||
process | ||
{ | ||
$apiEndpoint = (Get-APApiEndpoint -ApiType 'permissions-reportId') -f $ReportId | ||
$queryParameters = Set-APQueryParameters -InputObject $PSBoundParameters | ||
$setAPUriSplat = @{ | ||
Collection = $Collection | ||
Instance = $Instance | ||
ApiVersion = $ApiVersion | ||
ApiEndpoint = $apiEndpoint | ||
Query = $queryParameters | ||
} | ||
[uri] $uri = Set-APUri @setAPUriSplat | ||
$invokeAPRestMethodSplat = @{ | ||
Method = 'GET' | ||
Uri = $uri | ||
Credential = $Credential | ||
PersonalAccessToken = $PersonalAccessToken | ||
Proxy = $Proxy | ||
ProxyCredential = $ProxyCredential | ||
} | ||
$results = Invoke-APRestMethod @invokeAPRestMethodSplat | ||
If ($results.value) | ||
{ | ||
return $results.value | ||
} | ||
else | ||
{ | ||
return $results | ||
} | ||
} | ||
|
||
end | ||
{ | ||
} | ||
} |
Oops, something went wrong.