Skip to main content

Get-VSTeamGroup

SYNOPSIS​

Returns a Group or List of Groups.

SYNTAX​

List (Default)​

Get-VSTeamGroup [-SubjectTypes <String[]>] [-ScopeDescriptor <String>] [<CommonParameters>]

ListByProjectName​

Get-VSTeamGroup [-SubjectTypes <String[]>] -ProjectName <String> [<CommonParameters>]

ByGroupDescriptor​

Get-VSTeamGroup -Descriptor <String> [<CommonParameters>]

DESCRIPTION​

Returns a Group or List of Groups.

EXAMPLES​

Example 1​

$group = Get-VSTeamGroup | ? DisplayName -eq 'Endpoint Administrators'

Assigns Endpoint Administrators group to $group variable.

PARAMETERS​

-SubjectTypes​

A comma separated list of user subject subtypes to reduce the retrieved results. Valid subject types:

  • vssgp (Azure DevOps Group)
  • aadgp (Azure Active Directory Group)
Type: String[]
Parameter Sets: List, ListByProjectName
Aliases:

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

-ScopeDescriptor​

Specify a non-default scope (collection, project) to search for groups.

Type: String
Parameter Sets: List
Aliases:

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

-Descriptor​

The descriptor of the desired graph group.

Type: String
Parameter Sets: ByGroupDescriptor
Aliases: containerDescriptor, GroupDescriptor

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

-ProjectName​

Specifies the team project for which this function operates.

You can tab complete from a list of available projects.

You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.

Type: String
Parameter Sets: ListByProjectName
Aliases:

Required: True
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​

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