AzureDevOpsDscNative

1.1.0

en-US/about_AzDoProcessWorkItemType.help.txt

.NAME
    AzDoProcessWorkItemType
 
.SYNOPSIS
    DSC resource for managing work item types on an Azure DevOps inherited process.
 
.DESCRIPTION
    Manages a work item type on an inherited process - either a custom type added to the process,
    or the customizable properties (description, colour, icon, disabled state) of a type inherited
    from the parent process.
 
.PARAMETER ProcessName
    Required - System.String
    The name of the inherited process.
 
.PARAMETER WorkItemTypeName
    Key - System.String
    The display name of the work item type, for example 'Incident'.
 
.PARAMETER Description
    Write - System.String
    A description for the work item type.
 
.PARAMETER Color
    Write - System.String
    The hex colour without a leading '#', for example 'F6546A'.
 
.PARAMETER Icon
    Write - System.String
    The icon name, for example 'iconbook' or 'iconflame'.
 
.PARAMETER IsDisabled
    Write - System.Boolean
    Whether the work item type is disabled - hidden from pickers without being deleted. Disabling
    is the reversible alternative to removal.
 
.PARAMETER AllowDestructiveRemove
    Write - System.Boolean
    Required for Ensure = 'Absent'. Removing a custom work item type deletes every work item of
    that type.
 
.EXAMPLE 1
 
This example adds a custom work item type to an inherited process.
 
Only inherited processes can be customized - the system processes (Agile, Scrum, Basic,
CMMI) are read-only, so an inherited process is created first.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoProcess 'ContosoAgile'
        {
            Ensure = 'Present'
            ProcessName = 'Contoso Agile'
            ParentProcessName = 'Agile'
            Description = 'Contoso customizations on top of Agile'
        }
 
        AzDoProcessWorkItemType 'Incident'
        {
            Ensure = 'Present'
            ProcessName = 'Contoso Agile'
            WorkItemTypeName = 'Incident'
            Description = 'A production incident'
            Color = 'F6546A'
            Icon = 'icon_flame'
            DependsOn = '[AzDoProcess]ContosoAgile'
        }
    }
}
 
.EXAMPLE 2
 
This example hides an inherited work item type without deleting it.
 
Disabling is the reversible alternative to removal: the type stops appearing in pickers
but existing work items and their history are untouched.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoProcessWorkItemType 'DisableImpediment'
        {
            Ensure = 'Present'
            ProcessName = 'Contoso Agile'
            WorkItemTypeName = 'Impediment'
            IsDisabled = $true
        }
    }
}
 
.EXAMPLE 3
 
This example removes a custom work item type.
 
This deletes every work item of that type in every project using the process, which is why
AllowDestructiveRemove is required. Prefer IsDisabled unless the type really must go.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoProcessWorkItemType 'RemoveIncident'
        {
            Ensure = 'Absent'
            ProcessName = 'Contoso Agile'
            WorkItemTypeName = 'Incident'
            AllowDestructiveRemove = $true
        }
    }
}