Link

Get-TfsWorkItemQuery

Gets the definition of one or more work item saved queries.


Table of Contents

  1. Syntax
  2. Parameters
  3. Inputs
  4. Outputs
  5. Related Links

Syntax

Get-TfsWorkItemQuery
    [-Query <object>]
    [-Collection <object>]
    [-Deleted]
    [-Project <object>]
    [-Scope <QueryItemScope>]
    [-Server <object>]

[Go to top]

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

-Deleted

Returns deleted items.

Type SwitchParameter
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-Project

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

-Query (Aliases: Path)

Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.

Type object
Position 0
Default Value **
Accept pipeline input False
Accept wildcard characters False

-Scope

Specifies the scope of the returned item. Personal refers to the “My Queries” folder”, whereas Shared refers to the “Shared Queries” folder. When omitted defaults to “Both”, effectively searching for items in both scopes. Possible values: Personal, Shared, Both

Type QueryItemScope
Position (Named)
Default Value Both
Accept pipeline input False
Accept wildcard characters False

-Server

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.

Outputs

Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem