Skip to main content

Remove-VSTeamUserEntitlement

SYNOPSIS​

Delete a user from the account.

The delete operation includes unassigning Extensions and Licenses and removing the user from all project memberships. The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account.

SYNTAX​

ById (Default)​

Remove-VSTeamUserEntitlement -Id <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

ByEmail​

Remove-VSTeamUserEntitlement -Email <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Delete a user from the account.

The delete operation includes unassigning Extensions and Licenses and removing the user from all project memberships. The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account.

EXAMPLES​

Example 1​

Remove-VSTeamUserEntitlement -Id "12345678-abcd-1234-abcd-1234567890ab"

Removes the user entitlement with ID `12345678-abcd-1234-abcd-1234567890ab`.

Example 2​

Remove-VSTeamUserEntitlement -Email "user1@example.com"

Removes the user entitlement for the user with the email "user1@example.com".

Example 3​

Remove-VSTeamUserEntitlement -Id "12345678-abcd-1234-abcd-1234567890ab" -Force

Removes the user entitlement with ID `12345678-abcd-1234-abcd-1234567890ab` and forces the removal without any confirmation prompts.

PARAMETERS​

-Id​

The id of the user to remove.

Type: String
Parameter Sets: ById
Aliases: UserId

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

-Email​

The email of the user to remove.

Type: String
Parameter Sets: ByEmail
Aliases: UserEmail

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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