en-US/about_AzDoProcess.help.txt

.NAME
    AzDoProcess
 
.SYNOPSIS
    DSC resource for managing Azure DevOps inherited processes.
 
.DESCRIPTION
    The AzDoProcess resource creates and manages inherited processes (process templates) derived from an
    existing parent process. It inherits from the AzDevOpsDscResourceBase class. The parent process is
    immutable once the process is created and therefore has no Set support.
 
.PARAMETER ProcessName
    Key - System.String
    The name of the inherited process.
 
.PARAMETER ParentProcessName
    Required - System.String
    The name of the parent (system or custom) process to inherit from, e.g. 'Agile', 'Scrum', 'CMMI', 'Basic'.
 
.PARAMETER Description
    Write - System.String
    The description of the inherited process.
 
.EXAMPLE 1
 
This example creates an inherited process.
 
An inherited process is the prerequisite for any process customization: the system
processes (Agile, Scrum, Basic, CMMI) are read-only, so customizing work item types,
fields, states or rules means deriving a process first.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoProcess 'ContosoAgile'
        {
            Ensure = 'Present'
            ProcessName = 'Contoso Agile'
            ParentProcessName = 'Agile'
            Description = 'Agile process customised for Contoso'
        }
    }
}
 
.EXAMPLE 2
 
This example removes an inherited process.
 
A process still in use by a project cannot be deleted, and neither can a system process.
Move the projects to another process first.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoProcess 'RemoveContosoAgile'
        {
            Ensure = 'Absent'
            ProcessName = 'Contoso Agile'
        }
    }
}