Skip to main content

Add-VSTeamExtension

SYNOPSIS​

Install the specified extension into the account / project collection.

SYNTAX​

Add-VSTeamExtension -PublisherId <String> -ExtensionId <String> [-Version <String>] [<CommonParameters>]

DESCRIPTION​

Install the specified extension into the account / project collection.

EXAMPLES​

Example 1​

Add-VSTeamExtension -PublisherId "MyPublisher" -ExtensionId "MyExtension"

This command installs the specified extension "MyExtension" from the publisher "MyPublisher" into the account/project collection.

Example 2​

Add-VSTeamExtension -PublisherId "AnotherPublisher" -ExtensionId "AnotherExtension" -Version "1.2.3"

This command installs version "1.2.3" of the extension "AnotherExtension" from the publisher "AnotherPublisher" into the account/project collection.

Example 3​

$myExtensionDetails = @{
    PublisherId = "SamplePublisher";
    ExtensionId = "SampleExtension";
    Version = "2.0.0";
}

Add-VSTeamExtension @myExtensionDetails

This example uses a hashtable to specify the details of the extension and installs version "2.0.0" of the extension "SampleExtension" from the publisher "SamplePublisher" into the account/project collection.

Example 4​

$extensions = Import-Csv -Path "C:\path\to\extensions.csv"

foreach ($ext in $extensions) {
    Add-VSTeamExtension -PublisherId $ext.PublisherId -ExtensionId $ext.ExtensionId -Version $ext.Version
}

This example reads a CSV file containing a list of extensions with their PublisherId, ExtensionId, and Version, and installs each extension into the account/project collection.

Example 5​

Add-VSTeamExtension -PublisherId "DevOpsTools" -ExtensionId "CI_CD_Tool"

This command installs the specified extension "CI_CD_Tool" from the publisher "DevOpsTools" into the account/project collection. If there are multiple versions available, the latest version will be installed by default.

PARAMETERS​

-PublisherId​

The id of the publisher.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExtensionId​

The id of the extension.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Version​

The version of the extension. Example: "0.1.35".

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

Prerequisites:

Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.

tips:

  • check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
  • use Set-VSTeamDefaultProject to set default project for every call
  • use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
  • use Profiles to load an account and the correct version

Add-VSTeamExtension

Get-VSTeamExtension

Remove-VSTeamExtension

Update-VSTeamExtension