Update-VSTeamUserEntitlement
SYNOPSIS
Edit the entitlements (License, Extensions, Projects, Teams etc) for a user.
SYNTAX
ByEmail (Default)
Update-VSTeamUserEntitlement -Email <String> [-License <String>] [-LicensingSource <String>]
[-MSDNLicenseType <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
ById
Update-VSTeamUserEntitlement -Id <String> [-License <String>] [-LicensingSource <String>]
[-MSDNLicenseType <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Edit the entitlements (License, Extensions, Projects, Teams etc) for a user.
EXAMPLES
EXAMPLE 1
Update-VSTeamUserEntitlement -Id "12345" -License "Professional"
This example updates the license type of a user with ID "12345" to "Professional".
EXAMPLE 2
Update-VSTeamUserEntitlement -Email "user@example.com" -License "StakeHolder"
This example updates the license type of a user with email "user@example.com" to "StakeHolder".
PARAMETERS
-Id
The id of the user to be updated.
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 address of the user to update. For organizations with over 100 users this can be very slow and resource intensive.
Type: String
Parameter Sets: ByEmail
Aliases: UserEmail
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-License
Type of Account License you want to change to. The acceptable values for this parameter are:
- Advanced
- EarlyAdopter
- Express
- None
- Professional
- StakeHolder
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LicensingSource
Source of the license. The acceptable values for this parameter are: - account
- auto
- msdn
- none
- profile
- trial
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MSDNLicenseType
MSDN license type. The acceptable values for this parameter are: - eligible
- enterprise
- none
- platforms
- premium
- professional
- testProfessional
- ultimate
Type: String
Parameter Sets: (All)
Aliases:
Required: False
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