Skip to main content

Get-VSTeamPolicy

SYNOPSIS

Get the code policies in the specified Azure DevOps or Team Foundation Server project.

SYNTAX

Get-VSTeamPolicy [-Id <Int32[]>] -ProjectName <String> [<CommonParameters>]

DESCRIPTION

Get the code policies in the specified Azure DevOps or Team Foundation Server project.

EXAMPLES

Example 1

Get-VSTeamPolicy -ProjectName Demo

This command returns all the policies for the Demo project in your TFS or Team Services account.

Example 2

Get-VSTeamPolicy -ProjectName Demo -Id 1

This command gets the policy with an id of 1 within the Demo project.

PARAMETERS

-Id

Specifies one code policy by id.

The id is an integer. Unique within each project.

Type: Int32[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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

Add-VSTeamPolicy

Remove-VSTeamPolicy

Get-VSTeamPolicyType