Chocolatey Community Coffee Break

Join the Chocolatey Team on our regular monthly stream where we discuss all things Community, what we do, how you can get involved and answer your Chocolatey questions.

Learn More

Chocolatey Product Spotlight

Join the Chocolatey Team on our regular monthly stream where we put a spotlight on the most recent Chocolatey product releases. You'll have a chance to have your questions answered in a live Ask Me Anything format.

Learn More

Announcing Chocolatey Central Management 0.10.0

Livestream from
Thursday, 06 October 2022

We recently released our largest update to Chocolatey Central Management so far. Join Gary and Steph to find out more about Chocolatey Central Management and the new features and fixes we've added to this release.

Watch On-Demand
Chocolatey and Intune Overview

Webinar Replay from
Wednesday, 30 March 2022

At Chocolatey Software we strive for simple, and teaching others. Let us teach you just how simple it could be to keep your 3rd party applications updated across your devices, all with Intune!

Watch On-Demand
Chocolatey For Business. In Azure. In One Click.

Livestream from
Thursday, 9 June 2022

Join James and Josh to show you how you can get the Chocolatey For Business recommended infrastructure and workflow, created, in Azure, in around 20 minutes.

Watch On-Demand
The Future of Chocolatey CLI

Livestream from
Thursday, 04 August 2022

Join Paul and Gary to hear more about the plans for the Chocolatey CLI in the not so distant future. We'll talk about some cool new features, long term asks from Customers and Community and how you can get involved!

Watch On-Demand
Hacktoberfest Tuesdays 2022

Livestreams from
October 2022

For Hacktoberfest, Chocolatey ran a livestream every Tuesday! Re-watch Cory, James, Gary, and Rain as they share knowledge on how to contribute to open-source projects such as Chocolatey CLI.

Watch On-Demand
Chocolatey Product Spotlight: Chocolatey 1.2.0 and Chocolatey Licensed Extension 5.0.0

Livestream from
Thursday, 03 November 2022

Join Paul and Gary for this months Chocolatey product livestream where we look at the latest release of Chocolatey 1.2.0, Chocolatey Licensed Extension 5.0.0 and shine a spotlight on the new hook scripts functionality. This opens up so many possibilities for Chocolatey CLI users!

Watch On-Demand
Chocolatey Coding Livestream

Livestream from
Tuesday, 29 November 2022

Join Josh as he adds the ability to manage Chocolatey GUI config and features with the Chocolatey Ansible Collection.

Watch On-Demand
Introduction into Chocolatey with Veeam

Webinar from
Tuesday, 13 December 2022

Join Gary, Paul, and Maurice as they introduce and demonstrate how to use Chocolatey! Questions will be answered live in an Ask Me Anything format.

Watch On-Demand

Downloads:

1,485,999

Downloads of v 2.218.1:

2,647

Last Update:

22 Mar 2023

Package Maintainer(s):

Software Author(s):

  • Microsoft Corporation

Tags:

VSTS TFS Azure Pipelines Build Agents

Azure Pipelines Agent (VSTS Build Agent)

  • 1
  • 2
  • 3

2.218.1 | Updated: 22 Mar 2023

Downloads:

1,485,999

Downloads of v 2.218.1:

2,647

Maintainer(s):

Software Author(s):

  • Microsoft Corporation

Azure Pipelines Agent (VSTS Build Agent) 2.218.1

  • 1
  • 2
  • 3

All Checks are Passing

3 Passing Tests


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Successful:

No detections found in any package files

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

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

>

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

>

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

>

Deployment Method:

NOTE

This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade azure-pipelines-agent -y --source="'INTERNAL REPO URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade azure-pipelines-agent -y --source="'INTERNAL REPO URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install azure-pipelines-agent
  win_chocolatey:
    name: azure-pipelines-agent
    version: '2.218.1'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'azure-pipelines-agent' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '2.218.1'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller azure-pipelines-agent
{
    Name     = "azure-pipelines-agent"
    Version  = "2.218.1"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'azure-pipelines-agent':
  ensure   => '2.218.1',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

Package Approved

This package was approved as a trusted package on 22 Mar 2023.

Description

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 full list of package parameters are documented here (Including them here exceeds the Chocolatey nupkg description limit!)

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'"


tools\chocolateybeforemodify.ps1
Get-Service | Where-Object { $_.Name -like "vstsagent*" } | Stop-Service
tools\chocolateyinstall.ps1
$ErrorActionPreference = 'Stop'; # stop on all errors

$url = 'https://vstsagentpackage.azureedge.net/agent/2.218.1/vsts-agent-win-x86-2.218.1.zip'
$url64 = 'https://vstsagentpackage.azureedge.net/agent/2.218.1/vsts-agent-win-x64-2.218.1.zip'
$checksum = '8f6aff2af3ebd80612e0199ae8709fd319e173a6b48ccbd640e75dd1531015da'
$checksum64 = '6fb64aa12879cc3cd53dcf8492a5ca976f6b4496ce17dc0a5ab2c4bc4393b055'

$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['CollectionName']) {
        $configOpts += @('--CollectionName', $pp['CollectionName'])
    }
    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, environment, 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'])
        }
    }
    elseif ($pp['Environment']) {
        Write-Verbose "Environment Agent"

        if (!$pp['EnvironmentName'] -or !$pp['ProjectName']) {
            Write-Error "Must specify /EnvironmentName and /ProjectName"
        }

        $configOpts += @("--environment", "--environmentName", $pp['EnvironmentName'])

        if ($pp['EnvironmentTags']) {
            $configOpts += @("--addVirtualMachineResourceTags", "--virtualMachineResourceTags", $pp['EnvironmentTags'])
        }

        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")
    }

    # Self-signed certificate
    if ($pp['SslSkipCertValidation']) {
        $configOpts += @("--sslskipcertvalidation")
    }

    # Git use SChannel
    if ($pp['GitUseSChannel']) {
        $configOpts += @("--gituseschannel")
    }

    # Client Certificate
    if ($pp['UseClientCertificate']) {
        if (!$pp['SslCaCert'] -or !$pp['SslClientCert'] -or !$pp['SslClientCertKey'] -or !$pp['SslClientCertArchive'] -or !$pp['SslClientCertPassword']) {
            Write-Error "Must specify /SslCaCert, /SslClientCert, /SslClientCertKey, /SslClientCertArchive and /SslClientCertPassword"
        }
        $configOpts += @(
            "--sslcacert", $pp['SslCaCert'],
            "--sslclientcert", $pp['SslClientCert'],
            "--sslclientcertkey", $pp['SslClientCertKey'],
            "--sslclientcertarchive", $pp['SslClientCertArchive'],
            "--sslclientcertpassword", $pp['SslClientCertPassword']
        )
    }

    # Proxy
    if ($pp['ProxyUrl']) {
        $configOpts += @("--proxyurl", $pp['ProxyUrl'])

        if ($pp['ProxyUserName']) {
            $configOpts += @("--proxyusername", $pp['ProxyUserName'])

            if ($pp['ProxyPassword']) {
                $configOpts += @("--proxypassword", $pp['ProxyPassword'])
            }
        }        
    }
}

