en-US/about_AzDoProcessState.help.txt

.NAME
    AzDoProcessState
 
.SYNOPSIS
    DSC resource for managing workflow states on a work item type of an Azure DevOps inherited process.
 
.DESCRIPTION
    Manages a custom workflow state on a work item type - its category, colour and order.
 
.PARAMETER ProcessName
    Required - System.String
    The name of the inherited process.
 
.PARAMETER WorkItemTypeName
    Required - System.String
    The display name of the work item type.
 
.PARAMETER StateName
    Key - System.String
    The name of the state.
 
.PARAMETER StateCategory
    Write - System.String
    Allowed values: Proposed, InProgress, Resolved, Completed, Removed
    'Proposed', 'InProgress', 'Resolved', 'Completed' or 'Removed'.
 
.PARAMETER Color
    Write - System.String
    The hex colour without a leading '#'.
 
.PARAMETER Order
    Write - System.Int32
    The position of the state within its category.
 
.EXAMPLE 1
 
This example adds a custom workflow state to a work item type.
 
The category is what matters: boards, cumulative flow diagrams and Analytics all reason
about categories rather than state names.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoProcessState 'Triaged'
        {
            Ensure = 'Present'
            ProcessName = 'Contoso Agile'
            WorkItemTypeName = 'Incident'
            StateName = 'Triaged'
            StateCategory = 'InProgress'
            Color = '007ACC'
            Order = 2
        }
    }
}