Skip to main content

Test-VSTeamMembership

SYNOPSIS​

Tests the membership in a container.

SYNTAX​

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

DESCRIPTION​

Tests the membership in a container.

EXAMPLES​

Example 1​

$UserDescriptor = 'aad.OTcyOTJkNzYtMjc3Yi03OTgxLWIzNDMtNTkzYmM3ODZkYjlj'
$GroupDescriptor = 'vssgp.Uy0xLTktMTU1MTM3NDI0NS04NTYwMDk3MjYtNDE5MzQ0MjExNy0yMzkwNzU2MTEwLTI3NDAxNjE4MjEtMC0wLTAtMC0x'
Test-VSTeamMembership -MemberDescriptor $UserDescriptor -ContainerDescriptor $GroupDescriptor

Tests if the user with the email $UserDescriptor is a member of the group $GroupDescriptor.

Example 2​

$UserDescriptor = 'aad.OTcyOTJkNzYtMjc3Yi03OTgxLWIzNDMtNTkzYmM3ODZkYjlj'
$GroupDescriptor = 'vssgp.Uy0xLTktMTU1MTM3NDI0NS04NTYwMDk3MjYtNDE5MzQ0MjExNy0yMzkwNzU2MTEwLTI3NDAxNjE4MjEtMC0wLTAtMC0x'
$membershipExists = Test-VSTeamMembership -MemberDescriptor $UserDescriptor -ContainerDescriptor $GroupDescriptor
if ($membershipExists) {
    Write-Output "User is a member of the group."
} else {
    Write-Output "User is not a member of the group."
}

Tests if the user with the $UserDescriptor is a member of the group $GroupDescriptor and outputs a message based on the result.

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: True (ByPropertyName)
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: True (ByPropertyName)
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​

System.Boolean​

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

Add-VsTeamMembership

Get-VsTeamMembership

Remove-VsTeamMembership