Skip to main content

Get-VSTeamPermissionInheritance

SYNOPSIS​

Undocumented API Returns true or false.

SYNTAX​

Get-VSTeamPermissionInheritance -Name <String> -resourceType <String> [-ProjectName <String>]
 [<CommonParameters>]

DESCRIPTION​

Undocumented API Returns true or false.

EXAMPLES​

Example 1​

Get-VSTeamPermissionInheritance -ProjectName Demo -Name Demo-CI -ResourceType BuildDefinition

This command returns true or false.

Example 2​

Get-VSTeamBuildDefinition | Get-VSTeamPermissionInheritance

This command returns true or false for every build definition returned from Get-VSTeamBuildDefinition.

PARAMETERS​

-Name​

Specifies the name of the resource.

Type: String
Parameter Sets: (All)
Aliases:

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

-resourceType​

Specifies the type of resource. The acceptable values for this parameter are:

  • Repository
  • BuildDefinition
  • ReleaseDefinition
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-VSTeamPermissionInheritanceType