1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. WorkitemtrackingprocessSystemControl
Viewing docs for Azure DevOps v3.14.0
published on Tuesday, Mar 24, 2026 by Pulumi
azuredevops logo
Viewing docs for Azure DevOps v3.14.0
published on Tuesday, Mar 24, 2026 by Pulumi

    Manages a system control customization for a work item type.

    System controls are built-in controls like Area Path, Iteration Path, and Reason that can have their visibility and label customized. Unlike regular controls, system controls cannot be removed - only their display properties can be modified.

    Note: This resource modifies system controls. When the resource is deleted, the system control reverts to its default state rather than being removed.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azuredevops from "@pulumi/azuredevops";
    
    const example = new azuredevops.WorkitemtrackingprocessProcess("example", {
        name: "example-process",
        parentProcessTypeId: "adcc42ab-9882-485e-a3ed-7678f01f66bc",
    });
    const exampleWorkitemtrackingprocessWorkitemtype = new azuredevops.WorkitemtrackingprocessWorkitemtype("example", {
        processId: example.id,
        name: "example",
    });
    const exampleWorkitemtrackingprocessSystemControl = new azuredevops.WorkitemtrackingprocessSystemControl("example", {
        processId: example.id,
        workItemTypeId: exampleWorkitemtrackingprocessWorkitemtype.referenceName,
        controlId: "System.AreaPath",
        visible: false,
    });
    
    import pulumi
    import pulumi_azuredevops as azuredevops
    
    example = azuredevops.WorkitemtrackingprocessProcess("example",
        name="example-process",
        parent_process_type_id="adcc42ab-9882-485e-a3ed-7678f01f66bc")
    example_workitemtrackingprocess_workitemtype = azuredevops.WorkitemtrackingprocessWorkitemtype("example",
        process_id=example.id,
        name="example")
    example_workitemtrackingprocess_system_control = azuredevops.WorkitemtrackingprocessSystemControl("example",
        process_id=example.id,
        work_item_type_id=example_workitemtrackingprocess_workitemtype.reference_name,
        control_id="System.AreaPath",
        visible=False)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azuredevops/sdk/v3/go/azuredevops"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := azuredevops.NewWorkitemtrackingprocessProcess(ctx, "example", &azuredevops.WorkitemtrackingprocessProcessArgs{
    			Name:                pulumi.String("example-process"),
    			ParentProcessTypeId: pulumi.String("adcc42ab-9882-485e-a3ed-7678f01f66bc"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleWorkitemtrackingprocessWorkitemtype, err := azuredevops.NewWorkitemtrackingprocessWorkitemtype(ctx, "example", &azuredevops.WorkitemtrackingprocessWorkitemtypeArgs{
    			ProcessId: example.ID(),
    			Name:      pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = azuredevops.NewWorkitemtrackingprocessSystemControl(ctx, "example", &azuredevops.WorkitemtrackingprocessSystemControlArgs{
    			ProcessId:      example.ID(),
    			WorkItemTypeId: exampleWorkitemtrackingprocessWorkitemtype.ReferenceName,
    			ControlId:      pulumi.String("System.AreaPath"),
    			Visible:        pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureDevOps = Pulumi.AzureDevOps;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new AzureDevOps.WorkitemtrackingprocessProcess("example", new()
        {
            Name = "example-process",
            ParentProcessTypeId = "adcc42ab-9882-485e-a3ed-7678f01f66bc",
        });
    
        var exampleWorkitemtrackingprocessWorkitemtype = new AzureDevOps.WorkitemtrackingprocessWorkitemtype("example", new()
        {
            ProcessId = example.Id,
            Name = "example",
        });
    
        var exampleWorkitemtrackingprocessSystemControl = new AzureDevOps.WorkitemtrackingprocessSystemControl("example", new()
        {
            ProcessId = example.Id,
            WorkItemTypeId = exampleWorkitemtrackingprocessWorkitemtype.ReferenceName,
            ControlId = "System.AreaPath",
            Visible = false,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azuredevops.WorkitemtrackingprocessProcess;
    import com.pulumi.azuredevops.WorkitemtrackingprocessProcessArgs;
    import com.pulumi.azuredevops.WorkitemtrackingprocessWorkitemtype;
    import com.pulumi.azuredevops.WorkitemtrackingprocessWorkitemtypeArgs;
    import com.pulumi.azuredevops.WorkitemtrackingprocessSystemControl;
    import com.pulumi.azuredevops.WorkitemtrackingprocessSystemControlArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new WorkitemtrackingprocessProcess("example", WorkitemtrackingprocessProcessArgs.builder()
                .name("example-process")
                .parentProcessTypeId("adcc42ab-9882-485e-a3ed-7678f01f66bc")
                .build());
    
            var exampleWorkitemtrackingprocessWorkitemtype = new WorkitemtrackingprocessWorkitemtype("exampleWorkitemtrackingprocessWorkitemtype", WorkitemtrackingprocessWorkitemtypeArgs.builder()
                .processId(example.id())
                .name("example")
                .build());
    
            var exampleWorkitemtrackingprocessSystemControl = new WorkitemtrackingprocessSystemControl("exampleWorkitemtrackingprocessSystemControl", WorkitemtrackingprocessSystemControlArgs.builder()
                .processId(example.id())
                .workItemTypeId(exampleWorkitemtrackingprocessWorkitemtype.referenceName())
                .controlId("System.AreaPath")
                .visible(false)
                .build());
    
        }
    }
    
    resources:
      example:
        type: azuredevops:WorkitemtrackingprocessProcess
        properties:
          name: example-process
          parentProcessTypeId: adcc42ab-9882-485e-a3ed-7678f01f66bc
      exampleWorkitemtrackingprocessWorkitemtype:
        type: azuredevops:WorkitemtrackingprocessWorkitemtype
        name: example
        properties:
          processId: ${example.id}
          name: example
      exampleWorkitemtrackingprocessSystemControl:
        type: azuredevops:WorkitemtrackingprocessSystemControl
        name: example
        properties:
          processId: ${example.id}
          workItemTypeId: ${exampleWorkitemtrackingprocessWorkitemtype.referenceName}
          controlId: System.AreaPath
          visible: false
    

    Create WorkitemtrackingprocessSystemControl Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WorkitemtrackingprocessSystemControl(name: string, args: WorkitemtrackingprocessSystemControlArgs, opts?: CustomResourceOptions);
    @overload
    def WorkitemtrackingprocessSystemControl(resource_name: str,
                                             args: WorkitemtrackingprocessSystemControlArgs,
                                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkitemtrackingprocessSystemControl(resource_name: str,
                                             opts: Optional[ResourceOptions] = None,
                                             control_id: Optional[str] = None,
                                             process_id: Optional[str] = None,
                                             work_item_type_id: Optional[str] = None,
                                             label: Optional[str] = None,
                                             visible: Optional[bool] = None)
    func NewWorkitemtrackingprocessSystemControl(ctx *Context, name string, args WorkitemtrackingprocessSystemControlArgs, opts ...ResourceOption) (*WorkitemtrackingprocessSystemControl, error)
    public WorkitemtrackingprocessSystemControl(string name, WorkitemtrackingprocessSystemControlArgs args, CustomResourceOptions? opts = null)
    public WorkitemtrackingprocessSystemControl(String name, WorkitemtrackingprocessSystemControlArgs args)
    public WorkitemtrackingprocessSystemControl(String name, WorkitemtrackingprocessSystemControlArgs args, CustomResourceOptions options)
    
    type: azuredevops:WorkitemtrackingprocessSystemControl
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args WorkitemtrackingprocessSystemControlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WorkitemtrackingprocessSystemControlArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WorkitemtrackingprocessSystemControlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkitemtrackingprocessSystemControlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkitemtrackingprocessSystemControlArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var workitemtrackingprocessSystemControlResource = new AzureDevOps.WorkitemtrackingprocessSystemControl("workitemtrackingprocessSystemControlResource", new()
    {
        ControlId = "string",
        ProcessId = "string",
        WorkItemTypeId = "string",
        Label = "string",
        Visible = false,
    });
    
    example, err := azuredevops.NewWorkitemtrackingprocessSystemControl(ctx, "workitemtrackingprocessSystemControlResource", &azuredevops.WorkitemtrackingprocessSystemControlArgs{
    	ControlId:      pulumi.String("string"),
    	ProcessId:      pulumi.String("string"),
    	WorkItemTypeId: pulumi.String("string"),
    	Label:          pulumi.String("string"),
    	Visible:        pulumi.Bool(false),
    })
    
    var workitemtrackingprocessSystemControlResource = new WorkitemtrackingprocessSystemControl("workitemtrackingprocessSystemControlResource", WorkitemtrackingprocessSystemControlArgs.builder()
        .controlId("string")
        .processId("string")
        .workItemTypeId("string")
        .label("string")
        .visible(false)
        .build());
    
    workitemtrackingprocess_system_control_resource = azuredevops.WorkitemtrackingprocessSystemControl("workitemtrackingprocessSystemControlResource",
        control_id="string",
        process_id="string",
        work_item_type_id="string",
        label="string",
        visible=False)
    
    const workitemtrackingprocessSystemControlResource = new azuredevops.WorkitemtrackingprocessSystemControl("workitemtrackingprocessSystemControlResource", {
        controlId: "string",
        processId: "string",
        workItemTypeId: "string",
        label: "string",
        visible: false,
    });
    
    type: azuredevops:WorkitemtrackingprocessSystemControl
    properties:
        controlId: string
        label: string
        processId: string
        visible: false
        workItemTypeId: string
    

    WorkitemtrackingprocessSystemControl Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WorkitemtrackingprocessSystemControl resource accepts the following input properties:

    ControlId string
    The ID of the system control (e.g., System.AreaPath, System.IterationPath, System.Reason). Changing this forces a new resource to be created.
    ProcessId string
    The ID of the process. Changing this forces a new resource to be created.
    WorkItemTypeId string
    The ID (reference name) of the work item type. Changing this forces a new resource to be created.
    Label string
    Label for the control.
    Visible bool
    Whether the control should be visible. Defaults to true.
    ControlId string
    The ID of the system control (e.g., System.AreaPath, System.IterationPath, System.Reason). Changing this forces a new resource to be created.
    ProcessId string
    The ID of the process. Changing this forces a new resource to be created.
    WorkItemTypeId string
    The ID (reference name) of the work item type. Changing this forces a new resource to be created.
    Label string
    Label for the control.
    Visible bool
    Whether the control should be visible. Defaults to true.
    controlId String
    The ID of the system control (e.g., System.AreaPath, System.IterationPath, System.Reason). Changing this forces a new resource to be created.
    processId String
    The ID of the process. Changing this forces a new resource to be created.
    workItemTypeId String
    The ID (reference name) of the work item type. Changing this forces a new resource to be created.
    label String
    Label for the control.
    visible Boolean
    Whether the control should be visible. Defaults to true.
    controlId string
    The ID of the system control (e.g., System.AreaPath, System.IterationPath, System.Reason). Changing this forces a new resource to be created.
    processId string
    The ID of the process. Changing this forces a new resource to be created.
    workItemTypeId string
    The ID (reference name) of the work item type. Changing this forces a new resource to be created.
    label string
    Label for the control.
    visible boolean
    Whether the control should be visible. Defaults to true.
    control_id str
    The ID of the system control (e.g., System.AreaPath, System.IterationPath, System.Reason). Changing this forces a new resource to be created.
    process_id str
    The ID of the process. Changing this forces a new resource to be created.
    work_item_type_id str
    The ID (reference name) of the work item type. Changing this forces a new resource to be created.
    label str
    Label for the control.
    visible bool
    Whether the control should be visible. Defaults to true.
    controlId String
    The ID of the system control (e.g., System.AreaPath, System.IterationPath, System.Reason). Changing this forces a new resource to be created.
    processId String
    The ID of the process. Changing this forces a new resource to be created.
    workItemTypeId String
    The ID (reference name) of the work item type. Changing this forces a new resource to be created.
    label String
    Label for the control.
    visible Boolean
    Whether the control should be visible. Defaults to true.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkitemtrackingprocessSystemControl resource produces the following output properties:

    ControlType string
    Type of the control.
    Id string
    The provider-assigned unique ID for this managed resource.
    ReadOnly bool
    Whether the control is read-only.
    ControlType string
    Type of the control.
    Id string
    The provider-assigned unique ID for this managed resource.
    ReadOnly bool
    Whether the control is read-only.
    controlType String
    Type of the control.
    id String
    The provider-assigned unique ID for this managed resource.
    readOnly Boolean
    Whether the control is read-only.
    controlType string
    Type of the control.
    id string
    The provider-assigned unique ID for this managed resource.
    readOnly boolean
    Whether the control is read-only.
    control_type str
    Type of the control.
    id str
    The provider-assigned unique ID for this managed resource.
    read_only bool
    Whether the control is read-only.
    controlType String
    Type of the control.
    id String
    The provider-assigned unique ID for this managed resource.
    readOnly Boolean
    Whether the control is read-only.

    Look up Existing WorkitemtrackingprocessSystemControl Resource

    Get an existing WorkitemtrackingprocessSystemControl resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WorkitemtrackingprocessSystemControlState, opts?: CustomResourceOptions): WorkitemtrackingprocessSystemControl
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            control_id: Optional[str] = None,
            control_type: Optional[str] = None,
            label: Optional[str] = None,
            process_id: Optional[str] = None,
            read_only: Optional[bool] = None,
            visible: Optional[bool] = None,
            work_item_type_id: Optional[str] = None) -> WorkitemtrackingprocessSystemControl
    func GetWorkitemtrackingprocessSystemControl(ctx *Context, name string, id IDInput, state *WorkitemtrackingprocessSystemControlState, opts ...ResourceOption) (*WorkitemtrackingprocessSystemControl, error)
    public static WorkitemtrackingprocessSystemControl Get(string name, Input<string> id, WorkitemtrackingprocessSystemControlState? state, CustomResourceOptions? opts = null)
    public static WorkitemtrackingprocessSystemControl get(String name, Output<String> id, WorkitemtrackingprocessSystemControlState state, CustomResourceOptions options)
    resources:  _:    type: azuredevops:WorkitemtrackingprocessSystemControl    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ControlId string
    The ID of the system control (e.g., System.AreaPath, System.IterationPath, System.Reason). Changing this forces a new resource to be created.
    ControlType string
    Type of the control.
    Label string
    Label for the control.
    ProcessId string
    The ID of the process. Changing this forces a new resource to be created.
    ReadOnly bool
    Whether the control is read-only.
    Visible bool
    Whether the control should be visible. Defaults to true.
    WorkItemTypeId string
    The ID (reference name) of the work item type. Changing this forces a new resource to be created.
    ControlId string
    The ID of the system control (e.g., System.AreaPath, System.IterationPath, System.Reason). Changing this forces a new resource to be created.
    ControlType string
    Type of the control.
    Label string
    Label for the control.
    ProcessId string
    The ID of the process. Changing this forces a new resource to be created.
    ReadOnly bool
    Whether the control is read-only.
    Visible bool
    Whether the control should be visible. Defaults to true.
    WorkItemTypeId string
    The ID (reference name) of the work item type. Changing this forces a new resource to be created.
    controlId String
    The ID of the system control (e.g., System.AreaPath, System.IterationPath, System.Reason). Changing this forces a new resource to be created.
    controlType String
    Type of the control.
    label String
    Label for the control.
    processId String
    The ID of the process. Changing this forces a new resource to be created.
    readOnly Boolean
    Whether the control is read-only.
    visible Boolean
    Whether the control should be visible. Defaults to true.
    workItemTypeId String
    The ID (reference name) of the work item type. Changing this forces a new resource to be created.
    controlId string
    The ID of the system control (e.g., System.AreaPath, System.IterationPath, System.Reason). Changing this forces a new resource to be created.
    controlType string
    Type of the control.
    label string
    Label for the control.
    processId string
    The ID of the process. Changing this forces a new resource to be created.
    readOnly boolean
    Whether the control is read-only.
    visible boolean
    Whether the control should be visible. Defaults to true.
    workItemTypeId string
    The ID (reference name) of the work item type. Changing this forces a new resource to be created.
    control_id str
    The ID of the system control (e.g., System.AreaPath, System.IterationPath, System.Reason). Changing this forces a new resource to be created.
    control_type str
    Type of the control.
    label str
    Label for the control.
    process_id str
    The ID of the process. Changing this forces a new resource to be created.
    read_only bool
    Whether the control is read-only.
    visible bool
    Whether the control should be visible. Defaults to true.
    work_item_type_id str
    The ID (reference name) of the work item type. Changing this forces a new resource to be created.
    controlId String
    The ID of the system control (e.g., System.AreaPath, System.IterationPath, System.Reason). Changing this forces a new resource to be created.
    controlType String
    Type of the control.
    label String
    Label for the control.
    processId String
    The ID of the process. Changing this forces a new resource to be created.
    readOnly Boolean
    Whether the control is read-only.
    visible Boolean
    Whether the control should be visible. Defaults to true.
    workItemTypeId String
    The ID (reference name) of the work item type. Changing this forces a new resource to be created.

    Import

    System control customizations can be imported using the complete resource id process_id/work_item_type_id/control_id, e.g.

    $ pulumi import azuredevops:index/workitemtrackingprocessSystemControl:WorkitemtrackingprocessSystemControl example 00000000-0000-0000-0000-000000000000/MyProcess.CustomWorkItemType/System.AreaPath
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure DevOps pulumi/pulumi-azuredevops
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuredevops Terraform Provider.
    azuredevops logo
    Viewing docs for Azure DevOps v3.14.0
    published on Tuesday, Mar 24, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.