Link

Search-TfsWorkItem

Gets the contents of one or more work items.


Table of Contents

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

Syntax

Search-TfsWorkItem
    [-Query] <string>
    [-Collection <object>]
    [-Project <object>]
    [-Results <int>]
    [-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

-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 False
Accept wildcard characters False

-Query

Specifies the text to search for. Supports the Quick Filter syntax described in https://docs.microsoft.com/en-us/azure/devops/project/search/advanced-work-item-search-syntax

Type string
Position 0
Default Value (N/A)
Accept pipeline input True (byvalue)
Accept wildcard characters False

-Results

Specifies the maximum quantity of results. Supports between 1 and 1000 results. When omitted, defaults to 100. Currently this cmdlet does not support result pagination.

Type int
Position (Named)
Default Value 100
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.String

Specifies the text to search for. Supports the Quick Filter syntax described in https://docs.microsoft.com/en-us/azure/devops/project/search/advanced-work-item-search-syntax

Outputs

Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem