Get-TfsGroup
Gets one or more Azure DevOps groups.
Table of Contents
Syntax
Get-TfsGroup
[-Group <object>]
[-Collection <object>]
[-Project <object>]
[-Recurse]
[-Scope <GroupScope>]
[-Server <object>]
Parameters
-Collection (Aliases: Organization)
Specifies the URL to the Team Project Collection or Azure DevOps Organization to connect to, a TfsTeamProjectCollection object (Windows PowerShell only), or a VssConnection object. You can also connect to an Azure DevOps Services organizations by simply providing its name instead of the full URL. For more details, see the Get-TfsTeamProjectCollection cmdlet. When omitted, it defaults to the connection set by Connect-TfsTeamProjectCollection (if any).
| Type | object |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the group to be retrieved. Supported values are: Group name or ID. Wildcards are supported.
| Type | object |
| Position | 0 |
| Default Value | * |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeamProject (if any). For more details, see the Get-TfsTeamProject cmdlet.
| Type | object |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | True (byvalue) |
| Accept wildcard characters | False |
Searches recursively for groups in the scopes under the specified scope.
| Type | SwitchParameter |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the scope under which to search for the group. When omitted, defaults to the Collection scope. Possible values: Server, Collection, Project
| Type | GroupScope |
| Position | (Named) |
| Default Value | Collection |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the URL to the Team Foundation Server to connect to, a TfsConfigurationServer object (Windows PowerShell only), or a VssConnection object. When omitted, it defaults to the connection set by Connect-TfsConfiguration (if any). For more details, see the Get-TfsConfigurationServer cmdlet.
| Type | object |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Inputs
System.Object
Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeamProject (if any). For more details, see the Get-TfsTeamProject cmdlet.