functions/generated/Policy/Get-AdsPolicyConfiguration.ps1
|
function Get-AdsPolicyConfiguration { <# .SYNOPSIS .DESCRIPTION Get a list of policy configurations in a project. The 'scope' parameter for this API should not be used, except for legacy compatability reasons. It returns specifically scoped policies and does not support heirarchical nesting. Instead, use the /_apis/git/policy/configurations API, which provides first class scope filtering support. The optional `policyType` parameter can be used to filter the set of policies returned from this method. .PARAMETER ContinuationToken The continuation token used for pagination. .PARAMETER ConfigurationId ID of the policy configuration .PARAMETER PolicyType Filter returned policies to only this type .PARAMETER Scope [Provided for legacy reasons] The scope on which a subset of policies is defined. .PARAMETER Top Maximum number of policies to return. .PARAMETER Project Project ID or project name .PARAMETER Organization The name of the Azure DevOps organization. .PARAMETER ApiVersion Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api. .EXAMPLE PS C:\> Get-AdsPolicyConfiguration -ConfigurationId $configurationid -Project $project -Organization $organization -ApiVersion $apiversion Get a policy configuration by its ID. .EXAMPLE PS C:\> Get-AdsPolicyConfiguration -Project $project -Organization $organization -ApiVersion $apiversion Get a list of policy configurations in a project. The 'scope' parameter for this API should not be used, except for legacy compatability reasons. It returns specifically scoped policies and does not support heirarchical nesting. Instead, use the /_apis/git/policy/configurations API, which provides first class scope filtering support. The optional `policyType` parameter can be used to filter the set of policies returned from this method. .LINK <unknown> #> [CmdletBinding(DefaultParameterSetName = 'default')] param ( [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $ContinuationToken, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Configurations_Get')] [string] $ConfigurationId, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $PolicyType, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $Scope, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [int32] $Top, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Configurations_Get')] [string] $Project, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Configurations_Get')] [string] $Organization, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Configurations_Get')] [string] $ApiVersion ) process { $__mapping = @{ 'ContinuationToken' = 'continuationToken' 'PolicyType' = 'policyType' 'Scope' = 'scope' 'Top' = '$top' 'ApiVersion' = 'api-version' } $__body = $PSBoundParameters | ConvertTo-Hashtable -Include @() -Mapping $__mapping $__query = $PSBoundParameters | ConvertTo-Hashtable -Include @('ContinuationToken','PolicyType','Scope','Top','ApiVersion') -Mapping $__mapping $__header = $PSBoundParameters | ConvertTo-Hashtable -Include @() -Mapping $__mapping $__path = 'https://dev.azure.com/{organization}/{project}/_apis/policy/configurations' -Replace '{project}',$Project -Replace '{organization}',$Organization if ($ConfigurationId) { $__path += "/$ConfigurationId" } Invoke-RestRequest -Path $__path -Method get -Body $__body -Query $__query -Header $__header } } |