Skip to main content

Set-VSTeamDefaultAPITimeout

SYNOPSIS​

Sets the default timeout to be used with other calls in the module.

SYNTAX​

Set-VSTeamDefaultAPITimeout [-Force] -TimeoutSec <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

By setting a default timeout you can adjust the value for your needs

EXAMPLES​

Example 1​

Set-VSTeamDefaultAPITimeout 30

This command sets 30 seconds as the default timeout.

PARAMETERS​

-TimeoutSec​

Specifies the timeout for all function calls.

Type: Int32
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​

System.String​

OUTPUTS​

System.Object​

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

Set-VSTeamAPIVersion

Set-VSTeamDefaultProject

Set-VSTeamDefaultAPITimeout

about_vsteam

about_vsteam_profiles

about_vsteam_provider