TFS Web API

List available pipelines

foreach ($pipeline in (get-webApiJson "$collUrl/$project_id/_apis/pipelines").value ) {
   '{0,3}: {1,-40} {2,-30} {3}' -f $pipeline.id, $pipeline.name, $pipeline.folder, $pipeline.url
}

$pipeline_id = 48

$pipeline = get-webApiJson "$collUrl/$project_id/_apis/pipelines/$pipeline_id"

Show variables of a pipeline

$pipeline_variables = $pipeline.configuration.designerJson.variables

foreach ($var in $pipeline_variables | get-member -type noteProperty) {
    $var_name = $var.name
    '{0,-30}: {1,-90}' -f $var_name, $pipeline_variables.$var_name.value # , ($pipeline_variables.$var_name.allowOverride)
}

Run a pipeline

invoke-webRequest `
  -useDefaultCredentials `
  -method post `
  -headers  @{ 'Accept'        = 'application/json' ;
               'Content-Type'  = 'application/json' } `
  "$collUrl/$project_id/_apis/pipelines/$pipeline_id/runs?api-version=6.0-preview" `
  -body '{
    "variables":  {
          "VersionFileName": {
              "secret": false,
              "value": "fooBarBaz"
           }
      },
}'

Show runs of a pipeline

foreach ($run in (get-webApiJson "$collUrl/$project_id/_apis/pipelines/$pipeline_id/runs").value) {

    $finishedDate = $run.psObject.members.item('finishedDate')

    if ($finishedDate -ne $null) {
        $finishedDate = ([datetime] $run.finishedDate).ToLocalTime().ToString('yyyy-MM-dd HH:mm:ss')
    }
    else {
        $finishedDate = '-'
    }
    $result = $run.psObject.members.item('result')

    if ($result -ne $null) {
        $result = $run.result
    }
    else {
        $result = '-'
    }

   '{0}: {1:yyyy-MM-dd HH:mm:ss} {2,-19}  {3,-60} {4,-10} {5,-10}' -f `
      $run.id,
      (([datetime] $run.createdDate ).ToLocalTime()),
                   $finishedDate,
                   $run.name,
                   $run.state,
                   $result
}

List builds

$top = 20
foreach ($build in (get-webApiJson "$collUrl/$project_id/_apis/build/builds?`$top=$top").value) {

  #
  # result is empty if status is 'In Progress'
  #
    $result = $build.psObject.members.item('result')
    if ($result -ne $null) {
        $result = $result.value
    }
    else {
        $result = 'n/a'
    }

    '{0,5} | {1:yyyy-MM-dd HH:mm:ss} | {2,-40} {3,-30} {4,-11} {5,-11}' -f `
       $build.id,
       ([datetime] $build.queueTime).ToLocalTime(),
       $build.buildNumber,
       $build.requestedFor.displayName,
       $build.status,
       $result
}

Show details about a build with a given id

$build_id = 7141
$bld_det = get-webApiJson "$collUrl/$project_id/_apis/build/builds/$build_id"

write-host "Build Rev Nr.    $($bld_det.buildNumberRevision)"
write-host "Source version:  $($bld_det.sourceVersion)"
write-host "Queue:           $($bld_det.queue.name) | Pool: $($bld_det.queue.pool.id) $($bld_det.queue.pool.name)"
write-host "Definition id:   $($bld_det.definition.id)"
write-host "           url:  $($bld_det.definition.url)"
write-host "Logs:            $($bld_det.logs.url)"
write-host "Parameters:"
$params_ = $bld_det.parameters |convertFrom-json
foreach ($param in ($params_ | get-member -type noteProperty)) {
   write-host "    $($param.name): $($params_.($param.name))"
}
write-host "orchestrationPlan: $($bld_det.orchestrationPlan.planid)"

Build definitions

foreach ($def in (get-webApiJson "$collUrl/$project_id/_apis/build/definitions").value) {

   write-host ( '{0,3}: {1,-50} {2,-8} | {3,-2} {4,-20} | {5,-10}' -f `
      $def.id,
      $def.name,
      $def.type,        # build ...?
      $def.queue.id,
      $def.queue.name,
      $def.queueStatus  # enabled, paused, ...?
   )

}

Show definitions

foreach ($rel in (get-webApiJson "$collUrl/$project_id/_apis/release/definitions").value) {
   '{0,3}: {1,-60} {2,-20} {3}' -f $rel.id, $rel.name, $rel.path, $rel.releaseNameFormat
}

$release_definition_id = 18

Print details of a release definition

function print-release-definition {
   param (
       [int] $rel_def_id
   )
   $rel_def = get-webApiJson "$collUrl/$project_id/_apis/release/definitions/$rel_def_id"
   #
   write-host "id              : $($rel_def.id)"
   #
   write-host "Last release: $( ([dateTime] $rel_def.lastRelease.createdOn).ToLocalTime().ToString('yyyy-MM-dd HH:mm:ss'))  ($($rel_def.lastRelease.id))"
#  write-host "Last release"
   #
   write-host "Environments"
   foreach ($env in $rel_def.environments) {
      write-host ('   {0,3}: {1}' -f $env.id, $env.name  )
      write-host ("        Current release: $($env.currentRelease.id) [$($env.currentRelease.url)]")
      write-host ("        Deploy step    : $($env.deployStep.id)")
      write-host ("        Badge URL      : $($env.badgeUrl)")
      #
      write-host ("        deploy phases  : $($env.deployPhases)")
      #
      write-host
   }
   #
   write-host "Artifacts"
   foreach ($art in $rel_def.artifacts) {
      write-host ("        $($art.sourceId)")
      write-host ("        $($art.type)")
      write-host ("        $($art.alias)")
      write-host ("        $($art.isPrimary)")
      #
      write-host
   }
}

print-release-definition $release_definition_id

Show «executed» releases

foreach ($rel in (get-webApiJson "$collUrl/$project_id/_apis/release/releases").value) {
    '{0,4}: {1,-60} {2,-7} {3:yyyy-MM-dd HH:mm:ss}  {4,3}  {5,-30} {6,-20}' -f `
        $rel.id,
        $rel.name,
        $rel.status,
       ( ([datetime] $rel.createdOn).ToLocalTime()),
        $rel.releaseDefinition.id,
        $rel.releaseDefinition.name,
        $rel.createdBy.displayName
}

Show details of a given release

function print-release-details {

    param (
        [int] $rel_id
    )
 
    $rel_det = get-webApiJson "$collUrl/$project_id/_apis/release/releases/$rel_id"
 
    write-host "Release Details for $($rel_det.name) ($($rel_det.id))"
    write-host "Log container URL: $($rel_det.logsContainerUrl)"
    write-host "URL:               $($rel_det.url)"
    foreach ($env in $rel_det.environments) {
       write-host ('   {0,3}: {1}' -f $env.id, $env.name  )
       write-host ("        Status             : $($env.status)")
       write-host ("        Rank               : $($env.rank)")
       write-host ("        Release            : $($env.release.id)")
       write-host ("        Release definition : $($env.releaseDefinition.id)")
       write-host ("        Deploy Steps")
       foreach ($step in $env.deploySteps) {
          write-host ("           $($step.id) - $($step.status)")
          foreach ($phase in $step.releaseDeployPhases) {
          write-host ("              phase:      $($phase.id)")
          write-host ("              runPlandId: $($phase.runPlanId)")
          }
       }
    }
}