AzureDevOpsDscNative

1.0.0-preview02

en-US/about_AzDoPipeline.help.txt

.NAME
    AzDoPipeline
 
.SYNOPSIS
    DSC resource for managing Azure DevOps YAML pipelines.
 
.DESCRIPTION
    The AzDoPipeline class manages YAML pipeline definitions within an
    Azure DevOps project.
 
.PARAMETER ProjectName
    Key - System.String
    The Azure DevOps project name.
 
.PARAMETER PipelineName
    Required - System.String
    The name of the pipeline.
 
.PARAMETER RepositoryName
    Required - System.String
    The Git repository that contains the YAML file.
 
.PARAMETER YamlPath
    Required - System.String
    The path to the YAML pipeline definition file.
 
.PARAMETER FolderPath
    Write - System.String
    The folder path under which the pipeline is organised. Default is '\'.
 
.PARAMETER DefaultBranch
    Write - System.String
    The default branch for the pipeline. Default is 'main'.
 
.EXAMPLE 1
 
This example shows how to create a pipeline in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoPipeline 'AddAzDoPipeline'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            PipelineName = 'MyBuildPipeline'
            RepositoryName = 'MyRepository'
            YamlPath = '.azurepipelines/build.yml'
            FolderPath = '\'
            DefaultBranch = 'main'
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update a pipeline in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoPipeline 'UpdateAzDoPipeline'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            PipelineName = 'MyBuildPipeline'
            RepositoryName = 'MyRepository'
            YamlPath = '.azurepipelines/build.yml'
            FolderPath = '\Build'
            DefaultBranch = 'develop'
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove a pipeline from an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoPipeline 'RemoveAzDoPipeline'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            PipelineName = 'MyBuildPipeline'
            RepositoryName = 'MyRepository'
            YamlPath = '.azurepipelines/build.yml'
        }
    }
}