en-US/about_AzDoProcessField.help.txt
|
.NAME
AzDoProcessField .SYNOPSIS DSC resource for managing fields on a work item type of an Azure DevOps inherited process. .DESCRIPTION Manages a field on a work item type: adding a new custom field, attaching an existing field (including a system field such as System.Priority), and the per-type settings - required, default value and read-only. .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 FieldName Key - System.String The display name of the field. .PARAMETER FieldReferenceName Write - System.String The reference name of an existing field to attach, for example 'System.Priority'. Omit when creating a new custom field. .PARAMETER FieldType Write - System.String Allowed values: string, integer, boolean, dateTime, html, picklistString, picklistInteger, identity, double, plainText, treePath The field type for a new custom field: 'string', 'integer', 'boolean', 'dateTime', 'html', 'picklistString', 'picklistInteger', 'identity', 'double', 'plainText' or 'treePath'. .PARAMETER PicklistName Write - System.String The name of the picklist backing a picklist-typed field. Declare it with AzDoPicklist and use DependsOn. .PARAMETER IsRequired Write - System.Boolean Whether the field is required on this work item type. .PARAMETER DefaultValue Write - System.String The default value for the field on this work item type. .PARAMETER ReadOnly Write - System.Boolean Whether the field is read-only on this work item type. .EXAMPLE 1 This example adds a picklist-backed custom field to a work item type. The picklist is declared first: a picklist-typed field needs a list to point at, so the field resource depends on it. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoPicklist 'Severity' { Ensure = 'Present' PicklistName = 'Severity' Items = @('1 - Critical', '2 - High', '3 - Medium', '4 - Low') } AzDoProcessField 'IncidentSeverity' { Ensure = 'Present' ProcessName = 'Contoso Agile' WorkItemTypeName = 'Incident' FieldName = 'Severity' FieldType = 'picklistString' PicklistName = 'Severity' IsRequired = $true DependsOn = '[AzDoPicklist]Severity' } } } .EXAMPLE 2 This example attaches an existing field to a work item type rather than creating a new one. Supplying FieldReferenceName addresses a field that already exists in the organization - including a system field such as System.Priority. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoProcessField 'IncidentPriority' { Ensure = 'Present' ProcessName = 'Contoso Agile' WorkItemTypeName = 'Incident' FieldName = 'Priority' FieldReferenceName = 'Microsoft.VSTS.Common.Priority' IsRequired = $true DefaultValue = '2' } } } |