Skip to main content

Set-VSTeamPipelineAuthorization

SYNOPSIS​

Authorizes pipelines to use the given resources.

SYNTAX​

AuthorizeResource (Default)​

Set-VSTeamPipelineAuthorization [-PipelineIds] <Int32[]> -ProjectName <String> -ResourceId <String>
 -ResourceType <String> -Authorize <Boolean> [-WhatIf] [-Confirm] [<CommonParameters>]

AuthorizeAll​

Set-VSTeamPipelineAuthorization -ProjectName <String> -ResourceId <String> -ResourceType <String>
 -AuthorizeAll <Boolean> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Authorizes pipelines to use the given resources.

EXAMPLES​

Example 1​

Set-VSTeamPipelineAuthorization -PipelineIds 1 -ResourceId 34 -ResourceType Queue -Authorize $true

Authorizes the pipeline to access the resource 34 of type Queue (Agent Pool).

Example 2​

Set-VSTeamPipelineAuthorization -PipelineIds 1 -ResourceId $resourceId -ResourceType VariableGroup -Authorize $false

Removes authorization from the pipeline to access the resource with id $resourceId of type VariableGroup.

Example 3​

Set-VSTeamPipelineAuthorization -PipelineIds @(1,2,3) -ResourceId 34 -ResourceType Queue -Authorize $true

Authorizes the pipelines 1, 2 and 3 to access the resource 34 of type Queue (Agent Pool).

Example 4​

Set-VSTeamPipelineAuthorization -ResourceId $resourceId -ResourceType Repository -AuthorizeAll $true

Authorize all pipelines to access the resource with id $resourceId of type Repository.

PARAMETERS​

-Authorize​

Allows given pipelines to use the named resource

Type: Boolean
Parameter Sets: AuthorizeResource
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AuthorizeAll​

Removes any authorization restrictions for the given resource

Type: Boolean
Parameter Sets: AuthorizeAll
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PipelineIds​

List of pipeline Ids to authorize

Type: Int32[]
Parameter Sets: AuthorizeResource
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ResourceId​

Resource which the pipelines are authorized to use.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceType​

Resource type to authorize the pipeline on

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Queue, Endpoint, Environment, VariableGroup, SecureFile, Repository

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

-Confirm​

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf​

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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​

System.Int32[]​

OUTPUTS​

System.Object​

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