Notices: This section not yet converted to new layout. Download stats are rolling back out.

Azure Pipelines Agent (VSTS Build Agent)

2.150.3

Package test results are passing.

This package was approved as a trusted package on 5/2/2019.

The cross platform build and release agent for Azure Pipelines and Team Foundation Server 2015 and beyond.
An agent that you set up and manage on your own to run build and deployment jobs is a self-hosted agent. You can use self-hosted agents in Azure Pipelines or Team Foundation Server (TFS). Self-hosted agents give you more control to install dependent software needed for your builds and deployments.

Package Specific

Package Parameters

The following package parameters can be set:

  • /Directory: - Directory to install agent in (defaults to c:\agent)
  • /Url: - URL of the server. For example: https://myaccount.visualstudio.com or http://onprem:8080/tfs
  • /Token: - Personal Access Token
  • /Auth: - One of negotiate, alt or integrated
  • /Username: - Used with negotiate or alt - Specify the Windows user name in the format: domain\userName or [email protected]
  • /Password: - Used with negotiate or alt
  • /Pool: - Pool name for the agent to join (defaults to default)
  • /DeploymentGroup - Install as deployment agent (instead of a build agent)
  • /ProjectName: - Used with /DeploymentGroup. Team project name
  • /DeploymentGroupName: - Used with /DeploymentGroup. Deployment group for the agent to join
  • /DeploymentGroupTags: - Used with /DeploymentGroup. A comma separated list of tags for the deployment group agent. For example "web, db".
  • /AutoLogon - Configure auto logon and run the agent on startup (The default if this is not specified, is to run the agent as a Windows Service)
  • /LogonAccount: - Account that agent should run as (either Windows Service or auto logon) - Specify the Windows user name in the format: domain\userName or [email protected] To log in as Local System, use "NT AUTHORITY\SYSTEM". Defaults to NetworkService if not specified.
  • /LogonPassword: - Used with /LogonAccount. Windows logon password
  • /Work:WorkDirectory - Work directory where job data is stored. Defaults to _work under the root of the agent directory. The work directory is owned by a given agent and should not share between multiple agents.
  • /AgentName:Custom_Name - Custom agent name (defaults to hostname)
  • /Replace - Replace already registered agent with same name

To pass parameters, use --params "''" (e.g. choco install packageID [other options] --params="'/ITEM:value /ITEM2:value2 /FLAG_BOOLEAN'").
To have choco remember parameters on upgrade, be sure to set choco feature enable -n=useRememberedArgumentsForUpgrades.

Example:
choco install azure-pipelines-agent --params "'/Directory:c:\agent2 /Token:mytoken /Pool:Integration /Url:https://dev.azure.com/orgname'"

To install Azure Pipelines Agent (VSTS Build Agent), run the following command from the command line or from PowerShell:

C:\> choco install azure-pipelines-agent

To upgrade Azure Pipelines Agent (VSTS Build Agent), run the following command from the command line or from PowerShell:

C:\> choco upgrade azure-pipelines-agent

Files

