en-US/about_AzDoPicklist.help.txt
|
.NAME
AzDoPicklist .SYNOPSIS DSC resource for managing Azure DevOps picklists. .DESCRIPTION Manages a picklist - the set of allowed values behind a custom field of type "picklist". .PARAMETER PicklistName Key - System.String The name of the picklist. .PARAMETER Items Write - System.String[] The complete set of allowed values, in the order they should appear. .PARAMETER PicklistType Write - System.String Allowed values: String, Integer 'String' or 'Integer'. Defaults to 'String'. The type is fixed at creation - changing it requires recreating the picklist, which this resource does not do implicitly. .PARAMETER IsSuggested Write - System.Boolean When true the list is a suggestion rather than a closed set, and users may enter values that are not on it. .EXAMPLE 1 This example creates a picklist - the allowed values behind a custom field of type "picklist". Picklists are organization-scoped, so one list can back fields in several processes. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoPicklist 'Severity' { Ensure = 'Present' PicklistName = 'Severity' Items = @('1 - Critical', '2 - High', '3 - Medium', '4 - Low') } } } .EXAMPLE 2 This example manages a picklist's values. Items are replaced wholesale - the update endpoint takes the complete list, so anything omitted is removed. Removing a value does not rewrite work items that already carry it; they keep it, and it then fails validation on the next edit. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoPicklist 'Severity' { Ensure = 'Present' PicklistName = 'Severity' Items = @('1 - Critical', '2 - High', '3 - Medium', '4 - Low', '5 - Trivial') IsSuggested = $false } } } |