Azure DevOps v3.8.0, Mar 17 25

Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi

azuredevops.getBuildDefinition

Explore with Pulumi AI

Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = azuredevops.getProject({
    name: "Example Project",
});
const exampleGetBuildDefinition = example.then(example => azuredevops.getBuildDefinition({
    projectId: example.id,
    name: "existing",
}));
export const id = exampleGetBuildDefinition.then(exampleGetBuildDefinition => exampleGetBuildDefinition.id);

import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.get_project(name="Example Project")
example_get_build_definition = azuredevops.get_build_definition(project_id=example.id,
    name="existing")
pulumi.export("id", example_get_build_definition.id)

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.LookupProject(ctx, &azuredevops.LookupProjectArgs{
			Name: pulumi.StringRef("Example Project"),
		}, nil)
		if err != nil {
			return err
		}
		exampleGetBuildDefinition, err := azuredevops.LookupBuildDefinition(ctx, &azuredevops.LookupBuildDefinitionArgs{
			ProjectId: example.Id,
			Name:      "existing",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", exampleGetBuildDefinition.Id)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var example = AzureDevOps.GetProject.Invoke(new()
    {
        Name = "Example Project",
    });

    var exampleGetBuildDefinition = AzureDevOps.GetBuildDefinition.Invoke(new()
    {
        ProjectId = example.Apply(getProjectResult => getProjectResult.Id),
        Name = "existing",
    });

    return new Dictionary<string, object?>
    {
        ["id"] = exampleGetBuildDefinition.Apply(getBuildDefinitionResult => getBuildDefinitionResult.Id),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.AzuredevopsFunctions;
import com.pulumi.azuredevops.inputs.GetProjectArgs;
import com.pulumi.azuredevops.inputs.GetBuildDefinitionArgs;
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) {
        final var example = AzuredevopsFunctions.getProject(GetProjectArgs.builder()
            .name("Example Project")
            .build());

        final var exampleGetBuildDefinition = AzuredevopsFunctions.getBuildDefinition(GetBuildDefinitionArgs.builder()
            .projectId(example.applyValue(getProjectResult -> getProjectResult.id()))
            .name("existing")
            .build());

        ctx.export("id", exampleGetBuildDefinition.applyValue(getBuildDefinitionResult -> getBuildDefinitionResult.id()));
    }
}

variables:
  example:
    fn::invoke:
      function: azuredevops:getProject
      arguments:
        name: Example Project
  exampleGetBuildDefinition:
    fn::invoke:
      function: azuredevops:getBuildDefinition
      arguments:
        projectId: ${example.id}
        name: existing
outputs:
  id: ${exampleGetBuildDefinition.id}

Using getBuildDefinition

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getBuildDefinition(args: GetBuildDefinitionArgs, opts?: InvokeOptions): Promise<GetBuildDefinitionResult>
function getBuildDefinitionOutput(args: GetBuildDefinitionOutputArgs, opts?: InvokeOptions): Output<GetBuildDefinitionResult>

