Get AzDevOpsBranchPolicy

Get-AzDevOpsBranchPolicy

SYNOPSIS

Get Azure DevOps branch policy for a branch in a repo

SYNTAX

Get-AzDevOpsBranchPolicy -PAT <String> [-TokenType <String>] -Organization <String> -Project <String>
 -Repository <String> -Branch <String> [<CommonParameters>]

DESCRIPTION

Get Azure DevOps branch policy for a branch in a repo using Azure DevOps Rest API

EXAMPLES

EXAMPLE 1

Get-AzDevOpsBranchPolicy -PAT $PAT -Organization $Organization -Project $Project -Repository $Repository -Branch $Branch

PARAMETERS

-PAT

Personal Access Token (PAT) for Azure DevOps

Type: String
Parameter Sets: (All)
Aliases:

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

-TokenType

Token Type for Azure DevOps, can be FullAccess, FineGrained or ReadOnly

Type: String
Parameter Sets: (All)
Aliases:

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

-Organization

Organization name for Azure DevOps

Type: String
Parameter Sets: (All)
Aliases:

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

-Project

Project name for Azure DevOps

Type: String
Parameter Sets: (All)
Aliases:

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

-Repository

Repository name for Azure DevOps

Type: String
Parameter Sets: (All)
Aliases:

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

-Branch

Branch name for Azure DevOps as a git ref. Example: refs/heads/main

Type: String
Parameter Sets: (All)
Aliases:

Required: True
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

OUTPUTS

System.Object[]

NOTES

This function returns an empty object if no branch policy is found for the branch

RELATED LINKS