Skip to main content

Update-VSTeamExtension

SYNOPSIS​

Update an installed extension. Typically this API is used to enable or disable an extension.

SYNTAX​

Update-VSTeamExtension -PublisherId <String> -ExtensionId <String> -ExtensionState <String> [-Force] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION​

Update an installed extension. Typically this API is used to enable or disable an extension.

EXAMPLES​

Example 1​

Update-VSTeamExtension -PublisherId "Contoso" -ExtensionId "MyExtension" -ExtensionState "disabled"

Disables the extension "MyExtension" from the publisher "Contoso".

Example 2​

Update-VSTeamExtension -PublisherId "Contoso" -ExtensionId "MyExtension" -ExtensionState "none"

Sets the extension state to "none" for the extension "MyExtension" from the publisher "Contoso".

Example 3​

Update-VSTeamExtension -PublisherId "Contoso" -ExtensionId "MyExtension" -ExtensionState "disabled" -Force

Disables the extension "MyExtension" from the publisher "Contoso" and forces the update without any confirmation prompts.

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

-ExtensionState​

The state of an installed extension. Example: "disabled". The acceptable values for this parameter are:

  • none
  • disabled
Type: String
Parameter Sets: (All)
Aliases:

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

-Force​

Forces the function without confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WhatIf​

Shows what would happen if the function runs. The function is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm​

Prompts you for confirmation before running the function.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
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