Skip to content

AzDoRepositorySettings

github-actions[bot] edited this page Aug 19, 2026 · 4 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
ProjectName Key System.String
RepositoryName Required System.String
AllowNoFastForward Write System.Boolean
AllowRebaseMerge Write System.Boolean
AllowSquashMerge Write System.Boolean
DefaultBranch Write System.String
DisableForking Write System.Boolean
Ensure Write Ensure Present, Absent
LookupResult Read System.Collections.Hashtable

Description

Examples

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'
        }
    }
}

Commands

Resources

Clone this wiki locally