def get_build_definition(name: Optional[str] = None,
                         path: Optional[str] = None,
                         project_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetBuildDefinitionResult
def get_build_definition_output(name: Optional[pulumi.Input[str]] = None,
                         path: Optional[pulumi.Input[str]] = None,
                         project_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetBuildDefinitionResult]

func LookupBuildDefinition(ctx *Context, args *LookupBuildDefinitionArgs, opts ...InvokeOption) (*LookupBuildDefinitionResult, error)
func LookupBuildDefinitionOutput(ctx *Context, args *LookupBuildDefinitionOutputArgs, opts ...InvokeOption) LookupBuildDefinitionResultOutput

> Note: This function is named LookupBuildDefinition in the Go SDK.

public static class GetBuildDefinition 
{
    public static Task<GetBuildDefinitionResult> InvokeAsync(GetBuildDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetBuildDefinitionResult> Invoke(GetBuildDefinitionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBuildDefinitionResult> getBuildDefinition(GetBuildDefinitionArgs args, InvokeOptions options)
public static Output<GetBuildDefinitionResult> getBuildDefinition(GetBuildDefinitionArgs args, InvokeOptions options)

fn::invoke:
  function: azuredevops:index/getBuildDefinition:getBuildDefinition
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of this Build Definition.
ProjectId string: The ID of the project.
Path string: The path of the build definition. Default to \.

Name string: The name of this Build Definition.
ProjectId string: The ID of the project.
Path string: The path of the build definition. Default to \.

name String: The name of this Build Definition.
projectId String: The ID of the project.
path String: The path of the build definition. Default to \.

name string: The name of this Build Definition.
projectId string: The ID of the project.
path string: The path of the build definition. Default to \.

name str: The name of this Build Definition.
project_id str: The ID of the project.
path str: The path of the build definition. Default to \.

name String: The name of this Build Definition.
projectId String: The ID of the project.
path String: The path of the build definition. Default to \.

getBuildDefinition Result

The following output properties are available:

AgentPoolName string: The agent pool that should execute the build.
AgentSpecification string: The Agent Specification to run the pipelines. Example: windows-2019, windows-latest, macos-13 etc.
CiTriggers List<Pulumi.AzureDevOps.Outputs.GetBuildDefinitionCiTrigger>: A ci_trigger block as defined below.
Id string: The provider-assigned unique ID for this managed resource.
JobAuthorizationScope string: The job authorization scope for builds queued against this definition.
Jobs List<Pulumi.AzureDevOps.Outputs.GetBuildDefinitionJob>: A jobs blocks as documented below.
Name string: The name of the variable.
ProjectId string
PullRequestTriggers List<Pulumi.AzureDevOps.Outputs.GetBuildDefinitionPullRequestTrigger>: A pull_request_trigger block as defined below.
QueueStatus string: The queue status of the build definition.
Repositories List<Pulumi.AzureDevOps.Outputs.GetBuildDefinitionRepository>: A repository block as defined below.
Revision int: The revision of the build definition.
Schedules List<Pulumi.AzureDevOps.Outputs.GetBuildDefinitionSchedule>: A schedules block as defined below.
VariableGroups List<int>: A list of variable group IDs.
Variables List<Pulumi.AzureDevOps.Outputs.GetBuildDefinitionVariable>: A variable block as defined below.
Path string

AgentPoolName string: The agent pool that should execute the build.
AgentSpecification string: The Agent Specification to run the pipelines. Example: windows-2019, windows-latest, macos-13 etc.
CiTriggers []GetBuildDefinitionCiTrigger: A ci_trigger block as defined below.
Id string: The provider-assigned unique ID for this managed resource.
JobAuthorizationScope string: The job authorization scope for builds queued against this definition.
Jobs []GetBuildDefinitionJob: A jobs blocks as documented below.
Name string: The name of the variable.
ProjectId string
PullRequestTriggers []GetBuildDefinitionPullRequestTrigger: A pull_request_trigger block as defined below.
QueueStatus string: The queue status of the build definition.
Repositories []GetBuildDefinitionRepository: A repository block as defined below.
Revision int: The revision of the build definition.
Schedules []GetBuildDefinitionSchedule: A schedules block as defined below.
VariableGroups []int: A list of variable group IDs.
Variables []GetBuildDefinitionVariable: A variable block as defined below.
Path string

agentPoolName String: The agent pool that should execute the build.
agentSpecification String: The Agent Specification to run the pipelines. Example: windows-2019, windows-latest, macos-13 etc.
ciTriggers List<GetBuildDefinitionCiTrigger>: A ci_trigger block as defined below.
id String: The provider-assigned unique ID for this managed resource.
jobAuthorizationScope String: The job authorization scope for builds queued against this definition.
jobs List<GetBuildDefinitionJob>: A jobs blocks as documented below.
name String: The name of the variable.
projectId String
pullRequestTriggers List<GetBuildDefinitionPullRequestTrigger>: A pull_request_trigger block as defined below.
queueStatus String: The queue status of the build definition.
repositories List<GetBuildDefinitionRepository>: A repository block as defined below.
revision Integer: The revision of the build definition.
schedules List<GetBuildDefinitionSchedule>: A schedules block as defined below.
variableGroups List<Integer>: A list of variable group IDs.
variables List<GetBuildDefinitionVariable>: A variable block as defined below.
path String

agentPoolName string: The agent pool that should execute the build.
agentSpecification string: The Agent Specification to run the pipelines. Example: windows-2019, windows-latest, macos-13 etc.
ciTriggers GetBuildDefinitionCiTrigger[]: A ci_trigger block as defined below.
id string: The provider-assigned unique ID for this managed resource.
jobAuthorizationScope string: The job authorization scope for builds queued against this definition.
jobs GetBuildDefinitionJob[]: A jobs blocks as documented below.
name string: The name of the variable.
projectId string
pullRequestTriggers GetBuildDefinitionPullRequestTrigger[]: A pull_request_trigger block as defined below.
queueStatus string: The queue status of the build definition.
repositories GetBuildDefinitionRepository[]: A repository block as defined below.
revision number: The revision of the build definition.
schedules GetBuildDefinitionSchedule[]: A schedules block as defined below.
variableGroups number[]: A list of variable group IDs.
variables GetBuildDefinitionVariable[]: A variable block as defined below.
path string

agent_pool_name str: The agent pool that should execute the build.
agent_specification str: The Agent Specification to run the pipelines. Example: windows-2019, windows-latest, macos-13 etc.
ci_triggers Sequence[GetBuildDefinitionCiTrigger]: A ci_trigger block as defined below.
id str: The provider-assigned unique ID for this managed resource.
job_authorization_scope str: The job authorization scope for builds queued against this definition.
jobs Sequence[GetBuildDefinitionJob]: A jobs blocks as documented below.
name str: The name of the variable.
project_id str
pull_request_triggers Sequence[GetBuildDefinitionPullRequestTrigger]: A pull_request_trigger block as defined below.
queue_status str: The queue status of the build definition.
repositories Sequence[GetBuildDefinitionRepository]: A repository block as defined below.
revision int: The revision of the build definition.
schedules Sequence[GetBuildDefinitionSchedule]: A schedules block as defined below.
variable_groups Sequence[int]: A list of variable group IDs.
variables Sequence[GetBuildDefinitionVariable]: A variable block as defined below.
path str

agentPoolName String: The agent pool that should execute the build.
agentSpecification String: The Agent Specification to run the pipelines. Example: windows-2019, windows-latest, macos-13 etc.
ciTriggers List<Property Map>: A ci_trigger block as defined below.
id String: The provider-assigned unique ID for this managed resource.
jobAuthorizationScope String: The job authorization scope for builds queued against this definition.
jobs List<Property Map>: A jobs blocks as documented below.
name String: The name of the variable.
projectId String
pullRequestTriggers List<Property Map>: A pull_request_trigger block as defined below.
queueStatus String: The queue status of the build definition.
repositories List<Property Map>: A repository block as defined below.
revision Number: The revision of the build definition.
schedules List<Property Map>: A schedules block as defined below.
variableGroups List<Number>: A list of variable group IDs.
variables List<Property Map>: A variable block as defined below.
path String

Supporting Types

GetBuildDefinitionCiTrigger

Overrides List<Pulumi.AzureDevOps.Inputs.GetBuildDefinitionCiTriggerOverride>: A override block as defined below.
UseYaml bool: Use the azure-pipeline file for the build configuration.

Overrides []GetBuildDefinitionCiTriggerOverride: A override block as defined below.
UseYaml bool: Use the azure-pipeline file for the build configuration.

overrides List<GetBuildDefinitionCiTriggerOverride>: A override block as defined below.
useYaml Boolean: Use the azure-pipeline file for the build configuration.

overrides GetBuildDefinitionCiTriggerOverride[]: A override block as defined below.
useYaml boolean: Use the azure-pipeline file for the build configuration.

overrides Sequence[GetBuildDefinitionCiTriggerOverride]: A override block as defined below.
use_yaml bool: Use the azure-pipeline file for the build configuration.

overrides List<Property Map>: A override block as defined below.
useYaml Boolean: Use the azure-pipeline file for the build configuration.

GetBuildDefinitionCiTriggerOverride

Batch bool: If batch is true, when a pipeline is running, the system waits until the run is completed, then starts another run with all changes that have not yet been built.
BranchFilters List<Pulumi.AzureDevOps.Inputs.GetBuildDefinitionCiTriggerOverrideBranchFilter>: A branch_filter block as defined above.
MaxConcurrentBuildsPerBranch int: The number of max builds per branch.
PathFilters List<Pulumi.AzureDevOps.Inputs.GetBuildDefinitionCiTriggerOverridePathFilter>: The file paths to include or exclude. A path_filter block as defined above.
PollingInterval int: How often the external repository is polled.
PollingJobId string: This is the ID of the polling job that polls the external repository. Once the build definition is saved/updated, this value is set.

Batch bool: If batch is true, when a pipeline is running, the system waits until the run is completed, then starts another run with all changes that have not yet been built.
BranchFilters []GetBuildDefinitionCiTriggerOverrideBranchFilter: A branch_filter block as defined above.
MaxConcurrentBuildsPerBranch int: The number of max builds per branch.
PathFilters []GetBuildDefinitionCiTriggerOverridePathFilter: The file paths to include or exclude. A path_filter block as defined above.
PollingInterval int: How often the external repository is polled.
PollingJobId string: This is the ID of the polling job that polls the external repository. Once the build definition is saved/updated, this value is set.

batch Boolean: If batch is true, when a pipeline is running, the system waits until the run is completed, then starts another run with all changes that have not yet been built.
branchFilters List<GetBuildDefinitionCiTriggerOverrideBranchFilter>: A branch_filter block as defined above.
maxConcurrentBuildsPerBranch Integer: The number of max builds per branch.
pathFilters List<GetBuildDefinitionCiTriggerOverridePathFilter>: The file paths to include or exclude. A path_filter block as defined above.
pollingInterval Integer: How often the external repository is polled.
pollingJobId String: This is the ID of the polling job that polls the external repository. Once the build definition is saved/updated, this value is set.

batch boolean: If batch is true, when a pipeline is running, the system waits until the run is completed, then starts another run with all changes that have not yet been built.
branchFilters GetBuildDefinitionCiTriggerOverrideBranchFilter[]: A branch_filter block as defined above.
maxConcurrentBuildsPerBranch number: The number of max builds per branch.
pathFilters GetBuildDefinitionCiTriggerOverridePathFilter[]: The file paths to include or exclude. A path_filter block as defined above.
pollingInterval number: How often the external repository is polled.
pollingJobId string: This is the ID of the polling job that polls the external repository. Once the build definition is saved/updated, this value is set.

batch bool: If batch is true, when a pipeline is running, the system waits until the run is completed, then starts another run with all changes that have not yet been built.
branch_filters Sequence[GetBuildDefinitionCiTriggerOverrideBranchFilter]: A branch_filter block as defined above.
max_concurrent_builds_per_branch int: The number of max builds per branch.
path_filters Sequence[GetBuildDefinitionCiTriggerOverridePathFilter]: The file paths to include or exclude. A path_filter block as defined above.
polling_interval int: How often the external repository is polled.
polling_job_id str: This is the ID of the polling job that polls the external repository. Once the build definition is saved/updated, this value is set.

batch Boolean: If batch is true, when a pipeline is running, the system waits until the run is completed, then starts another run with all changes that have not yet been built.
branchFilters List<Property Map>: A branch_filter block as defined above.
maxConcurrentBuildsPerBranch Number: The number of max builds per branch.
pathFilters List<Property Map>: The file paths to include or exclude. A path_filter block as defined above.
pollingInterval Number: How often the external repository is polled.
pollingJobId String: This is the ID of the polling job that polls the external repository. Once the build definition is saved/updated, this value is set.

GetBuildDefinitionCiTriggerOverrideBranchFilter

Excludes List<string>: (Optional) List of path patterns to exclude.
Includes List<string>: (Optional) List of path patterns to include.

Excludes []string: (Optional) List of path patterns to exclude.
Includes []string: (Optional) List of path patterns to include.

excludes List<String>: (Optional) List of path patterns to exclude.
includes List<String>: (Optional) List of path patterns to include.

excludes string[]: (Optional) List of path patterns to exclude.
includes string[]: (Optional) List of path patterns to include.

excludes Sequence[str]: (Optional) List of path patterns to exclude.
includes Sequence[str]: (Optional) List of path patterns to include.

excludes List<String>: (Optional) List of path patterns to exclude.
includes List<String>: (Optional) List of path patterns to include.

GetBuildDefinitionCiTriggerOverridePathFilter

Excludes List<string>: (Optional) List of path patterns to exclude.
Includes List<string>: (Optional) List of path patterns to include.

Excludes []string: (Optional) List of path patterns to exclude.
Includes []string: (Optional) List of path patterns to include.

excludes List<String>: (Optional) List of path patterns to exclude.
includes List<String>: (Optional) List of path patterns to include.

excludes string[]: (Optional) List of path patterns to exclude.
includes string[]: (Optional) List of path patterns to include.

excludes Sequence[str]: (Optional) List of path patterns to exclude.
includes Sequence[str]: (Optional) List of path patterns to include.

excludes List<String>: (Optional) List of path patterns to exclude.
includes List<String>: (Optional) List of path patterns to include.

GetBuildDefinitionJob

AllowScriptsAuthAccessOption bool: Enables scripts and other processes launched by tasks to access the OAuth token through the System.AccessToken variable.
Condition string: Specifies when this job should run. Can Custom conditions to specify more complex conditions. More details: Pipeline conditions
Dependencies List<Pulumi.AzureDevOps.Inputs.GetBuildDefinitionJobDependency>: A dependencies blocks as documented below. Define the job dependencies.
JobAuthorizationScope string: The job authorization scope for builds queued against this definition.
JobCancelTimeoutInMinutes int: The job cancel timeout (in minutes) for builds cancelled by user for this definition.
JobTimeoutInMinutes int: The job execution timeout (in minutes) for builds queued against this definition.
Name string: The name of this Build Definition.
RefName string: The reference name of the job, can be used to define the job dependencies.
Targets List<Pulumi.AzureDevOps.Inputs.GetBuildDefinitionJobTarget>: A target blocks as documented below.

AllowScriptsAuthAccessOption bool: Enables scripts and other processes launched by tasks to access the OAuth token through the System.AccessToken variable.
Condition string: Specifies when this job should run. Can Custom conditions to specify more complex conditions. More details: Pipeline conditions
Dependencies []GetBuildDefinitionJobDependency: A dependencies blocks as documented below. Define the job dependencies.
JobAuthorizationScope string: The job authorization scope for builds queued against this definition.
JobCancelTimeoutInMinutes int: The job cancel timeout (in minutes) for builds cancelled by user for this definition.
JobTimeoutInMinutes int: The job execution timeout (in minutes) for builds queued against this definition.
Name string: The name of this Build Definition.
RefName string: The reference name of the job, can be used to define the job dependencies.
Targets []GetBuildDefinitionJobTarget: A target blocks as documented below.

allowScriptsAuthAccessOption Boolean: Enables scripts and other processes launched by tasks to access the OAuth token through the System.AccessToken variable.
condition String: Specifies when this job should run. Can Custom conditions to specify more complex conditions. More details: Pipeline conditions
dependencies List<GetBuildDefinitionJobDependency>: A dependencies blocks as documented below. Define the job dependencies.
jobAuthorizationScope String: The job authorization scope for builds queued against this definition.
jobCancelTimeoutInMinutes Integer: The job cancel timeout (in minutes) for builds cancelled by user for this definition.
jobTimeoutInMinutes Integer: The job execution timeout (in minutes) for builds queued against this definition.
name String: The name of this Build Definition.
refName String: The reference name of the job, can be used to define the job dependencies.
targets List<GetBuildDefinitionJobTarget>: A target blocks as documented below.

allowScriptsAuthAccessOption boolean: Enables scripts and other processes launched by tasks to access the OAuth token through the System.AccessToken variable.
condition string: Specifies when this job should run. Can Custom conditions to specify more complex conditions. More details: Pipeline conditions
dependencies GetBuildDefinitionJobDependency[]: A dependencies blocks as documented below. Define the job dependencies.
jobAuthorizationScope string: The job authorization scope for builds queued against this definition.
jobCancelTimeoutInMinutes number: The job cancel timeout (in minutes) for builds cancelled by user for this definition.
jobTimeoutInMinutes number: The job execution timeout (in minutes) for builds queued against this definition.
name string: The name of this Build Definition.
refName string: The reference name of the job, can be used to define the job dependencies.
targets GetBuildDefinitionJobTarget[]: A target blocks as documented below.

allow_scripts_auth_access_option bool: Enables scripts and other processes launched by tasks to access the OAuth token through the System.AccessToken variable.
condition str: Specifies when this job should run. Can Custom conditions to specify more complex conditions. More details: Pipeline conditions
dependencies Sequence[GetBuildDefinitionJobDependency]: A dependencies blocks as documented below. Define the job dependencies.
job_authorization_scope str: The job authorization scope for builds queued against this definition.
job_cancel_timeout_in_minutes int: The job cancel timeout (in minutes) for builds cancelled by user for this definition.
job_timeout_in_minutes int: The job execution timeout (in minutes) for builds queued against this definition.
name str: The name of this Build Definition.
ref_name str: The reference name of the job, can be used to define the job dependencies.
targets Sequence[GetBuildDefinitionJobTarget]: A target blocks as documented below.

allowScriptsAuthAccessOption Boolean: Enables scripts and other processes launched by tasks to access the OAuth token through the System.AccessToken variable.
condition String: Specifies when this job should run. Can Custom conditions to specify more complex conditions. More details: Pipeline conditions
dependencies List<Property Map>: A dependencies blocks as documented below. Define the job dependencies.
jobAuthorizationScope String: The job authorization scope for builds queued against this definition.
jobCancelTimeoutInMinutes Number: The job cancel timeout (in minutes) for builds cancelled by user for this definition.
jobTimeoutInMinutes Number: The job execution timeout (in minutes) for builds queued against this definition.
name String: The name of this Build Definition.
refName String: The reference name of the job, can be used to define the job dependencies.
targets List<Property Map>: A target blocks as documented below.

GetBuildDefinitionJobDependency

Scope string: The job reference name that depends on. Reference to jobs.ref_name

Scope string: The job reference name that depends on. Reference to jobs.ref_name

scope String: The job reference name that depends on. Reference to jobs.ref_name

scope string: The job reference name that depends on. Reference to jobs.ref_name

scope str: The job reference name that depends on. Reference to jobs.ref_name

scope String: The job reference name that depends on. Reference to jobs.ref_name

GetBuildDefinitionJobTarget

Demands List<string>: A list of demands that represents the agent capabilities required by this build. Example: git
ExecutionOptions List<Pulumi.AzureDevOps.Inputs.GetBuildDefinitionJobTargetExecutionOption>: A execution_options blocks as documented below.
Type string: The execution type of the Job.

Demands []string: A list of demands that represents the agent capabilities required by this build. Example: git
ExecutionOptions []GetBuildDefinitionJobTargetExecutionOption: A execution_options blocks as documented below.
Type string: The execution type of the Job.

demands List<String>: A list of demands that represents the agent capabilities required by this build. Example: git
executionOptions List<GetBuildDefinitionJobTargetExecutionOption>: A execution_options blocks as documented below.
type String: The execution type of the Job.

demands string[]: A list of demands that represents the agent capabilities required by this build. Example: git
executionOptions GetBuildDefinitionJobTargetExecutionOption[]: A execution_options blocks as documented below.
type string: The execution type of the Job.

demands Sequence[str]: A list of demands that represents the agent capabilities required by this build. Example: git
execution_options Sequence[GetBuildDefinitionJobTargetExecutionOption]: A execution_options blocks as documented below.
type str: The execution type of the Job.

demands List<String>: A list of demands that represents the agent capabilities required by this build. Example: git
executionOptions List<Property Map>: A execution_options blocks as documented below.
type String: The execution type of the Job.

GetBuildDefinitionJobTargetExecutionOption

ContinueOnError bool: Whether to continue the job when an error occurs.
MaxConcurrency int: Limit the number of agents to be used. If job type is AgentlessJob, the concurrency is not configurable and is fixed to 50.
Multipliers string: A list of comma separated configuration variables to use. These are defined on the Variables tab. For example, OperatingSystem, Browser will run the tasks for both variables.
Type string: The execution type of the Job.

ContinueOnError bool: Whether to continue the job when an error occurs.
MaxConcurrency int: Limit the number of agents to be used. If job type is AgentlessJob, the concurrency is not configurable and is fixed to 50.
Multipliers string: A list of comma separated configuration variables to use. These are defined on the Variables tab. For example, OperatingSystem, Browser will run the tasks for both variables.
Type string: The execution type of the Job.

continueOnError Boolean: Whether to continue the job when an error occurs.
maxConcurrency Integer: Limit the number of agents to be used. If job type is AgentlessJob, the concurrency is not configurable and is fixed to 50.
multipliers String: A list of comma separated configuration variables to use. These are defined on the Variables tab. For example, OperatingSystem, Browser will run the tasks for both variables.
type String: The execution type of the Job.

continueOnError boolean: Whether to continue the job when an error occurs.
maxConcurrency number: Limit the number of agents to be used. If job type is AgentlessJob, the concurrency is not configurable and is fixed to 50.
multipliers string: A list of comma separated configuration variables to use. These are defined on the Variables tab. For example, OperatingSystem, Browser will run the tasks for both variables.
type string: The execution type of the Job.

continue_on_error bool: Whether to continue the job when an error occurs.
max_concurrency int: Limit the number of agents to be used. If job type is AgentlessJob, the concurrency is not configurable and is fixed to 50.
multipliers str: A list of comma separated configuration variables to use. These are defined on the Variables tab. For example, OperatingSystem, Browser will run the tasks for both variables.
type str: The execution type of the Job.

continueOnError Boolean: Whether to continue the job when an error occurs.
maxConcurrency Number: Limit the number of agents to be used. If job type is AgentlessJob, the concurrency is not configurable and is fixed to 50.
multipliers String: A list of comma separated configuration variables to use. These are defined on the Variables tab. For example, OperatingSystem, Browser will run the tasks for both variables.
type String: The execution type of the Job.

GetBuildDefinitionPullRequestTrigger

CommentRequired string: Is a comment required on the PR?
Forks List<Pulumi.AzureDevOps.Inputs.GetBuildDefinitionPullRequestTriggerFork>: A forks block as defined above.
InitialBranch string: When use_yaml is true set this to the name of the branch that the azure-pipelines.yml exists on.
Overrides List<Pulumi.AzureDevOps.Inputs.GetBuildDefinitionPullRequestTriggerOverride>: A override block as defined below.
UseYaml bool: Use the azure-pipeline file for the build configuration.

CommentRequired string: Is a comment required on the PR?
Forks []GetBuildDefinitionPullRequestTriggerFork: A forks block as defined above.
InitialBranch string: When use_yaml is true set this to the name of the branch that the azure-pipelines.yml exists on.
Overrides []GetBuildDefinitionPullRequestTriggerOverride: A override block as defined below.
UseYaml bool: Use the azure-pipeline file for the build configuration.

commentRequired String: Is a comment required on the PR?
forks List<GetBuildDefinitionPullRequestTriggerFork>: A forks block as defined above.
initialBranch String: When use_yaml is true set this to the name of the branch that the azure-pipelines.yml exists on.
overrides List<GetBuildDefinitionPullRequestTriggerOverride>: A override block as defined below.
useYaml Boolean: Use the azure-pipeline file for the build configuration.

commentRequired string: Is a comment required on the PR?
forks GetBuildDefinitionPullRequestTriggerFork[]: A forks block as defined above.
initialBranch string: When use_yaml is true set this to the name of the branch that the azure-pipelines.yml exists on.
overrides GetBuildDefinitionPullRequestTriggerOverride[]: A override block as defined below.
useYaml boolean: Use the azure-pipeline file for the build configuration.

comment_required str: Is a comment required on the PR?
forks Sequence[GetBuildDefinitionPullRequestTriggerFork]: A forks block as defined above.
initial_branch str: When use_yaml is true set this to the name of the branch that the azure-pipelines.yml exists on.
overrides Sequence[GetBuildDefinitionPullRequestTriggerOverride]: A override block as defined below.
use_yaml bool: Use the azure-pipeline file for the build configuration.

commentRequired String: Is a comment required on the PR?
forks List<Property Map>: A forks block as defined above.
initialBranch String: When use_yaml is true set this to the name of the branch that the azure-pipelines.yml exists on.
overrides List<Property Map>: A override block as defined below.
useYaml Boolean: Use the azure-pipeline file for the build configuration.

GetBuildDefinitionPullRequestTriggerFork

Enabled bool: Build pull requests from forks of this repository.
ShareSecrets bool: Make secrets available to builds of forks.

Enabled bool: Build pull requests from forks of this repository.
ShareSecrets bool: Make secrets available to builds of forks.

enabled Boolean: Build pull requests from forks of this repository.
shareSecrets Boolean: Make secrets available to builds of forks.

enabled boolean: Build pull requests from forks of this repository.
shareSecrets boolean: Make secrets available to builds of forks.

enabled bool: Build pull requests from forks of this repository.
share_secrets bool: Make secrets available to builds of forks.

enabled Boolean: Build pull requests from forks of this repository.
shareSecrets Boolean: Make secrets available to builds of forks.

GetBuildDefinitionPullRequestTriggerOverride

AutoCancel bool: Should further updates to a PR cancel an in progress validation?
BranchFilters List<Pulumi.AzureDevOps.Inputs.GetBuildDefinitionPullRequestTriggerOverrideBranchFilter>: A branch_filter block as defined above.
PathFilters List<Pulumi.AzureDevOps.Inputs.GetBuildDefinitionPullRequestTriggerOverridePathFilter>: The file paths to include or exclude. A path_filter block as defined above.

AutoCancel bool: Should further updates to a PR cancel an in progress validation?
BranchFilters []GetBuildDefinitionPullRequestTriggerOverrideBranchFilter: A branch_filter block as defined above.
PathFilters []GetBuildDefinitionPullRequestTriggerOverridePathFilter: The file paths to include or exclude. A path_filter block as defined above.

autoCancel Boolean: Should further updates to a PR cancel an in progress validation?
branchFilters List<GetBuildDefinitionPullRequestTriggerOverrideBranchFilter>: A branch_filter block as defined above.
pathFilters List<GetBuildDefinitionPullRequestTriggerOverridePathFilter>: The file paths to include or exclude. A path_filter block as defined above.

autoCancel boolean: Should further updates to a PR cancel an in progress validation?
branchFilters GetBuildDefinitionPullRequestTriggerOverrideBranchFilter[]: A branch_filter block as defined above.
pathFilters GetBuildDefinitionPullRequestTriggerOverridePathFilter[]: The file paths to include or exclude. A path_filter block as defined above.

auto_cancel bool: Should further updates to a PR cancel an in progress validation?
branch_filters Sequence[GetBuildDefinitionPullRequestTriggerOverrideBranchFilter]: A branch_filter block as defined above.
path_filters Sequence[GetBuildDefinitionPullRequestTriggerOverridePathFilter]: The file paths to include or exclude. A path_filter block as defined above.

autoCancel Boolean: Should further updates to a PR cancel an in progress validation?
branchFilters List<Property Map>: A branch_filter block as defined above.
pathFilters List<Property Map>: The file paths to include or exclude. A path_filter block as defined above.

GetBuildDefinitionPullRequestTriggerOverrideBranchFilter

Excludes List<string>: (Optional) List of path patterns to exclude.
Includes List<string>: (Optional) List of path patterns to include.

Excludes []string: (Optional) List of path patterns to exclude.
Includes []string: (Optional) List of path patterns to include.

excludes List<String>: (Optional) List of path patterns to exclude.
includes List<String>: (Optional) List of path patterns to include.

excludes string[]: (Optional) List of path patterns to exclude.
includes string[]: (Optional) List of path patterns to include.

excludes Sequence[str]: (Optional) List of path patterns to exclude.
includes Sequence[str]: (Optional) List of path patterns to include.

excludes List<String>: (Optional) List of path patterns to exclude.
includes List<String>: (Optional) List of path patterns to include.

GetBuildDefinitionPullRequestTriggerOverridePathFilter

Excludes List<string>: (Optional) List of path patterns to exclude.
Includes List<string>: (Optional) List of path patterns to include.

Excludes []string: (Optional) List of path patterns to exclude.
Includes []string: (Optional) List of path patterns to include.

excludes List<String>: (Optional) List of path patterns to exclude.
includes List<String>: (Optional) List of path patterns to include.

excludes string[]: (Optional) List of path patterns to exclude.
includes string[]: (Optional) List of path patterns to include.

excludes Sequence[str]: (Optional) List of path patterns to exclude.
includes Sequence[str]: (Optional) List of path patterns to include.

excludes List<String>: (Optional) List of path patterns to exclude.
includes List<String>: (Optional) List of path patterns to include.

GetBuildDefinitionRepository

BranchName string: The branch name for which builds are triggered.
GithubEnterpriseUrl string: The Github Enterprise URL.
RepoId string: The id of the repository.
RepoType string: The repository type.
ReportBuildStatus bool: Report build status.
ServiceConnectionId string: The service connection ID.
Url string
YmlPath string: The path of the Yaml file describing the build definition.

BranchName string: The branch name for which builds are triggered.
GithubEnterpriseUrl string: The Github Enterprise URL.
RepoId string: The id of the repository.
RepoType string: The repository type.
ReportBuildStatus bool: Report build status.
ServiceConnectionId string: The service connection ID.
Url string
YmlPath string: The path of the Yaml file describing the build definition.

branchName String: The branch name for which builds are triggered.
githubEnterpriseUrl String: The Github Enterprise URL.
repoId String: The id of the repository.
repoType String: The repository type.
reportBuildStatus Boolean: Report build status.
serviceConnectionId String: The service connection ID.
url String
ymlPath String: The path of the Yaml file describing the build definition.

branchName string: The branch name for which builds are triggered.
githubEnterpriseUrl string: The Github Enterprise URL.
repoId string: The id of the repository.
repoType string: The repository type.
reportBuildStatus boolean: Report build status.
serviceConnectionId string: The service connection ID.
url string
ymlPath string: The path of the Yaml file describing the build definition.

branch_name str: The branch name for which builds are triggered.
github_enterprise_url str: The Github Enterprise URL.
repo_id str: The id of the repository.
repo_type str: The repository type.
report_build_status bool: Report build status.
service_connection_id str: The service connection ID.
url str
yml_path str: The path of the Yaml file describing the build definition.

branchName String: The branch name for which builds are triggered.
githubEnterpriseUrl String: The Github Enterprise URL.
repoId String: The id of the repository.
repoType String: The repository type.
reportBuildStatus Boolean: Report build status.
serviceConnectionId String: The service connection ID.
url String
ymlPath String: The path of the Yaml file describing the build definition.

GetBuildDefinitionSchedule

BranchFilters List<Pulumi.AzureDevOps.Inputs.GetBuildDefinitionScheduleBranchFilter>: A branch_filter block as defined above.
DaysToBuilds List<string>: A list of days to build on.
ScheduleJobId string: The ID of the schedule job.
ScheduleOnlyWithChanges bool: Schedule builds if the source or pipeline has changed.
StartHours int: Build start hour.
StartMinutes int: Build start minute.
TimeZone string: Build time zone.

BranchFilters []GetBuildDefinitionScheduleBranchFilter: A branch_filter block as defined above.
DaysToBuilds []string: A list of days to build on.
ScheduleJobId string: The ID of the schedule job.
ScheduleOnlyWithChanges bool: Schedule builds if the source or pipeline has changed.
StartHours int: Build start hour.
StartMinutes int: Build start minute.
TimeZone string: Build time zone.

branchFilters List<GetBuildDefinitionScheduleBranchFilter>: A branch_filter block as defined above.
daysToBuilds List<String>: A list of days to build on.
scheduleJobId String: The ID of the schedule job.
scheduleOnlyWithChanges Boolean: Schedule builds if the source or pipeline has changed.
startHours Integer: Build start hour.
startMinutes Integer: Build start minute.
timeZone String: Build time zone.

branchFilters GetBuildDefinitionScheduleBranchFilter[]: A branch_filter block as defined above.
daysToBuilds string[]: A list of days to build on.
scheduleJobId string: The ID of the schedule job.
scheduleOnlyWithChanges boolean: Schedule builds if the source or pipeline has changed.
startHours number: Build start hour.
startMinutes number: Build start minute.
timeZone string: Build time zone.

branch_filters Sequence[GetBuildDefinitionScheduleBranchFilter]: A branch_filter block as defined above.
days_to_builds Sequence[str]: A list of days to build on.
schedule_job_id str: The ID of the schedule job.
schedule_only_with_changes bool: Schedule builds if the source or pipeline has changed.
start_hours int: Build start hour.
start_minutes int: Build start minute.
time_zone str: Build time zone.

branchFilters List<Property Map>: A branch_filter block as defined above.
daysToBuilds List<String>: A list of days to build on.
scheduleJobId String: The ID of the schedule job.
scheduleOnlyWithChanges Boolean: Schedule builds if the source or pipeline has changed.
startHours Number: Build start hour.
startMinutes Number: Build start minute.
timeZone String: Build time zone.

GetBuildDefinitionScheduleBranchFilter

Excludes List<string>: (Optional) List of path patterns to exclude.
Includes List<string>: (Optional) List of path patterns to include.

Excludes []string: (Optional) List of path patterns to exclude.
Includes []string: (Optional) List of path patterns to include.

excludes List<String>: (Optional) List of path patterns to exclude.
includes List<String>: (Optional) List of path patterns to include.

excludes string[]: (Optional) List of path patterns to exclude.
includes string[]: (Optional) List of path patterns to include.

excludes Sequence[str]: (Optional) List of path patterns to exclude.
includes Sequence[str]: (Optional) List of path patterns to include.

excludes List<String>: (Optional) List of path patterns to exclude.
includes List<String>: (Optional) List of path patterns to include.

GetBuildDefinitionVariable

AllowOverride bool: true if the variable can be overridden.
IsSecret bool: true if the variable is a secret.
Name string: The name of this Build Definition.
SecretValue string: The secret value of the variable.
Value string: The value of the variable.

AllowOverride bool: true if the variable can be overridden.
IsSecret bool: true if the variable is a secret.
Name string: The name of this Build Definition.
SecretValue string: The secret value of the variable.
Value string: The value of the variable.

allowOverride Boolean: true if the variable can be overridden.
isSecret Boolean: true if the variable is a secret.
name String: The name of this Build Definition.
secretValue String: The secret value of the variable.
value String: The value of the variable.

allowOverride boolean: true if the variable can be overridden.
isSecret boolean: true if the variable is a secret.
name string: The name of this Build Definition.
secretValue string: The secret value of the variable.
value string: The value of the variable.

allow_override bool: true if the variable can be overridden.
is_secret bool: true if the variable is a secret.
name str: The name of this Build Definition.
secret_value str: The secret value of the variable.
value str: The value of the variable.

allowOverride Boolean: true if the variable can be overridden.
isSecret Boolean: true if the variable is a secret.
name String: The name of this Build Definition.
secretValue String: The secret value of the variable.
value String: The value of the variable.

Package Details

Repository: Azure DevOps pulumi/pulumi-azuredevops
License: Apache-2.0
Notes: This Pulumi package is based on the azuredevops Terraform Provider.

Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi

pulumi/pulumi-azuredevops

azuredevops.getBuildDefinition

On this page

On this page

Example Usage

Using getBuildDefinition

getBuildDefinition Result

Supporting Types

GetBuildDefinitionCiTrigger

GetBuildDefinitionCiTriggerOverride

GetBuildDefinitionCiTriggerOverrideBranchFilter

GetBuildDefinitionCiTriggerOverridePathFilter

GetBuildDefinitionJob

GetBuildDefinitionJobDependency

GetBuildDefinitionJobTarget

GetBuildDefinitionJobTargetExecutionOption

GetBuildDefinitionPullRequestTrigger

GetBuildDefinitionPullRequestTriggerFork

GetBuildDefinitionPullRequestTriggerOverride

GetBuildDefinitionPullRequestTriggerOverrideBranchFilter

GetBuildDefinitionPullRequestTriggerOverridePathFilter

GetBuildDefinitionRepository

GetBuildDefinitionSchedule

GetBuildDefinitionScheduleBranchFilter

GetBuildDefinitionVariable

Package Details

On this page

On this page