Functions/DevOps.Pipelines.Settings.ps1
|
<# .SYNOPSIS Get the projects's pipelines settings from Azure DevOps .DESCRIPTION Get the projects's pipelines settings from Azure DevOps .PARAMETER PAT Personal Access Token (PAT) for Azure DevOps .PARAMETER Organization Organization name for Azure DevOps .PARAMETER ProjectId Project ID for Azure DevOps .EXAMPLE Get-AzDevOpsPipelinesSettings -PAT $PAT -Organization $Organization -ProjectId $ProjectId #> Function Get-AzDevOpsPipelinesSettings { [CmdletBinding()] param ( [Parameter()] [string] $PAT, [Parameter()] [string] $Organization, [Parameter()] [string] $Project ) $header = Get-AzDevOpsHeader -PAT $PAT $uri = "https://dev.azure.com/$Organization/_apis/Contribution/HierarchyQuery?api-version=5.0-preview.1" Write-Verbose "URI: $uri" $postObject = @{ contributionIds = @('ms.vss-build-web.pipelines-general-settings-data-provider') dataProviderContext = @{ properties = @{ sourcePage = @{ routeId = "ms.vss-admin-web.project-admin-hub-route" url = "https://dev.azure.com/$Organization/$Project/_settings/settings" routeValues = @{ project = $Project action = "Execute" adminPivot = "settings" controller = "ContributedPage" } } } } } try { $pipelinesSettings = Invoke-RestMethod -Uri $uri -Method Post -Headers $header -Body ($postObject | ConvertTo-Json -Depth 100) -ContentType 'application/json' # if the response is not an object but a string, the authentication failed or the pipeline was not found if ($pipelinesSettings -is [string]) { throw "Authentication failed or pipeline not found" } } catch { throw $_.Exception.Message } return $pipelinesSettings.dataProviders.'ms.vss-build-web.pipelines-general-settings-data-provider' } Export-ModuleMember -Function Get-AzDevOpsPipelinesSettings # End of Function Get-AzDevOpsPipelinesSettings <# .SYNOPSIS Export the projects's pipelines settings from Azure DevOps to a JSON file .DESCRIPTION Export the projects's pipelines settings from Azure DevOps to a JSON file with .ado.pls.json extension .PARAMETER PAT Personal Access Token (PAT) for Azure DevOps .PARAMETER Organization Organization name for Azure DevOps .PARAMETER Project Project name for Azure DevOps .PARAMETER OutputPath Output path for JSON files .EXAMPLE Export-AzDevOpsPipelinesSettings -PAT $PAT -Organization $Organization -Project $Project -OutputPath $OutputPath #> function Export-AzDevOpsPipelinesSettings { [CmdletBinding()] param ( [Parameter()] [string] $PAT, [Parameter()] [string] $Organization, [Parameter()] [string] $Project, [Parameter()] [string] $OutputPath ) Write-Verbose "Getting pipelines settings from Azure DevOps" $pipelinesSettings = Get-AzDevOpsPipelinesSettings -PAT $PAT -Organization $Organization -Project $Project $pipelinesSettings | Add-Member -MemberType NoteProperty -Name ObjectType -Value 'Azure.DevOps.Pipelines.Settings' $pipelinesSettings | Add-Member -MemberType NoteProperty -Name Name -Value $Project $pipelinesSettings | ConvertTo-Json -Depth 10 | Out-File (Join-Path -Path $OutputPath -ChildPath "$Project.ado.pls.json") } Export-ModuleMember -Function Export-AzDevOpsPipelinesSettings # End of Function Export-AzDevOpsPipelinesSettings |