Link

Get-TfsTeamBoardCardRule

Gets one or more team board card rules.


Table of Contents

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

Syntax

Get-TfsTeamBoardCardRule
    [-Rule <object>]
    [-Board <object>]
    [-Collection <object>]
    [-Project <object>]
    [-RuleType <CardRuleType>]
    [-Server <object>]
    [-Team <object>]

[Go to top]

Parameters

-Board

Specifies the board name.

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

-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

-Rule

Specifies the rule name. Wildcards are supported. When omitted, returns all card rules in the given board.

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

-RuleType

Specifies the kind of rule to return. When omitted, returns both rule types (card color and tag color). Possible values: CardColor, TagColor, All

Type CardRuleType
Position (Named)
Default Value All
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

-Team

Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.

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

Inputs

System.Object

Specifies the board name.

Outputs

Microsoft.TeamFoundation.Work.WebApi.Rule