Hide
  • tools\chocolateybeforemodify.ps1 Show
    Get-Service | Where-Object { $_.Name -like "vstsagent*" } | Stop-Service
  • tools\chocolateyinstall.ps1 Show
    $ErrorActionPreference = 'Stop'; # stop on all errors
    
    $url = 'https://vstsagentpackage.azureedge.net/agent/2.150.3/vsts-agent-win-x86-2.150.3.zip'
    $url64 = 'https://vstsagentpackage.azureedge.net/agent/2.150.3/vsts-agent-win-x64-2.150.3.zip'
    $checksum = '7a6d00211e247163fea95a2e653d19d55aa27047cdfbdab51779b41c63257281'
    $checksum64 = 'fafc14bf26de1183c6f2ba03c9ee111ddecabf1f7c866772e55bc695d8dfc716'
    
    $pp = Get-PackageParameters
    
    if (!$pp['Directory']) { $pp['Directory'] = 'c:\agent' }
    
    $configOpts = @()
    
    # We only run config.cmd if a Url is supplied
    if ($pp['Url']) {
    
        $configOpts = @('configure', '--unattended', '--acceptTeeEula')
        $configOpts += @('--url', $pp['Url'])
    
        if ($pp['Token']) {
            $configOpts += @("--auth", "pat", "--token", $pp['Token'])
        }
        else {
            if (!$pp['Auth']) {
                Write-Error "You need to specify an auth type with /Auth= 'negotiate', 'alt' or 'integrated'"
            }
            
            $configOpts += @("--auth", $($pp['Auth']))
    
            if ($pp['Auth'] -ine 'integrated') {
                $username = $pp['Username']
                $password = $pp['Password']
    
                if (!$username -or !$password) {
                    Write-Error "You must supply /username and /password"
                }
                
                $configOpts += @("--userName", $username, "--password", $password)
            }
        }
        # Are we a deployment agent or a build agent?
        if ($pp['DeploymentGroup']) {
            Write-Verbose "Deployment Agent"
    
            if (!$pp['DeploymentGroupName'] -or !$pp['ProjectName']) {
                Write-Error "Must specify /DeploymentGroupName and /ProjectName"
            }
    
            $configOpts += @("--deploymentGroup", "--deploymentGroupName", $pp['DeploymentGroupName'])
            if ($pp['DeploymentGroupTags']) {
                $configOpts += @("--addDeploymentGroupTags", "--deploymentGroupTags", $pp['DeploymentGroupTags'])
            }
    
            if ($pp['ProjectName']) {
                $configOpts += @('--projectName', $pp['ProjectName'])
            }
        }
        else {
            if (!$pp['Pool']) { $pp['Pool'] = 'default'}
          
            $configOpts += @("--pool", $pp['Pool'])
        }
        
        # AutoLogon(interactive) or as a service
        if ($pp['AutoLogon']) {
            $configOpts += @('--runAsAutoLogon', '--noRestart')
        }
        else {
            $configOpts += @('--runAsService')
        }
    
        if ($pp['LogonAccount']) {
            $configOpts += @("--windowsLogonAccount", $pp['LogonAccount'])
    
            if ($pp['LogonPassword']) {
                $configOpts += @("--windowsLogonPassword", $pp['LogonPassword'])
            }
        }
    
        # Work directory
        if ($pp['Work']) {
            $configOpts += @("--work", $pp['Work'])
        }
    
        # Agent name
        if ($pp['AgentName']) {
            $configOpts += @("--agent", $pp['AgentName'])
        }
    
        # Replace existing agent
        if ($pp['Replace']) {
            $configOpts += @("--replace")
        }
    }
    
    $packageArgs = @{
        packageName    = $env:ChocolateyPackageName
        unzipLocation  = $pp['Directory']
        url            = $url
        url64bit       = $url64
    
        checksum       = $checksum
        checksumType   = 'sha256'
        checksum64     = $checksum64
        checksumType64 = 'sha256'
    }
    
    Install-ChocolateyZipPackage @packageArgs
    
    if ($configOpts.Count) {
        Write-Verbose "$($packageArgs.unzipLocation)\bin\Agent.Listener.exe configure $configOpts"
        & "$($packageArgs.unzipLocation)\bin\Agent.Listener.exe" $configOpts
    }
    

Virus Scan Results

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Dependencies

Package Maintainer(s)

Software Author(s)

  • Microsoft Corporation

Copyright

2018 Microsoft Corporation

Tags

Release Notes

https://github.com/Microsoft/azure-pipelines-agent/releases

Version History

Version Downloads Last updated Status
Azure Pipelines Agent (VSTS Build Agent) 2.150.0 534 Thursday, April 25, 2019 approved
Azure Pipelines Agent (VSTS Build Agent) 2.149.2 1147 Friday, April 5, 2019 approved
Azure Pipelines Agent (VSTS Build Agent) 2.148.2 301 Saturday, March 23, 2019 approved
Azure Pipelines Agent (VSTS Build Agent) 2.147.1 1645 Saturday, February 23, 2019 approved
Azure Pipelines Agent (VSTS Build Agent) 2.146.0 783 Friday, February 8, 2019 approved
Azure Pipelines Agent (VSTS Build Agent) 2.144.2 298 Wednesday, January 30, 2019 approved
Azure Pipelines Agent (VSTS Build Agent) 2.144.0 328 Tuesday, December 18, 2018 approved
Azure Pipelines Agent (VSTS Build Agent) 2.142.1 152 Saturday, December 1, 2018 approved
Show More

Discussion for the Azure Pipelines Agent (VSTS Build Agent) Package

Ground rules:

  • This discussion is only about Azure Pipelines Agent (VSTS Build Agent) and the Azure Pipelines Agent (VSTS Build Agent) package. If you have feedback for Chocolatey, please contact the google group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Azure Pipelines Agent (VSTS Build Agent), or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.

comments powered by Disqus
Chocolatey.org uses cookies to enhance the user experience of the site.
Ok