1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. WorkitemtrackingField
Viewing docs for Azure DevOps v3.14.0
published on Tuesday, Mar 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azuredevops

azuredevops.WorkitemtrackingField

azuredevops logo
Viewing docs for Azure DevOps v3.14.0
published on Tuesday, Mar 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azuredevops

    Manages a work item field in Azure DevOps.

    Note: Custom fields are created at the organization level, not the project level. The Azure DevOps API does not support project-scoped custom fields.

    Example Usage

    Basic Field

    import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const example = new azuredevops.WorkitemtrackingField("example", {
    name: "My Custom Field",
    referenceName: "Custom.MyCustomField",
    type: "string",
});

    import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.WorkitemtrackingField("example",
    name="My Custom Field",
    reference_name="Custom.MyCustomField",
    type="string")

    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 {
		_, err := azuredevops.NewWorkitemtrackingField(ctx, "example", &azuredevops.WorkitemtrackingFieldArgs{
			Name:          pulumi.String("My Custom Field"),
			ReferenceName: pulumi.String("Custom.MyCustomField"),
			Type:          pulumi.String("string"),
		})
		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.WorkitemtrackingField("example", new()
    {
        Name = "My Custom Field",
        ReferenceName = "Custom.MyCustomField",
        Type = "string",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.WorkitemtrackingField;
import com.pulumi.azuredevops.WorkitemtrackingFieldArgs;
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 WorkitemtrackingField("example", WorkitemtrackingFieldArgs.builder()
            .name("My Custom Field")
            .referenceName("Custom.MyCustomField")
            .type("string")
            .build());

    }
}

    resources:
  example:
    type: azuredevops:WorkitemtrackingField
    properties:
      name: My Custom Field
      referenceName: Custom.MyCustomField
      type: string

    Restore a Deleted Field

    import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const restored = new azuredevops.WorkitemtrackingField("restored", {
    name: "Restored Field",
    referenceName: "Custom.RestoredField",
    type: "string",
    restore: true,
});

    import pulumi
import pulumi_azuredevops as azuredevops

restored = azuredevops.WorkitemtrackingField("restored",
    name="Restored Field",
    reference_name="Custom.RestoredField",
    type="string",
    restore=True)

    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 {
		_, err := azuredevops.NewWorkitemtrackingField(ctx, "restored", &azuredevops.WorkitemtrackingFieldArgs{
			Name:          pulumi.String("Restored Field"),
			ReferenceName: pulumi.String("Custom.RestoredField"),
			Type:          pulumi.String("string"),
			Restore:       pulumi.Bool(true),
		})
		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 restored = new AzureDevOps.WorkitemtrackingField("restored", new()
    {
        Name = "Restored Field",
        ReferenceName = "Custom.RestoredField",
        Type = "string",
        Restore = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.WorkitemtrackingField;
import com.pulumi.azuredevops.WorkitemtrackingFieldArgs;
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 restored = new WorkitemtrackingField("restored", WorkitemtrackingFieldArgs.builder()
            .name("Restored Field")
            .referenceName("Custom.RestoredField")
            .type("string")
            .restore(true)
            .build());

    }
}

    resources:
  restored:
    type: azuredevops:WorkitemtrackingField
    properties:
      name: Restored Field
      referenceName: Custom.RestoredField
      type: string
      restore: true

    Create WorkitemtrackingField Resource

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

    Constructor syntax

    new WorkitemtrackingField(name: string, args: WorkitemtrackingFieldArgs, opts?: CustomResourceOptions);
    @overload
def WorkitemtrackingField(resource_name: str,
                          args: WorkitemtrackingFieldArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def WorkitemtrackingField(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          reference_name: Optional[str] = None,
                          type: Optional[str] = None,
                          description: Optional[str] = None,
                          is_locked: Optional[bool] = None,
                          is_picklist_suggested: Optional[bool] = None,
                          name: Optional[str] = None,
                          picklist_id: Optional[str] = None,
                          read_only: Optional[bool] = None,
                          restore: Optional[bool] = None,
                          usage: Optional[str] = None)
    func NewWorkitemtrackingField(ctx *Context, name string, args WorkitemtrackingFieldArgs, opts ...ResourceOption) (*WorkitemtrackingField, error)
    public WorkitemtrackingField(string name, WorkitemtrackingFieldArgs args, CustomResourceOptions? opts = null)
    public WorkitemtrackingField(String name, WorkitemtrackingFieldArgs args)
public WorkitemtrackingField(String name, WorkitemtrackingFieldArgs args, CustomResourceOptions options)

    type: azuredevops:WorkitemtrackingField
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 WorkitemtrackingFieldArgs
    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 WorkitemtrackingFieldArgs
    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 WorkitemtrackingFieldArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkitemtrackingFieldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkitemtrackingFieldArgs
    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 workitemtrackingFieldResource = new AzureDevOps.WorkitemtrackingField("workitemtrackingFieldResource", new()
{
    ReferenceName = "string",
    Type = "string",
    Description = "string",
    IsLocked = false,
    IsPicklistSuggested = false,
    Name = "string",
    PicklistId = "string",
    ReadOnly = false,
    Restore = false,
    Usage = "string",
});

    example, err := azuredevops.NewWorkitemtrackingField(ctx, "workitemtrackingFieldResource", &azuredevops.WorkitemtrackingFieldArgs{
	ReferenceName:       pulumi.String("string"),
	Type:                pulumi.String("string"),
	Description:         pulumi.String("string"),
	IsLocked:            pulumi.Bool(false),
	IsPicklistSuggested: pulumi.Bool(false),
	Name:                pulumi.String("string"),
	PicklistId:          pulumi.String("string"),
	ReadOnly:            pulumi.Bool(false),
	Restore:             pulumi.Bool(false),
	Usage:               pulumi.String("string"),
})

    var workitemtrackingFieldResource = new WorkitemtrackingField("workitemtrackingFieldResource", WorkitemtrackingFieldArgs.builder()
    .referenceName("string")
    .type("string")
    .description("string")
    .isLocked(false)
    .isPicklistSuggested(false)
    .name("string")
    .picklistId("string")
    .readOnly(false)
    .restore(false)
    .usage("string")
    .build());

    workitemtracking_field_resource = azuredevops.WorkitemtrackingField("workitemtrackingFieldResource",
    reference_name="string",
    type="string",
    description="string",
    is_locked=False,
    is_picklist_suggested=False,
    name="string",
    picklist_id="string",
    read_only=False,
    restore=False,
    usage="string")

    const workitemtrackingFieldResource = new azuredevops.WorkitemtrackingField("workitemtrackingFieldResource", {
    referenceName: "string",
    type: "string",
    description: "string",
    isLocked: false,
    isPicklistSuggested: false,
    name: "string",
    picklistId: "string",
    readOnly: false,
    restore: false,
    usage: "string",
});

    type: azuredevops:WorkitemtrackingField
properties:
    description: string
    isLocked: false
    isPicklistSuggested: false
    name: string
    picklistId: string
    readOnly: false
    referenceName: string
    restore: false
    type: string
    usage: string

    WorkitemtrackingField 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 WorkitemtrackingField resource accepts the following input properties:

    ReferenceName string
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    Type string
    The type of the field. Possible values: string, integer, dateTime, plainText, html, treePath, history, double, guid, boolean, identity. Changing this forces a new field to be created.
    Description string
    The description of the field. Changing this forces a new field to be created.
    IsLocked bool
    Indicates whether this field is locked for editing. Default: false.
    IsPicklistSuggested bool

    Indicates whether this field is a suggested picklist.

    Note: This field is kept for backwards compatibility, it should never be set as it is determined by the optional list referenced by picklist_id

    Name string
    The friendly name of the field. Changing this forces a new field to be created.
    PicklistId string
    The identifier of the picklist associated with this field, if applicable. Changing this forces a new field to be created.
    ReadOnly bool
    Indicates whether the field is read-only. Default: false. Changing this forces a new field to be created.
    Restore bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Set to true to restore a previously deleted field instead of creating a new one. When set to true, the resource will attempt to restore the field with the specified reference_name.
    Usage string
    The usage of the field. Possible values: none, workItem, workItemLink, tree, workItemTypeExtension. Default: workItem. Changing this forces a new field to be created.
    ReferenceName string
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    Type string
    The type of the field. Possible values: string, integer, dateTime, plainText, html, treePath, history, double, guid, boolean, identity. Changing this forces a new field to be created.
    Description string
    The description of the field. Changing this forces a new field to be created.
    IsLocked bool
    Indicates whether this field is locked for editing. Default: false.
    IsPicklistSuggested bool

    Indicates whether this field is a suggested picklist.

    Note: This field is kept for backwards compatibility, it should never be set as it is determined by the optional list referenced by picklist_id

    Name string
    The friendly name of the field. Changing this forces a new field to be created.
    PicklistId string
    The identifier of the picklist associated with this field, if applicable. Changing this forces a new field to be created.
    ReadOnly bool
    Indicates whether the field is read-only. Default: false. Changing this forces a new field to be created.
    Restore bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Set to true to restore a previously deleted field instead of creating a new one. When set to true, the resource will attempt to restore the field with the specified reference_name.
    Usage string
    The usage of the field. Possible values: none, workItem, workItemLink, tree, workItemTypeExtension. Default: workItem. Changing this forces a new field to be created.
    referenceName String
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    type String
    The type of the field. Possible values: string, integer, dateTime, plainText, html, treePath, history, double, guid, boolean, identity. Changing this forces a new field to be created.
    description String
    The description of the field. Changing this forces a new field to be created.
    isLocked Boolean
    Indicates whether this field is locked for editing. Default: false.
    isPicklistSuggested Boolean

    Indicates whether this field is a suggested picklist.

    Note: This field is kept for backwards compatibility, it should never be set as it is determined by the optional list referenced by picklist_id

    name String
    The friendly name of the field. Changing this forces a new field to be created.
    picklistId String
    The identifier of the picklist associated with this field, if applicable. Changing this forces a new field to be created.
    readOnly Boolean
    Indicates whether the field is read-only. Default: false. Changing this forces a new field to be created.
    restore Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Set to true to restore a previously deleted field instead of creating a new one. When set to true, the resource will attempt to restore the field with the specified reference_name.
    usage String
    The usage of the field. Possible values: none, workItem, workItemLink, tree, workItemTypeExtension. Default: workItem. Changing this forces a new field to be created.
    referenceName string
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    type string
    The type of the field. Possible values: string, integer, dateTime, plainText, html, treePath, history, double, guid, boolean, identity. Changing this forces a new field to be created.
    description string
    The description of the field. Changing this forces a new field to be created.
    isLocked boolean
    Indicates whether this field is locked for editing. Default: false.
    isPicklistSuggested boolean

    Indicates whether this field is a suggested picklist.

    Note: This field is kept for backwards compatibility, it should never be set as it is determined by the optional list referenced by picklist_id

    name string
    The friendly name of the field. Changing this forces a new field to be created.
    picklistId string
    The identifier of the picklist associated with this field, if applicable. Changing this forces a new field to be created.
    readOnly boolean
    Indicates whether the field is read-only. Default: false. Changing this forces a new field to be created.
    restore boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Set to true to restore a previously deleted field instead of creating a new one. When set to true, the resource will attempt to restore the field with the specified reference_name.
    usage string
    The usage of the field. Possible values: none, workItem, workItemLink, tree, workItemTypeExtension. Default: workItem. Changing this forces a new field to be created.
    reference_name str
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    type str
    The type of the field. Possible values: string, integer, dateTime, plainText, html, treePath, history, double, guid, boolean, identity. Changing this forces a new field to be created.
    description str
    The description of the field. Changing this forces a new field to be created.
    is_locked bool
    Indicates whether this field is locked for editing. Default: false.
    is_picklist_suggested bool

    Indicates whether this field is a suggested picklist.

    Note: This field is kept for backwards compatibility, it should never be set as it is determined by the optional list referenced by picklist_id

    name str
    The friendly name of the field. Changing this forces a new field to be created.
    picklist_id str
    The identifier of the picklist associated with this field, if applicable. Changing this forces a new field to be created.
    read_only bool
    Indicates whether the field is read-only. Default: false. Changing this forces a new field to be created.
    restore bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Set to true to restore a previously deleted field instead of creating a new one. When set to true, the resource will attempt to restore the field with the specified reference_name.
    usage str
    The usage of the field. Possible values: none, workItem, workItemLink, tree, workItemTypeExtension. Default: workItem. Changing this forces a new field to be created.
    referenceName String
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    type String
    The type of the field. Possible values: string, integer, dateTime, plainText, html, treePath, history, double, guid, boolean, identity. Changing this forces a new field to be created.
    description String
    The description of the field. Changing this forces a new field to be created.
    isLocked Boolean
    Indicates whether this field is locked for editing. Default: false.
    isPicklistSuggested Boolean

    Indicates whether this field is a suggested picklist.

    Note: This field is kept for backwards compatibility, it should never be set as it is determined by the optional list referenced by picklist_id

    name String
    The friendly name of the field. Changing this forces a new field to be created.
    picklistId String
    The identifier of the picklist associated with this field, if applicable. Changing this forces a new field to be created.
    readOnly Boolean
    Indicates whether the field is read-only. Default: false. Changing this forces a new field to be created.
    restore Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Set to true to restore a previously deleted field instead of creating a new one. When set to true, the resource will attempt to restore the field with the specified reference_name.
    usage String
    The usage of the field. Possible values: none, workItem, workItemLink, tree, workItemTypeExtension. Default: workItem. Changing this forces a new field to be created.

    Outputs

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

    CanSortBy bool
    Indicates whether the field can be sorted in server queries.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsIdentity bool
    Indicates whether this field is an identity field.
    IsPicklist bool
    Indicates whether this field is a picklist.
    IsQueryable bool
    Indicates whether the field can be queried in the server.
    SupportedOperations List<Pulumi.AzureDevOps.Outputs.WorkitemtrackingFieldSupportedOperation>
    The supported operations on this field. A supported_operations block as defined below.
    Url string
    The URL of the field resource.
    CanSortBy bool
    Indicates whether the field can be sorted in server queries.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsIdentity bool
    Indicates whether this field is an identity field.
    IsPicklist bool
    Indicates whether this field is a picklist.
    IsQueryable bool
    Indicates whether the field can be queried in the server.
    SupportedOperations []WorkitemtrackingFieldSupportedOperation
    The supported operations on this field. A supported_operations block as defined below.
    Url string
    The URL of the field resource.
    canSortBy Boolean
    Indicates whether the field can be sorted in server queries.
    id String
    The provider-assigned unique ID for this managed resource.
    isIdentity Boolean
    Indicates whether this field is an identity field.
    isPicklist Boolean
    Indicates whether this field is a picklist.
    isQueryable Boolean
    Indicates whether the field can be queried in the server.
    supportedOperations List<WorkitemtrackingFieldSupportedOperation>
    The supported operations on this field. A supported_operations block as defined below.
    url String
    The URL of the field resource.
    canSortBy boolean
    Indicates whether the field can be sorted in server queries.
    id string
    The provider-assigned unique ID for this managed resource.
    isIdentity boolean
    Indicates whether this field is an identity field.
    isPicklist boolean
    Indicates whether this field is a picklist.
    isQueryable boolean
    Indicates whether the field can be queried in the server.
    supportedOperations WorkitemtrackingFieldSupportedOperation[]
    The supported operations on this field. A supported_operations block as defined below.
    url string
    The URL of the field resource.
    can_sort_by bool
    Indicates whether the field can be sorted in server queries.
    id str
    The provider-assigned unique ID for this managed resource.
    is_identity bool
    Indicates whether this field is an identity field.
    is_picklist bool
    Indicates whether this field is a picklist.
    is_queryable bool
    Indicates whether the field can be queried in the server.
    supported_operations Sequence[WorkitemtrackingFieldSupportedOperation]
    The supported operations on this field. A supported_operations block as defined below.
    url str
    The URL of the field resource.
    canSortBy Boolean
    Indicates whether the field can be sorted in server queries.
    id String
    The provider-assigned unique ID for this managed resource.
    isIdentity Boolean
    Indicates whether this field is an identity field.
    isPicklist Boolean
    Indicates whether this field is a picklist.
    isQueryable Boolean
    Indicates whether the field can be queried in the server.
    supportedOperations List<Property Map>
    The supported operations on this field. A supported_operations block as defined below.
    url String
    The URL of the field resource.

    Look up Existing WorkitemtrackingField Resource

    Get an existing WorkitemtrackingField 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?: WorkitemtrackingFieldState, opts?: CustomResourceOptions): WorkitemtrackingField
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        can_sort_by: Optional[bool] = None,
        description: Optional[str] = None,
        is_identity: Optional[bool] = None,
        is_locked: Optional[bool] = None,
        is_picklist: Optional[bool] = None,
        is_picklist_suggested: Optional[bool] = None,
        is_queryable: Optional[bool] = None,
        name: Optional[str] = None,
        picklist_id: Optional[str] = None,
        read_only: Optional[bool] = None,
        reference_name: Optional[str] = None,
        restore: Optional[bool] = None,
        supported_operations: Optional[Sequence[WorkitemtrackingFieldSupportedOperationArgs]] = None,
        type: Optional[str] = None,
        url: Optional[str] = None,
        usage: Optional[str] = None) -> WorkitemtrackingField
    func GetWorkitemtrackingField(ctx *Context, name string, id IDInput, state *WorkitemtrackingFieldState, opts ...ResourceOption) (*WorkitemtrackingField, error)
    public static WorkitemtrackingField Get(string name, Input<string> id, WorkitemtrackingFieldState? state, CustomResourceOptions? opts = null)
    public static WorkitemtrackingField get(String name, Output<String> id, WorkitemtrackingFieldState state, CustomResourceOptions options)
    resources:  _:    type: azuredevops:WorkitemtrackingField    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:
    CanSortBy bool
    Indicates whether the field can be sorted in server queries.
    Description string
    The description of the field. Changing this forces a new field to be created.
    IsIdentity bool
    Indicates whether this field is an identity field.
    IsLocked bool
    Indicates whether this field is locked for editing. Default: false.
    IsPicklist bool
    Indicates whether this field is a picklist.
    IsPicklistSuggested bool

    Indicates whether this field is a suggested picklist.

    Note: This field is kept for backwards compatibility, it should never be set as it is determined by the optional list referenced by picklist_id

    IsQueryable bool
    Indicates whether the field can be queried in the server.
    Name string
    The friendly name of the field. Changing this forces a new field to be created.
    PicklistId string
    The identifier of the picklist associated with this field, if applicable. Changing this forces a new field to be created.
    ReadOnly bool
    Indicates whether the field is read-only. Default: false. Changing this forces a new field to be created.
    ReferenceName string
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    Restore bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Set to true to restore a previously deleted field instead of creating a new one. When set to true, the resource will attempt to restore the field with the specified reference_name.
    SupportedOperations List<Pulumi.AzureDevOps.Inputs.WorkitemtrackingFieldSupportedOperation>
    The supported operations on this field. A supported_operations block as defined below.
    Type string
    The type of the field. Possible values: string, integer, dateTime, plainText, html, treePath, history, double, guid, boolean, identity. Changing this forces a new field to be created.
    Url string
    The URL of the field resource.
    Usage string
    The usage of the field. Possible values: none, workItem, workItemLink, tree, workItemTypeExtension. Default: workItem. Changing this forces a new field to be created.
    CanSortBy bool
    Indicates whether the field can be sorted in server queries.
    Description string
    The description of the field. Changing this forces a new field to be created.
    IsIdentity bool
    Indicates whether this field is an identity field.
    IsLocked bool
    Indicates whether this field is locked for editing. Default: false.
    IsPicklist bool
    Indicates whether this field is a picklist.
    IsPicklistSuggested bool

    Indicates whether this field is a suggested picklist.

    Note: This field is kept for backwards compatibility, it should never be set as it is determined by the optional list referenced by picklist_id

    IsQueryable bool
    Indicates whether the field can be queried in the server.
    Name string
    The friendly name of the field. Changing this forces a new field to be created.
    PicklistId string
    The identifier of the picklist associated with this field, if applicable. Changing this forces a new field to be created.
    ReadOnly bool
    Indicates whether the field is read-only. Default: false. Changing this forces a new field to be created.
    ReferenceName string
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    Restore bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Set to true to restore a previously deleted field instead of creating a new one. When set to true, the resource will attempt to restore the field with the specified reference_name.
    SupportedOperations []WorkitemtrackingFieldSupportedOperationArgs
    The supported operations on this field. A supported_operations block as defined below.
    Type string
    The type of the field. Possible values: string, integer, dateTime, plainText, html, treePath, history, double, guid, boolean, identity. Changing this forces a new field to be created.
    Url string
    The URL of the field resource.
    Usage string
    The usage of the field. Possible values: none, workItem, workItemLink, tree, workItemTypeExtension. Default: workItem. Changing this forces a new field to be created.
    canSortBy Boolean
    Indicates whether the field can be sorted in server queries.
    description String
    The description of the field. Changing this forces a new field to be created.
    isIdentity Boolean
    Indicates whether this field is an identity field.
    isLocked Boolean
    Indicates whether this field is locked for editing. Default: false.
    isPicklist Boolean
    Indicates whether this field is a picklist.
    isPicklistSuggested Boolean

    Indicates whether this field is a suggested picklist.

    Note: This field is kept for backwards compatibility, it should never be set as it is determined by the optional list referenced by picklist_id

    isQueryable Boolean
    Indicates whether the field can be queried in the server.
    name String
    The friendly name of the field. Changing this forces a new field to be created.
    picklistId String
    The identifier of the picklist associated with this field, if applicable. Changing this forces a new field to be created.
    readOnly Boolean
    Indicates whether the field is read-only. Default: false. Changing this forces a new field to be created.
    referenceName String
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    restore Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Set to true to restore a previously deleted field instead of creating a new one. When set to true, the resource will attempt to restore the field with the specified reference_name.
    supportedOperations List<WorkitemtrackingFieldSupportedOperation>
    The supported operations on this field. A supported_operations block as defined below.
    type String
    The type of the field. Possible values: string, integer, dateTime, plainText, html, treePath, history, double, guid, boolean, identity. Changing this forces a new field to be created.
    url String
    The URL of the field resource.
    usage String
    The usage of the field. Possible values: none, workItem, workItemLink, tree, workItemTypeExtension. Default: workItem. Changing this forces a new field to be created.
    canSortBy boolean
    Indicates whether the field can be sorted in server queries.
    description string
    The description of the field. Changing this forces a new field to be created.
    isIdentity boolean
    Indicates whether this field is an identity field.
    isLocked boolean
    Indicates whether this field is locked for editing. Default: false.
    isPicklist boolean
    Indicates whether this field is a picklist.
    isPicklistSuggested boolean

    Indicates whether this field is a suggested picklist.

    Note: This field is kept for backwards compatibility, it should never be set as it is determined by the optional list referenced by picklist_id

    isQueryable boolean
    Indicates whether the field can be queried in the server.
    name string
    The friendly name of the field. Changing this forces a new field to be created.
    picklistId string
    The identifier of the picklist associated with this field, if applicable. Changing this forces a new field to be created.
    readOnly boolean
    Indicates whether the field is read-only. Default: false. Changing this forces a new field to be created.
    referenceName string
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    restore boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Set to true to restore a previously deleted field instead of creating a new one. When set to true, the resource will attempt to restore the field with the specified reference_name.
    supportedOperations WorkitemtrackingFieldSupportedOperation[]
    The supported operations on this field. A supported_operations block as defined below.
    type string
    The type of the field. Possible values: string, integer, dateTime, plainText, html, treePath, history, double, guid, boolean, identity. Changing this forces a new field to be created.
    url string
    The URL of the field resource.
    usage string
    The usage of the field. Possible values: none, workItem, workItemLink, tree, workItemTypeExtension. Default: workItem. Changing this forces a new field to be created.
    can_sort_by bool
    Indicates whether the field can be sorted in server queries.
    description str
    The description of the field. Changing this forces a new field to be created.
    is_identity bool
    Indicates whether this field is an identity field.
    is_locked bool
    Indicates whether this field is locked for editing. Default: false.
    is_picklist bool
    Indicates whether this field is a picklist.
    is_picklist_suggested bool

    Indicates whether this field is a suggested picklist.

    Note: This field is kept for backwards compatibility, it should never be set as it is determined by the optional list referenced by picklist_id

    is_queryable bool
    Indicates whether the field can be queried in the server.
    name str
    The friendly name of the field. Changing this forces a new field to be created.
    picklist_id str
    The identifier of the picklist associated with this field, if applicable. Changing this forces a new field to be created.
    read_only bool
    Indicates whether the field is read-only. Default: false. Changing this forces a new field to be created.
    reference_name str
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    restore bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Set to true to restore a previously deleted field instead of creating a new one. When set to true, the resource will attempt to restore the field with the specified reference_name.
    supported_operations Sequence[WorkitemtrackingFieldSupportedOperationArgs]
    The supported operations on this field. A supported_operations block as defined below.
    type str
    The type of the field. Possible values: string, integer, dateTime, plainText, html, treePath, history, double, guid, boolean, identity. Changing this forces a new field to be created.
    url str
    The URL of the field resource.
    usage str
    The usage of the field. Possible values: none, workItem, workItemLink, tree, workItemTypeExtension. Default: workItem. Changing this forces a new field to be created.
    canSortBy Boolean
    Indicates whether the field can be sorted in server queries.
    description String
    The description of the field. Changing this forces a new field to be created.
    isIdentity Boolean
    Indicates whether this field is an identity field.
    isLocked Boolean
    Indicates whether this field is locked for editing. Default: false.
    isPicklist Boolean
    Indicates whether this field is a picklist.
    isPicklistSuggested Boolean

    Indicates whether this field is a suggested picklist.

    Note: This field is kept for backwards compatibility, it should never be set as it is determined by the optional list referenced by picklist_id

    isQueryable Boolean
    Indicates whether the field can be queried in the server.
    name String
    The friendly name of the field. Changing this forces a new field to be created.
    picklistId String
    The identifier of the picklist associated with this field, if applicable. Changing this forces a new field to be created.
    readOnly Boolean
    Indicates whether the field is read-only. Default: false. Changing this forces a new field to be created.
    referenceName String
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    restore Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Set to true to restore a previously deleted field instead of creating a new one. When set to true, the resource will attempt to restore the field with the specified reference_name.
    supportedOperations List<Property Map>
    The supported operations on this field. A supported_operations block as defined below.
    type String
    The type of the field. Possible values: string, integer, dateTime, plainText, html, treePath, history, double, guid, boolean, identity. Changing this forces a new field to be created.
    url String
    The URL of the field resource.
    usage String
    The usage of the field. Possible values: none, workItem, workItemLink, tree, workItemTypeExtension. Default: workItem. Changing this forces a new field to be created.

    Supporting Types

    WorkitemtrackingFieldSupportedOperation, WorkitemtrackingFieldSupportedOperationArgs

    Name string
    The friendly name of the field. Changing this forces a new field to be created.
    ReferenceName string
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    Name string
    The friendly name of the field. Changing this forces a new field to be created.
    ReferenceName string
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    name String
    The friendly name of the field. Changing this forces a new field to be created.
    referenceName String
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    name string
    The friendly name of the field. Changing this forces a new field to be created.
    referenceName string
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    name str
    The friendly name of the field. Changing this forces a new field to be created.
    reference_name str
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.
    name String
    The friendly name of the field. Changing this forces a new field to be created.
    referenceName String
    The reference name of the field (e.g., Custom.MyField). Changing this forces a new field to be created.

    Import

    Fields can be imported using the reference name:

    $ pulumi import azuredevops:index/workitemtrackingField:WorkitemtrackingField example Custom.MyCustomField

    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
    Schema (JSON)
    pulumi/pulumi-azuredevops
      Try Pulumi Cloud free. Your team will thank you.