Powershell module to drive TFS 2015+ via REST interface
PowerShell
Switch branches/tags
Clone or download
majkinetor Merge branch 'master' of https://github.com/majkinetor/TFS
# Conflicts:
#	TFS/Invoke-TFSBuild.ps1
Latest commit 9f86825 Oct 21, 2016

README.md

TFS

This is Powershell module to communicate with Team Foundation Server 2015 via its REST interface. It provides commands which allow you to create, update, export and import build definitions, get build logs, projects, repositories etc. The goal of the module is to be able to automate TFS setup and put its configuration on the project repository.

The module is tested with Team Foundation Server Update 2.

Installation

On Windows 10 or Powershell 5+ use: Install-Module TFS.

To install manually, copy the module to the one of the directories listed in $Env:PSModulePath.

Configuration

Module uses global variable $tfs for its configuration:

$global:tfs = @{
    root_url    = 'http://tfs015:8080/tfs'
    collection  = 'DefaultCollection'
    project     = 'ProjectXYZ'
}

Some attributes will take defaults if you don't specify them:

$tfs.collection  = 'DefaultCollection'
$tfs.api_version = '2.0'

If you need to work constantly on a single project put this setting in your $PROFILE. To manage multiple projects or collections or TFS servers you could create multiple functions for each scenario that each set $global:tfs in its own way, for example:

function set_tfs_test() {
    $global:tfs = @{ ... }
}

Then, prior to calling any module function run set_tfs_test.

TFS Credentials

Module keeps TFS credential in the $tfs.Credentials. If not specified you will be prompted for the credentials when running any of the functions. If the module CredentialManager is available (to install it run Install-Module CredentialManager in Powreshell 5+) credentials will be stored in the Windows Credential Manager and after first run, you will be able to use any function in any PS session using your stored credentials.

To use ad hoc credentials when you have your main credential stored simply use:

$tfs.Credentials = Get-Credential

This way stored credentials will be overridden only for the current session. To change the stored credentials for all subsequent sessions either delete them using the Control Panel (Manage Windows Credentials) and run any function again or use the following command:

$tfs.Credentials = New-TFSCredential    #Get credential and store it in Credential Manager.

Usage

  • To view all supported commands execute gcm -m tfs
  • To get all aliases execute get-alias | ? source -eq 'tfs'
  • Use man to get help for the command: man builds -Example

All functions have a Verbose parameter that shows very detailed log of every step involved:

PS> Get-TFSBuildLogs -Verbose

VERBOSE: No credentials specified, trying Windows Credential Manager
VERBOSE: Populating RepositorySourceLocation property for module CredentialManager.
VERBOSE: Loading module from path 'C:\Program Files\WindowsPowerShell\Modules\CredentialManager\1.0\CredentialManager.dll'.
VERBOSE: Trying to get storred credentials for 'http://tfs015:8080/tfs'
VERBOSE: Retrieving requested credential from Windows Credential Manager
VERBOSE: New TFS credentials for 'http://tfs015:8080/tfs'
VERBOSE: TFS Credential: majkinetor
VERBOSE: URI: http://tfs015:8080/tfs/DefaultCollection/ProjectXYZ/_apis/build/builds?api-version=2.0
VERBOSE: received 793807-byte response of content type application/json; charset=utf-8; api-version=2.0
VERBOSE: Build id: 1456
VERBOSE: Logs URI: http://tfs015:8080/tfs/DefaultCollection/ProjectXYZ/_apis/build/builds/1456/logs?api-version=2.0
VERBOSE: GET http://10.1.6.27:8080/tfs/DefaultCollection/ProjectXYZ/_apis/build/builds/1456/logs?api-version=2.0 with 0-byte payload
VERBOSE: received 738-byte response of content type application/json; charset=utf-8; api-version=2.0
VERBOSE: Log URI: http://tfs015:8080/tfs/DefaultCollection/cc756267-fb53-4148-906f-471588d87bcb/_apis/build/builds/1456/logs/1
...