en-US/about_AzDoRepositorySettings.help.txt

.NAME
    AzDoRepositorySettings
 
.SYNOPSIS
    DSC resource for managing per-repository settings (singleton).
 
.DESCRIPTION
 
 
.PARAMETER ProjectName
    Key - System.String
 
.PARAMETER RepositoryName
    Required - System.String
 
.PARAMETER DefaultBranch
    Write - System.String
 
.PARAMETER AllowSquashMerge
    Write - System.Boolean
 
.PARAMETER AllowRebaseMerge
    Write - System.Boolean
 
.PARAMETER AllowNoFastForward
    Write - System.Boolean
 
.PARAMETER DisableForking
    Write - System.Boolean
 
.EXAMPLE 1
 
This example shows how to configure repository settings in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoRepositorySettings 'AddAzDoRepositorySettings'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            RepositoryName = 'MyRepository'
            DefaultBranch = 'main'
            AllowSquashMerge = $true
            AllowRebaseMerge = $true
            AllowNoFastForward = $true
            DisableForking = $false
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update repository settings to restrict merge strategies.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoRepositorySettings 'UpdateAzDoRepositorySettings'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            RepositoryName = 'MyRepository'
            DefaultBranch = 'main'
            AllowSquashMerge = $true
            AllowRebaseMerge = $false
            AllowNoFastForward = $false
            DisableForking = $true
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to reset repository settings to defaults in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoRepositorySettings 'RemoveAzDoRepositorySettings'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            RepositoryName = 'MyRepository'
        }
    }
}