Public/Get-PSUADOPipelineBuild.ps1
|
function Get-PSUADOPipelineBuild { <# .SYNOPSIS Get details about a specific Azure DevOps pipeline build. .DESCRIPTION This function connects to Azure DevOps using your Personal Access Token (PAT) and fetches information about a particular pipeline build. It returns details like the build ID, pipeline name, when it was queued, its status, result, and a link to view the build in Azure DevOps. .PARAMETER BuildId (Mandatory) The build ID of the pipeline run to retrieve details for. .PARAMETER Project (Mandatory) The Azure DevOps project name containing the build. .PARAMETER Organization (Optional) The Azure DevOps organization name under which the project resides. Default value is $env:ORGANIZATION. Set using: Set-PSUUserEnvironmentVariable -Name "ORGANIZATION" -Value "value_of_org_name" .PARAMETER PAT (Optional) Personal Access Token for Azure DevOps authentication. Default value is $env:PAT. Set using: Set-PSUUserEnvironmentVariable -Name "PAT" -Value "value_of_PAT" .EXAMPLE Get-PSUADOPipelineBuild -BuildId 12345 -PAT 'xxxxxxxxxx' -Organization 'OmgItSolutions' -Project 'PSUtilities' This example gets details for build ID 12345 in the given organization and project. .OUTPUTS [PSCustomObject] .NOTES Author: Lakshmanachari Panuganti Date : 2025-06-16 : Initial development .LINK https://github.com/lakshmanachari-panuganti/OMG.PSUtilities/tree/main/OMG.PSUtilities.AzureDevOps https://www.linkedin.com/in/lakshmanachari-panuganti/ https://www.powershellgallery.com/packages/OMG.PSUtilities.AzureDevOps https://learn.microsoft.com/en-us/rest/api/azure/devops/build/builds/get #> [CmdletBinding()] param ( [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateRange(1, [int]::MaxValue)] [int]$BuildId, [Parameter(Mandatory)] [ValidateNotNullOrEmpty()] [string]$Project, [Parameter()] [ValidateNotNullOrEmpty()] [string]$Organization = $env:ORGANIZATION, [Parameter()] [ValidateNotNullOrEmpty()] [string]$PAT = $env:PAT ) begin{ $headers = Get-PSUAdoAuthHeader -PAT $PAT } process { try { Write-Verbose "Processing build ID: $BuildId" Write-Verbose "Escaping project name for the URL..." $escapedProject = [uri]::EscapeDataString($Project) $buildUrl = "https://dev.azure.com/$Organization/$escapedProject/_apis/build/builds/$($BuildId)?api-version=7.1-preview.7" Write-Verbose "Calling Azure DevOps API at: $buildUrl" $build = Invoke-RestMethod -Uri $buildUrl -Headers $headers -Method Get -ErrorAction Stop if (-not $build) { throw "No build found with ID: $BuildId" } [PSCustomObject]@{ BuildId = $build.id BuildNumber = $build.buildNumber PipelineName = $build.definition.name Status = $build.status Result = $build.result QueueTime = if ($build.queueTime) { [datetime]$build.queueTime } else { $null } StartTime = if ($build.startTime) { [datetime]$build.startTime } else { $null } FinishTime = if ($build.finishTime) { [datetime]$build.finishTime } else { $null } SourceBranch = $build.sourceBranch SourceVersion = $build.sourceVersion TriggeredBy = $build.requestedFor.displayName Reason = $build.reason LogsUrl = $build.logs.url WebLink = $build._links.web.href Repository = $build.repository.name RepositoryUrl = $build.repository.url PSTypeName = 'PSU.ADO.BuildDetails' } } catch { $PSCmdlet.ThrowTerminatingError($_) } } } |