$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
}

Log in or click on link to see number of positives.

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.

Add to Builder Version Downloads Last Updated Status
Azure Pipelines Agent (VSTS Build Agent) 2.217.2 32340 Friday, February 10, 2023 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.214.1 23792 Friday, January 13, 2023 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.213.2 41798 Saturday, November 12, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.213.1 810 Friday, November 11, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.211.1 16511 Thursday, October 20, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.210.1 28536 Wednesday, September 14, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.210.0 82 Wednesday, September 7, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.209.0 10025 Wednesday, August 31, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.206.1 29783 Saturday, July 23, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.204.0 40550 Thursday, May 26, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.202.1 27768 Tuesday, April 19, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.202.0 8189 Thursday, April 7, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.200.2 25911 Saturday, February 26, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.198.3 10819 Tuesday, February 8, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.198.2 3617 Thursday, February 3, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.196.2 19135 Thursday, January 13, 2022 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.195.2 26298 Thursday, December 9, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.195.1 8080 Thursday, December 2, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.195.0 16035 Saturday, November 20, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.194.0 25320 Tuesday, November 2, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.193.1 38414 Saturday, October 16, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.193.0 21868 Thursday, October 7, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.192.0 32756 Friday, September 17, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.191.1 28563 Wednesday, September 1, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.190.0 49515 Wednesday, August 11, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.189.0 42877 Saturday, July 24, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.188.4 25085 Tuesday, July 13, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.188.3 30076 Tuesday, June 29, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.187.2 52240 Friday, June 4, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.186.1 40377 Thursday, May 13, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.185.1 31927 Thursday, April 22, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.184.2 28962 Thursday, April 1, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.183.1 39422 Monday, March 8, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.182.1 25221 Friday, February 19, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.181.2 11658 Friday, February 12, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.181.1 11413 Friday, February 5, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.181.0 14824 Monday, January 25, 2021 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.179.0 100295 Sunday, December 13, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.177.1 32156 Thursday, November 19, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.175.2 66774 Wednesday, October 7, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.174.3 22416 Thursday, September 24, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.174.2 8437 Saturday, September 19, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.174.1 27685 Tuesday, September 1, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.173.0 38223 Tuesday, August 11, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.172.2 29561 Friday, July 31, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.171.1 76811 Thursday, July 2, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.170.1 44155 Tuesday, June 16, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.169.1.20200611 6149 Wednesday, June 10, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.169.1 8320 Thursday, June 4, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.168.2 29082 Friday, May 15, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.166.4 12777 Tuesday, April 28, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.166.3 644 Thursday, April 23, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.165.2 7421 Tuesday, March 24, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.165.0 6273 Wednesday, February 26, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.164.8 3217 Friday, February 14, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.164.7 1866 Thursday, February 6, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.164.6 2064 Tuesday, January 28, 2020 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.163.1 4688 Tuesday, December 24, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.162.0 5375 Wednesday, December 11, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.160.1 4808 Tuesday, November 19, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.160.1-preview 134 Monday, November 18, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.160.0 2370 Saturday, November 9, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.159.2 2890 Wednesday, October 30, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.158.0 1794 Wednesday, October 9, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.155.1 2462 Wednesday, August 14, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.154.3 1000 Friday, July 26, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.153.2 2578 Thursday, June 20, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.152.1 454 Thursday, June 13, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.150.3 2340 Thursday, May 2, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.150.0 1070 Thursday, April 25, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.149.2 1299 Friday, April 5, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.148.2 443 Saturday, March 23, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.147.1 1803 Saturday, February 23, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.146.0 946 Friday, February 8, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.144.2 438 Wednesday, January 30, 2019 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.144.0 570 Tuesday, December 18, 2018 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.142.1 341 Saturday, December 1, 2018 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.141.1 273 Tuesday, November 6, 2018 Approved
Azure Pipelines Agent (VSTS Build Agent) 2.140.2 336 Tuesday, October 9, 2018 Approved

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