Skip to main content

Add-VSTeamMembership

SYNOPSIS

Adds a membership to a container.

SYNTAX

Add-VSTeamMembership [-MemberDescriptor] <String> [-ContainerDescriptor] <String> [<CommonParameters>]

DESCRIPTION

Adds a membership to a container.

EXAMPLES

Example 1

$user = Get-VSTeamUser | ? DisplayName -eq 'Test User'
$group = Get-VSTeamGroup | ? DisplayName -eq 'Endpoint Administrators'
Add-VSTeamMembership -MemberDescriptor $user.Descriptor -ContainerDescriptor $group.Descriptor

Adds Test User to the Endpoint Administrators group.

PARAMETERS

-MemberDescriptor

A member descriptor retrieved by Get-VsTeamUser.

Type: String
Parameter Sets: (All)
Aliases:

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

-ContainerDescriptor

A container descriptor retrieved by Get-VsTeamGroup.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
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

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

Get-VsTeamUser

Get-VsTeamGroup

Get-VsTeamMembership

Remove-VsTeamMembership

Test-VsTeamMembership