Skip to main content

Remove-VSTeamDirectAssignment

SYNOPSIS​

Removes explicit assignments of users by their IDs. Operates in either preview mode or normal mode. In normal mode, it chunks user IDs into groups of 20 to avoid timeouts.

SYNTAX​

Remove-VSTeamDirectAssignment [-UserIds <String[]>] [-Preview] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Removes explicit assignments of users by their IDs. Operates in either preview mode or normal mode. In normal mode, it chunks user IDs into groups of 20 to avoid timeouts.

EXAMPLES​

Example 1​

Remove-VSTeamDirectAssignment -UserIds '12345','67890' -Preview

Removes the explicit assignments for the users with the specified IDs in preview mode.

Example 2​

Remove-VSTeamDirectAssignment -UserIds '12345','67890'

Removes the explicit assignments for the users with the specified IDs.

PARAMETERS​

-UserIds​

The IDs of the users to remove explicit assignments for.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Preview​

Switch to operate in preview mode.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Confirm​

Prompts you for confirmation before running the cmdlet.

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

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

-WhatIf​

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

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

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​

PSCustomObject​

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