azuredevops.BuildDefinition
Manages a Build Definition within Azure DevOps.
Remarks
The path attribute can not end in \
unless the path is the root value of \
.
Valid path values (yaml encoded) include:
\\
\\ExampleFolder
\\Nested\\Example Folder
The value of \\ExampleFolder\\
would be invalid.
Relevant Links
Example Usage
Tfs
using System.Collections.Generic;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;
return await Deployment.RunAsync(() =>
{
var exampleProject = new AzureDevOps.Project("exampleProject", new()
{
Visibility = "private",
VersionControl = "Git",
WorkItemTemplate = "Agile",
});
var exampleGit = new AzureDevOps.Git("exampleGit", new()
{
ProjectId = exampleProject.Id,
Initialization = new AzureDevOps.Inputs.GitInitializationArgs
{
InitType = "Clean",
},
});
var exampleVariableGroup = new AzureDevOps.VariableGroup("exampleVariableGroup", new()
{
ProjectId = exampleProject.Id,
Description = "Managed by Terraform",
AllowAccess = true,
Variables = new[]
{
new AzureDevOps.Inputs.VariableGroupVariableArgs
{
Name = "FOO",
Value = "BAR",
},
},
});
var exampleBuildDefinition = new AzureDevOps.BuildDefinition("exampleBuildDefinition", new()
{
ProjectId = exampleProject.Id,
Path = "\\ExampleFolder",
CiTrigger = new AzureDevOps.Inputs.BuildDefinitionCiTriggerArgs
{
UseYaml = true,
},
Schedules = new[]
{
new AzureDevOps.Inputs.BuildDefinitionScheduleArgs
{
BranchFilters = new[]
{
new AzureDevOps.Inputs.BuildDefinitionScheduleBranchFilterArgs
{
Includes = new[]
{
"master",
},
Excludes = new[]
{
"test",
"regression",
},
},
},
DaysToBuilds = new[]
{
"Wed",
"Sun",
},
ScheduleOnlyWithChanges = true,
StartHours = 10,
StartMinutes = 59,
TimeZone = "(UTC) Coordinated Universal Time",
},
},
Repository = new AzureDevOps.Inputs.BuildDefinitionRepositoryArgs
{
RepoType = "TfsGit",
RepoId = exampleGit.Id,
BranchName = exampleGit.DefaultBranch,
YmlPath = "azure-pipelines.yml",
},
VariableGroups = new[]
{
exampleVariableGroup.Id,
},
Variables = new[]
{
new AzureDevOps.Inputs.BuildDefinitionVariableArgs
{
Name = "PipelineVariable",
Value = "Go Microsoft!",
},
new AzureDevOps.Inputs.BuildDefinitionVariableArgs
{
Name = "PipelineSecret",
SecretValue = "ZGV2cw",
IsSecret = true,
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", &azuredevops.ProjectArgs{
Visibility: pulumi.String("private"),
VersionControl: pulumi.String("Git"),
WorkItemTemplate: pulumi.String("Agile"),
})
if err != nil {
return err
}
exampleGit, err := azuredevops.NewGit(ctx, "exampleGit", &azuredevops.GitArgs{
ProjectId: exampleProject.ID(),
Initialization: &GitInitializationArgs{
InitType: pulumi.String("Clean"),
},
})
if err != nil {
return err
}
exampleVariableGroup, err := azuredevops.NewVariableGroup(ctx, "exampleVariableGroup", &azuredevops.VariableGroupArgs{
ProjectId: exampleProject.ID(),
Description: pulumi.String("Managed by Terraform"),
AllowAccess: pulumi.Bool(true),
Variables: VariableGroupVariableArray{
&VariableGroupVariableArgs{
Name: pulumi.String("FOO"),
Value: pulumi.String("BAR"),
},
},
})
if err != nil {
return err
}
_, err = azuredevops.NewBuildDefinition(ctx, "exampleBuildDefinition", &azuredevops.BuildDefinitionArgs{
ProjectId: exampleProject.ID(),
Path: pulumi.String("\\ExampleFolder"),
CiTrigger: &BuildDefinitionCiTriggerArgs{
UseYaml: pulumi.Bool(true),
},
Schedules: BuildDefinitionScheduleArray{
&BuildDefinitionScheduleArgs{
BranchFilters: BuildDefinitionScheduleBranchFilterArray{
&BuildDefinitionScheduleBranchFilterArgs{
Includes: pulumi.StringArray{
pulumi.String("master"),
},
Excludes: pulumi.StringArray{
pulumi.String("test"),
pulumi.String("regression"),
},
},
},
DaysToBuilds: pulumi.StringArray{
pulumi.String("Wed"),
pulumi.String("Sun"),
},
ScheduleOnlyWithChanges: pulumi.Bool(true),
StartHours: pulumi.Int(10),
StartMinutes: pulumi.Int(59),
TimeZone: pulumi.String("(UTC) Coordinated Universal Time"),
},
},
Repository: &BuildDefinitionRepositoryArgs{
RepoType: pulumi.String("TfsGit"),
RepoId: exampleGit.ID(),
BranchName: exampleGit.DefaultBranch,
YmlPath: pulumi.String("azure-pipelines.yml"),
},
VariableGroups: pulumi.IntArray{
exampleVariableGroup.ID(),
},
Variables: BuildDefinitionVariableArray{
&BuildDefinitionVariableArgs{
Name: pulumi.String("PipelineVariable"),
Value: pulumi.String("Go Microsoft!"),
},
&BuildDefinitionVariableArgs{
Name: pulumi.String("PipelineSecret"),
SecretValue: pulumi.String("ZGV2cw"),
IsSecret: pulumi.Bool(true),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Project;
import com.pulumi.azuredevops.ProjectArgs;
import com.pulumi.azuredevops.Git;
import com.pulumi.azuredevops.GitArgs;
import com.pulumi.azuredevops.inputs.GitInitializationArgs;
import com.pulumi.azuredevops.VariableGroup;
import com.pulumi.azuredevops.VariableGroupArgs;
import com.pulumi.azuredevops.inputs.VariableGroupVariableArgs;
import com.pulumi.azuredevops.BuildDefinition;
import com.pulumi.azuredevops.BuildDefinitionArgs;
import com.pulumi.azuredevops.inputs.BuildDefinitionCiTriggerArgs;
import com.pulumi.azuredevops.inputs.BuildDefinitionScheduleArgs;
import com.pulumi.azuredevops.inputs.BuildDefinitionRepositoryArgs;
import com.pulumi.azuredevops.inputs.BuildDefinitionVariableArgs;
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 exampleProject = new Project("exampleProject", ProjectArgs.builder()
.visibility("private")
.versionControl("Git")
.workItemTemplate("Agile")
.build());
var exampleGit = new Git("exampleGit", GitArgs.builder()
.projectId(exampleProject.id())
.initialization(GitInitializationArgs.builder()
.initType("Clean")
.build())
.build());
var exampleVariableGroup = new VariableGroup("exampleVariableGroup", VariableGroupArgs.builder()
.projectId(exampleProject.id())
.description("Managed by Terraform")
.allowAccess(true)
.variables(VariableGroupVariableArgs.builder()
.name("FOO")
.value("BAR")
.build())
.build());
var exampleBuildDefinition = new BuildDefinition("exampleBuildDefinition", BuildDefinitionArgs.builder()
.projectId(exampleProject.id())
.path("\\ExampleFolder")
.ciTrigger(BuildDefinitionCiTriggerArgs.builder()
.useYaml(true)
.build())
.schedules(BuildDefinitionScheduleArgs.builder()
.branchFilters(BuildDefinitionScheduleBranchFilterArgs.builder()
.includes("master")
.excludes(
"test",
"regression")
.build())
.daysToBuilds(
"Wed",
"Sun")
.scheduleOnlyWithChanges(true)
.startHours(10)
.startMinutes(59)
.timeZone("(UTC) Coordinated Universal Time")
.build())
.repository(BuildDefinitionRepositoryArgs.builder()
.repoType("TfsGit")
.repoId(exampleGit.id())
.branchName(exampleGit.defaultBranch())
.ymlPath("azure-pipelines.yml")
.build())
.variableGroups(exampleVariableGroup.id())
.variables(
BuildDefinitionVariableArgs.builder()
.name("PipelineVariable")
.value("Go Microsoft!")
.build(),
BuildDefinitionVariableArgs.builder()
.name("PipelineSecret")
.secretValue("ZGV2cw")
.isSecret(true)
.build())
.build());
}
}
import pulumi
import pulumi_azuredevops as azuredevops
example_project = azuredevops.Project("exampleProject",
visibility="private",
version_control="Git",
work_item_template="Agile")
example_git = azuredevops.Git("exampleGit",
project_id=example_project.id,
initialization=azuredevops.GitInitializationArgs(
init_type="Clean",
))
example_variable_group = azuredevops.VariableGroup("exampleVariableGroup",
project_id=example_project.id,
description="Managed by Terraform",
allow_access=True,
variables=[azuredevops.VariableGroupVariableArgs(
name="FOO",
value="BAR",
)])
example_build_definition = azuredevops.BuildDefinition("exampleBuildDefinition",
project_id=example_project.id,
path="\\ExampleFolder",
ci_trigger=azuredevops.BuildDefinitionCiTriggerArgs(
use_yaml=True,
),
schedules=[azuredevops.BuildDefinitionScheduleArgs(
branch_filters=[azuredevops.BuildDefinitionScheduleBranchFilterArgs(
includes=["master"],
excludes=[
"test",
"regression",
],
)],
days_to_builds=[
"Wed",
"Sun",
],
schedule_only_with_changes=True,
start_hours=10,
start_minutes=59,
time_zone="(UTC) Coordinated Universal Time",
)],
repository=azuredevops.BuildDefinitionRepositoryArgs(
repo_type="TfsGit",
repo_id=example_git.id,
branch_name=example_git.default_branch,
yml_path="azure-pipelines.yml",
),
variable_groups=[example_variable_group.id],
variables=[
azuredevops.BuildDefinitionVariableArgs(
name="PipelineVariable",
value="Go Microsoft!",
),
azuredevops.BuildDefinitionVariableArgs(
name="PipelineSecret",
secret_value="ZGV2cw",
is_secret=True,
),
])
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";
const exampleProject = new azuredevops.Project("exampleProject", {
visibility: "private",
versionControl: "Git",
workItemTemplate: "Agile",
});
const exampleGit = new azuredevops.Git("exampleGit", {
projectId: exampleProject.id,
initialization: {
initType: "Clean",
},
});
const exampleVariableGroup = new azuredevops.VariableGroup("exampleVariableGroup", {
projectId: exampleProject.id,
description: "Managed by Terraform",
allowAccess: true,
variables: [{
name: "FOO",
value: "BAR",
}],
});
const exampleBuildDefinition = new azuredevops.BuildDefinition("exampleBuildDefinition", {
projectId: exampleProject.id,
path: "\\ExampleFolder",
ciTrigger: {
useYaml: true,
},
schedules: [{
branchFilters: [{
includes: ["master"],
excludes: [
"test",
"regression",
],
}],
daysToBuilds: [
"Wed",
"Sun",
],
scheduleOnlyWithChanges: true,
startHours: 10,
startMinutes: 59,
timeZone: "(UTC) Coordinated Universal Time",
}],
repository: {
repoType: "TfsGit",
repoId: exampleGit.id,
branchName: exampleGit.defaultBranch,
ymlPath: "azure-pipelines.yml",
},
variableGroups: [exampleVariableGroup.id],
variables: [
{
name: "PipelineVariable",
value: "Go Microsoft!",
},
{
name: "PipelineSecret",
secretValue: "ZGV2cw",
isSecret: true,
},
],
});
resources:
exampleProject:
type: azuredevops:Project
properties:
visibility: private
versionControl: Git
workItemTemplate: Agile
exampleGit:
type: azuredevops:Git
properties:
projectId: ${exampleProject.id}
initialization:
initType: Clean
exampleVariableGroup:
type: azuredevops:VariableGroup
properties:
projectId: ${exampleProject.id}
description: Managed by Terraform
allowAccess: true
variables:
- name: FOO
value: BAR
exampleBuildDefinition:
type: azuredevops:BuildDefinition
properties:
projectId: ${exampleProject.id}
path: \ExampleFolder
ciTrigger:
useYaml: true
schedules:
- branchFilters:
- includes:
- master
excludes:
- test
- regression
daysToBuilds:
- Wed
- Sun
scheduleOnlyWithChanges: true
startHours: 10
startMinutes: 59
timeZone: (UTC) Coordinated Universal Time
repository:
repoType: TfsGit
repoId: ${exampleGit.id}
branchName: ${exampleGit.defaultBranch}
ymlPath: azure-pipelines.yml
variableGroups:
- ${exampleVariableGroup.id}
variables:
- name: PipelineVariable
value: Go Microsoft!
- name: PipelineSecret
secretValue: ZGV2cw
isSecret: true
GitHub Enterprise
using System.Collections.Generic;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;
return await Deployment.RunAsync(() =>
{
var exampleProject = new AzureDevOps.Project("exampleProject", new()
{
Visibility = "private",
VersionControl = "Git",
WorkItemTemplate = "Agile",
});
var exampleServiceEndpointGitHubEnterprise = new AzureDevOps.ServiceEndpointGitHubEnterprise("exampleServiceEndpointGitHubEnterprise", new()
{
ProjectId = exampleProject.Id,
ServiceEndpointName = "Example GitHub Enterprise",
Url = "https://github.contoso.com",
Description = "Managed by Terraform",
AuthPersonal = new AzureDevOps.Inputs.ServiceEndpointGitHubEnterpriseAuthPersonalArgs
{
PersonalAccessToken = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
});
var exampleBuildDefinition = new AzureDevOps.BuildDefinition("exampleBuildDefinition", new()
{
ProjectId = exampleProject.Id,
Path = "\\ExampleFolder",
CiTrigger = new AzureDevOps.Inputs.BuildDefinitionCiTriggerArgs
{
UseYaml = true,
},
Repository = new AzureDevOps.Inputs.BuildDefinitionRepositoryArgs
{
RepoType = "GitHubEnterprise",
RepoId = "<GitHub Org>/<Repo Name>",
GithubEnterpriseUrl = "https://github.company.com",
BranchName = "master",
YmlPath = "azure-pipelines.yml",
ServiceConnectionId = exampleServiceEndpointGitHubEnterprise.Id,
},
Schedules = new[]
{
new AzureDevOps.Inputs.BuildDefinitionScheduleArgs
{
BranchFilters = new[]
{
new AzureDevOps.Inputs.BuildDefinitionScheduleBranchFilterArgs
{
Includes = new[]
{
"main",
},
Excludes = new[]
{
"test",
"regression",
},
},
},
DaysToBuilds = new[]
{
"Wed",
"Sun",
},
ScheduleOnlyWithChanges = true,
StartHours = 10,
StartMinutes = 59,
TimeZone = "(UTC) Coordinated Universal Time",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", &azuredevops.ProjectArgs{
Visibility: pulumi.String("private"),
VersionControl: pulumi.String("Git"),
WorkItemTemplate: pulumi.String("Agile"),
})
if err != nil {
return err
}
exampleServiceEndpointGitHubEnterprise, err := azuredevops.NewServiceEndpointGitHubEnterprise(ctx, "exampleServiceEndpointGitHubEnterprise", &azuredevops.ServiceEndpointGitHubEnterpriseArgs{
ProjectId: exampleProject.ID(),
ServiceEndpointName: pulumi.String("Example GitHub Enterprise"),
Url: pulumi.String("https://github.contoso.com"),
Description: pulumi.String("Managed by Terraform"),
AuthPersonal: &ServiceEndpointGitHubEnterpriseAuthPersonalArgs{
PersonalAccessToken: pulumi.String("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
},
})
if err != nil {
return err
}
_, err = azuredevops.NewBuildDefinition(ctx, "exampleBuildDefinition", &azuredevops.BuildDefinitionArgs{
ProjectId: exampleProject.ID(),
Path: pulumi.String("\\ExampleFolder"),
CiTrigger: &BuildDefinitionCiTriggerArgs{
UseYaml: pulumi.Bool(true),
},
Repository: &BuildDefinitionRepositoryArgs{
RepoType: pulumi.String("GitHubEnterprise"),
RepoId: pulumi.String("<GitHub Org>/<Repo Name>"),
GithubEnterpriseUrl: pulumi.String("https://github.company.com"),
BranchName: pulumi.String("master"),
YmlPath: pulumi.String("azure-pipelines.yml"),
ServiceConnectionId: exampleServiceEndpointGitHubEnterprise.ID(),
},
Schedules: BuildDefinitionScheduleArray{
&BuildDefinitionScheduleArgs{
BranchFilters: BuildDefinitionScheduleBranchFilterArray{
&BuildDefinitionScheduleBranchFilterArgs{
Includes: pulumi.StringArray{
pulumi.String("main"),
},
Excludes: pulumi.StringArray{
pulumi.String("test"),
pulumi.String("regression"),
},
},
},
DaysToBuilds: pulumi.StringArray{
pulumi.String("Wed"),
pulumi.String("Sun"),
},
ScheduleOnlyWithChanges: pulumi.Bool(true),
StartHours: pulumi.Int(10),
StartMinutes: pulumi.Int(59),
TimeZone: pulumi.String("(UTC) Coordinated Universal Time"),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Project;
import com.pulumi.azuredevops.ProjectArgs;
import com.pulumi.azuredevops.ServiceEndpointGitHubEnterprise;
import com.pulumi.azuredevops.ServiceEndpointGitHubEnterpriseArgs;
import com.pulumi.azuredevops.inputs.ServiceEndpointGitHubEnterpriseAuthPersonalArgs;
import com.pulumi.azuredevops.BuildDefinition;
import com.pulumi.azuredevops.BuildDefinitionArgs;
import com.pulumi.azuredevops.inputs.BuildDefinitionCiTriggerArgs;
import com.pulumi.azuredevops.inputs.BuildDefinitionRepositoryArgs;
import com.pulumi.azuredevops.inputs.BuildDefinitionScheduleArgs;
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 exampleProject = new Project("exampleProject", ProjectArgs.builder()
.visibility("private")
.versionControl("Git")
.workItemTemplate("Agile")
.build());
var exampleServiceEndpointGitHubEnterprise = new ServiceEndpointGitHubEnterprise("exampleServiceEndpointGitHubEnterprise", ServiceEndpointGitHubEnterpriseArgs.builder()
.projectId(exampleProject.id())
.serviceEndpointName("Example GitHub Enterprise")
.url("https://github.contoso.com")
.description("Managed by Terraform")
.authPersonal(ServiceEndpointGitHubEnterpriseAuthPersonalArgs.builder()
.personalAccessToken("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
.build())
.build());
var exampleBuildDefinition = new BuildDefinition("exampleBuildDefinition", BuildDefinitionArgs.builder()
.projectId(exampleProject.id())
.path("\\ExampleFolder")
.ciTrigger(BuildDefinitionCiTriggerArgs.builder()
.useYaml(true)
.build())
.repository(BuildDefinitionRepositoryArgs.builder()
.repoType("GitHubEnterprise")
.repoId("<GitHub Org>/<Repo Name>")
.githubEnterpriseUrl("https://github.company.com")
.branchName("master")
.ymlPath("azure-pipelines.yml")
.serviceConnectionId(exampleServiceEndpointGitHubEnterprise.id())
.build())
.schedules(BuildDefinitionScheduleArgs.builder()
.branchFilters(BuildDefinitionScheduleBranchFilterArgs.builder()
.includes("main")
.excludes(
"test",
"regression")
.build())
.daysToBuilds(
"Wed",
"Sun")
.scheduleOnlyWithChanges(true)
.startHours(10)
.startMinutes(59)
.timeZone("(UTC) Coordinated Universal Time")
.build())
.build());
}
}
import pulumi
import pulumi_azuredevops as azuredevops
example_project = azuredevops.Project("exampleProject",
visibility="private",
version_control="Git",
work_item_template="Agile")
example_service_endpoint_git_hub_enterprise = azuredevops.ServiceEndpointGitHubEnterprise("exampleServiceEndpointGitHubEnterprise",
project_id=example_project.id,
service_endpoint_name="Example GitHub Enterprise",
url="https://github.contoso.com",
description="Managed by Terraform",
auth_personal=azuredevops.ServiceEndpointGitHubEnterpriseAuthPersonalArgs(
personal_access_token="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
))
example_build_definition = azuredevops.BuildDefinition("exampleBuildDefinition",
project_id=example_project.id,
path="\\ExampleFolder",
ci_trigger=azuredevops.BuildDefinitionCiTriggerArgs(
use_yaml=True,
),
repository=azuredevops.BuildDefinitionRepositoryArgs(
repo_type="GitHubEnterprise",
repo_id="<GitHub Org>/<Repo Name>",
github_enterprise_url="https://github.company.com",
branch_name="master",
yml_path="azure-pipelines.yml",
service_connection_id=example_service_endpoint_git_hub_enterprise.id,
),
schedules=[azuredevops.BuildDefinitionScheduleArgs(
branch_filters=[azuredevops.BuildDefinitionScheduleBranchFilterArgs(
includes=["main"],
excludes=[
"test",
"regression",
],
)],
days_to_builds=[
"Wed",
"Sun",
],
schedule_only_with_changes=True,
start_hours=10,
start_minutes=59,
time_zone="(UTC) Coordinated Universal Time",
)])
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";
const exampleProject = new azuredevops.Project("exampleProject", {
visibility: "private",
versionControl: "Git",
workItemTemplate: "Agile",
});
const exampleServiceEndpointGitHubEnterprise = new azuredevops.ServiceEndpointGitHubEnterprise("exampleServiceEndpointGitHubEnterprise", {
projectId: exampleProject.id,
serviceEndpointName: "Example GitHub Enterprise",
url: "https://github.contoso.com",
description: "Managed by Terraform",
authPersonal: {
personalAccessToken: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
});
const exampleBuildDefinition = new azuredevops.BuildDefinition("exampleBuildDefinition", {
projectId: exampleProject.id,
path: "\\ExampleFolder",
ciTrigger: {
useYaml: true,
},
repository: {
repoType: "GitHubEnterprise",
repoId: "<GitHub Org>/<Repo Name>",
githubEnterpriseUrl: "https://github.company.com",
branchName: "master",
ymlPath: "azure-pipelines.yml",
serviceConnectionId: exampleServiceEndpointGitHubEnterprise.id,
},
schedules: [{
branchFilters: [{
includes: ["main"],
excludes: [
"test",
"regression",
],
}],
daysToBuilds: [
"Wed",
"Sun",
],
scheduleOnlyWithChanges: true,
startHours: 10,
startMinutes: 59,
timeZone: "(UTC) Coordinated Universal Time",
}],
});
resources:
exampleProject:
type: azuredevops:Project
properties:
visibility: private
versionControl: Git
workItemTemplate: Agile
exampleServiceEndpointGitHubEnterprise:
type: azuredevops:ServiceEndpointGitHubEnterprise
properties:
projectId: ${exampleProject.id}
serviceEndpointName: Example GitHub Enterprise
url: https://github.contoso.com
description: Managed by Terraform
authPersonal:
personalAccessToken: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
exampleBuildDefinition:
type: azuredevops:BuildDefinition
properties:
projectId: ${exampleProject.id}
path: \ExampleFolder
ciTrigger:
useYaml: true
repository:
repoType: GitHubEnterprise
repoId: <GitHub Org>/<Repo Name>
githubEnterpriseUrl: https://github.company.com
branchName: master
ymlPath: azure-pipelines.yml
serviceConnectionId: ${exampleServiceEndpointGitHubEnterprise.id}
schedules:
- branchFilters:
- includes:
- main
excludes:
- test
- regression
daysToBuilds:
- Wed
- Sun
scheduleOnlyWithChanges: true
startHours: 10
startMinutes: 59
timeZone: (UTC) Coordinated Universal Time
Create BuildDefinition Resource
new BuildDefinition(name: string, args: BuildDefinitionArgs, opts?: CustomResourceOptions);
@overload
def BuildDefinition(resource_name: str,
opts: Optional[ResourceOptions] = None,
agent_pool_name: Optional[str] = None,
ci_trigger: Optional[BuildDefinitionCiTriggerArgs] = None,
name: Optional[str] = None,
path: Optional[str] = None,
project_id: Optional[str] = None,
pull_request_trigger: Optional[BuildDefinitionPullRequestTriggerArgs] = None,
repository: Optional[BuildDefinitionRepositoryArgs] = None,
schedules: Optional[Sequence[BuildDefinitionScheduleArgs]] = None,
variable_groups: Optional[Sequence[int]] = None,
variables: Optional[Sequence[BuildDefinitionVariableArgs]] = None)
@overload
def BuildDefinition(resource_name: str,
args: BuildDefinitionArgs,
opts: Optional[ResourceOptions] = None)
func NewBuildDefinition(ctx *Context, name string, args BuildDefinitionArgs, opts ...ResourceOption) (*BuildDefinition, error)
public BuildDefinition(string name, BuildDefinitionArgs args, CustomResourceOptions? opts = null)
public BuildDefinition(String name, BuildDefinitionArgs args)
public BuildDefinition(String name, BuildDefinitionArgs args, CustomResourceOptions options)
type: azuredevops:BuildDefinition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BuildDefinitionArgs
- 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 BuildDefinitionArgs
- 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 BuildDefinitionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BuildDefinitionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BuildDefinitionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
BuildDefinition Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The BuildDefinition resource accepts the following input properties:
- Project
Id string The project ID or project name.
- Repository
Pulumi.
Azure Dev Ops. Inputs. Build Definition Repository Args A
repository
block as documented below.- Agent
Pool stringName The agent pool that should execute the build. Defaults to
Azure Pipelines
.- Ci
Trigger Pulumi.Azure Dev Ops. Inputs. Build Definition Ci Trigger Args Continuous Integration trigger.
- Name string
The name of the build definition.
- Path string
The folder path of the build definition.
- Pull
Request Pulumi.Trigger Azure Dev Ops. Inputs. Build Definition Pull Request Trigger Args Pull Request Integration Integration trigger.
- Schedules
List<Pulumi.
Azure Dev Ops. Inputs. Build Definition Schedule Args> - Variable
Groups List<int> A list of variable group IDs (integers) to link to the build definition.
- Variables
List<Pulumi.
Azure Dev Ops. Inputs. Build Definition Variable Args> A list of
variable
blocks, as documented below.
- Project
Id string The project ID or project name.
- Repository
Build
Definition Repository Args A
repository
block as documented below.- Agent
Pool stringName The agent pool that should execute the build. Defaults to
Azure Pipelines
.- Ci
Trigger BuildDefinition Ci Trigger Args Continuous Integration trigger.
- Name string
The name of the build definition.
- Path string
The folder path of the build definition.
- Pull
Request BuildTrigger Definition Pull Request Trigger Args Pull Request Integration Integration trigger.
- Schedules
[]Build
Definition Schedule Args - Variable
Groups []int A list of variable group IDs (integers) to link to the build definition.
- Variables
[]Build
Definition Variable Args A list of
variable
blocks, as documented below.
- project
Id String The project ID or project name.
- repository
Build
Definition Repository Args A
repository
block as documented below.- agent
Pool StringName The agent pool that should execute the build. Defaults to
Azure Pipelines
.- ci
Trigger BuildDefinition Ci Trigger Args Continuous Integration trigger.
- name String
The name of the build definition.
- path String
The folder path of the build definition.
- pull
Request BuildTrigger Definition Pull Request Trigger Args Pull Request Integration Integration trigger.
- schedules
List<Build
Definition Schedule Args> - variable
Groups List<Integer> A list of variable group IDs (integers) to link to the build definition.
- variables
List<Build
Definition Variable Args> A list of
variable
blocks, as documented below.
- project
Id string The project ID or project name.
- repository
Build
Definition Repository Args A
repository
block as documented below.- agent
Pool stringName The agent pool that should execute the build. Defaults to
Azure Pipelines
.- ci
Trigger BuildDefinition Ci Trigger Args Continuous Integration trigger.
- name string
The name of the build definition.
- path string
The folder path of the build definition.
- pull
Request BuildTrigger Definition Pull Request Trigger Args Pull Request Integration Integration trigger.
- schedules
Build
Definition Schedule Args[] - variable
Groups number[] A list of variable group IDs (integers) to link to the build definition.
- variables
Build
Definition Variable Args[] A list of
variable
blocks, as documented below.
- project_
id str The project ID or project name.
- repository
Build
Definition Repository Args A
repository
block as documented below.- agent_
pool_ strname The agent pool that should execute the build. Defaults to
Azure Pipelines
.- ci_
trigger BuildDefinition Ci Trigger Args Continuous Integration trigger.
- name str
The name of the build definition.
- path str
The folder path of the build definition.
- pull_
request_ Buildtrigger Definition Pull Request Trigger Args Pull Request Integration Integration trigger.
- schedules
Sequence[Build
Definition Schedule Args] - variable_
groups Sequence[int] A list of variable group IDs (integers) to link to the build definition.
- variables
Sequence[Build
Definition Variable Args] A list of
variable
blocks, as documented below.
- project
Id String The project ID or project name.
- repository Property Map
A
repository
block as documented below.- agent
Pool StringName The agent pool that should execute the build. Defaults to
Azure Pipelines
.- ci
Trigger Property Map Continuous Integration trigger.
- name String
The name of the build definition.
- path String
The folder path of the build definition.
- pull
Request Property MapTrigger Pull Request Integration Integration trigger.
- schedules List<Property Map>
- variable
Groups List<Number> A list of variable group IDs (integers) to link to the build definition.
- variables List<Property Map>
A list of
variable
blocks, as documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the BuildDefinition resource produces the following output properties:
Look up Existing BuildDefinition Resource
Get an existing BuildDefinition 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?: BuildDefinitionState, opts?: CustomResourceOptions): BuildDefinition
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
agent_pool_name: Optional[str] = None,
ci_trigger: Optional[BuildDefinitionCiTriggerArgs] = None,
name: Optional[str] = None,
path: Optional[str] = None,
project_id: Optional[str] = None,
pull_request_trigger: Optional[BuildDefinitionPullRequestTriggerArgs] = None,
repository: Optional[BuildDefinitionRepositoryArgs] = None,
revision: Optional[int] = None,
schedules: Optional[Sequence[BuildDefinitionScheduleArgs]] = None,
variable_groups: Optional[Sequence[int]] = None,
variables: Optional[Sequence[BuildDefinitionVariableArgs]] = None) -> BuildDefinition
func GetBuildDefinition(ctx *Context, name string, id IDInput, state *BuildDefinitionState, opts ...ResourceOption) (*BuildDefinition, error)
public static BuildDefinition Get(string name, Input<string> id, BuildDefinitionState? state, CustomResourceOptions? opts = null)
public static BuildDefinition get(String name, Output<String> id, BuildDefinitionState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Agent
Pool stringName The agent pool that should execute the build. Defaults to
Azure Pipelines
.- Ci
Trigger Pulumi.Azure Dev Ops. Inputs. Build Definition Ci Trigger Args Continuous Integration trigger.
- Name string
The name of the build definition.
- Path string
The folder path of the build definition.
- Project
Id string The project ID or project name.
- Pull
Request Pulumi.Trigger Azure Dev Ops. Inputs. Build Definition Pull Request Trigger Args Pull Request Integration Integration trigger.
- Repository
Pulumi.
Azure Dev Ops. Inputs. Build Definition Repository Args A
repository
block as documented below.- Revision int
The revision of the build definition
- Schedules
List<Pulumi.
Azure Dev Ops. Inputs. Build Definition Schedule Args> - Variable
Groups List<int> A list of variable group IDs (integers) to link to the build definition.
- Variables
List<Pulumi.
Azure Dev Ops. Inputs. Build Definition Variable Args> A list of
variable
blocks, as documented below.
- Agent
Pool stringName The agent pool that should execute the build. Defaults to
Azure Pipelines
.- Ci
Trigger BuildDefinition Ci Trigger Args Continuous Integration trigger.
- Name string
The name of the build definition.
- Path string
The folder path of the build definition.
- Project
Id string The project ID or project name.
- Pull
Request BuildTrigger Definition Pull Request Trigger Args Pull Request Integration Integration trigger.
- Repository
Build
Definition Repository Args A
repository
block as documented below.- Revision int
The revision of the build definition
- Schedules
[]Build
Definition Schedule Args - Variable
Groups []int A list of variable group IDs (integers) to link to the build definition.
- Variables
[]Build
Definition Variable Args A list of
variable
blocks, as documented below.
- agent
Pool StringName The agent pool that should execute the build. Defaults to
Azure Pipelines
.- ci
Trigger BuildDefinition Ci Trigger Args Continuous Integration trigger.
- name String
The name of the build definition.
- path String
The folder path of the build definition.
- project
Id String The project ID or project name.
- pull
Request BuildTrigger Definition Pull Request Trigger Args Pull Request Integration Integration trigger.
- repository
Build
Definition Repository Args A
repository
block as documented below.- revision Integer
The revision of the build definition
- schedules
List<Build
Definition Schedule Args> - variable
Groups List<Integer> A list of variable group IDs (integers) to link to the build definition.
- variables
List<Build
Definition Variable Args> A list of
variable
blocks, as documented below.
- agent
Pool stringName The agent pool that should execute the build. Defaults to
Azure Pipelines
.- ci
Trigger BuildDefinition Ci Trigger Args Continuous Integration trigger.
- name string
The name of the build definition.
- path string
The folder path of the build definition.
- project
Id string The project ID or project name.
- pull
Request BuildTrigger Definition Pull Request Trigger Args Pull Request Integration Integration trigger.
- repository
Build
Definition Repository Args A
repository
block as documented below.- revision number
The revision of the build definition
- schedules
Build
Definition Schedule Args[] - variable
Groups number[] A list of variable group IDs (integers) to link to the build definition.
- variables
Build
Definition Variable Args[] A list of
variable
blocks, as documented below.
- agent_
pool_ strname The agent pool that should execute the build. Defaults to
Azure Pipelines
.- ci_
trigger BuildDefinition Ci Trigger Args Continuous Integration trigger.
- name str
The name of the build definition.
- path str
The folder path of the build definition.
- project_
id str The project ID or project name.
- pull_
request_ Buildtrigger Definition Pull Request Trigger Args Pull Request Integration Integration trigger.
- repository
Build
Definition Repository Args A
repository
block as documented below.- revision int
The revision of the build definition
- schedules
Sequence[Build
Definition Schedule Args] - variable_
groups Sequence[int] A list of variable group IDs (integers) to link to the build definition.
- variables
Sequence[Build
Definition Variable Args] A list of
variable
blocks, as documented below.
- agent
Pool StringName The agent pool that should execute the build. Defaults to
Azure Pipelines
.- ci
Trigger Property Map Continuous Integration trigger.
- name String
The name of the build definition.
- path String
The folder path of the build definition.
- project
Id String The project ID or project name.
- pull
Request Property MapTrigger Pull Request Integration Integration trigger.
- repository Property Map
A
repository
block as documented below.- revision Number
The revision of the build definition
- schedules List<Property Map>
- variable
Groups List<Number> A list of variable group IDs (integers) to link to the build definition.
- variables List<Property Map>
A list of
variable
blocks, as documented below.
Supporting Types
BuildDefinitionCiTrigger
- Override
Pulumi.
Azure Dev Ops. Inputs. Build Definition Ci Trigger Override Override the azure-pipeline file and use a this configuration for all builds.
- Use
Yaml bool Use the azure-pipeline file for the build configuration. Defaults to
false
.
- Override
Build
Definition Ci Trigger Override Override the azure-pipeline file and use a this configuration for all builds.
- Use
Yaml bool Use the azure-pipeline file for the build configuration. Defaults to
false
.
- override
Build
Definition Ci Trigger Override Override the azure-pipeline file and use a this configuration for all builds.
- use
Yaml Boolean Use the azure-pipeline file for the build configuration. Defaults to
false
.
- override
Build
Definition Ci Trigger Override Override the azure-pipeline file and use a this configuration for all builds.
- use
Yaml boolean Use the azure-pipeline file for the build configuration. Defaults to
false
.
- override
Build
Definition Ci Trigger Override Override the azure-pipeline file and use a this configuration for all builds.
- use_
yaml bool Use the azure-pipeline file for the build configuration. Defaults to
false
.
- override Property Map
Override the azure-pipeline file and use a this configuration for all builds.
- use
Yaml Boolean Use the azure-pipeline file for the build configuration. Defaults to
false
.
BuildDefinitionCiTriggerOverride
- Batch bool
If you set batch to 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. Defaults to
true
.- Branch
Filters List<Pulumi.Azure Dev Ops. Inputs. Build Definition Ci Trigger Override Branch Filter> The branches to include and exclude from the trigger.
- Max
Concurrent intBuilds Per Branch The number of max builds per branch. Defaults to
1
.- Path
Filters List<Pulumi.Azure Dev Ops. Inputs. Build Definition Ci Trigger Override Path Filter> Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.
- Polling
Interval int How often the external repository is polled. Defaults to
0
.- Polling
Job stringId 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 you set batch to 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. Defaults to
true
.- Branch
Filters []BuildDefinition Ci Trigger Override Branch Filter The branches to include and exclude from the trigger.
- Max
Concurrent intBuilds Per Branch The number of max builds per branch. Defaults to
1
.- Path
Filters []BuildDefinition Ci Trigger Override Path Filter Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.
- Polling
Interval int How often the external repository is polled. Defaults to
0
.- Polling
Job stringId 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 you set batch to 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. Defaults to
true
.- branch
Filters List<BuildDefinition Ci Trigger Override Branch Filter> The branches to include and exclude from the trigger.
- max
Concurrent IntegerBuilds Per Branch The number of max builds per branch. Defaults to
1
.- path
Filters List<BuildDefinition Ci Trigger Override Path Filter> Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.
- polling
Interval Integer How often the external repository is polled. Defaults to
0
.- polling
Job StringId 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 you set batch to 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. Defaults to
true
.- branch
Filters BuildDefinition Ci Trigger Override Branch Filter[] The branches to include and exclude from the trigger.
- max
Concurrent numberBuilds Per Branch The number of max builds per branch. Defaults to
1
.- path
Filters BuildDefinition Ci Trigger Override Path Filter[] Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.
- polling
Interval number How often the external repository is polled. Defaults to
0
.- polling
Job stringId 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 you set batch to 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. Defaults to
true
.- branch_
filters Sequence[BuildDefinition Ci Trigger Override Branch Filter] The branches to include and exclude from the trigger.
- max_
concurrent_ intbuilds_ per_ branch The number of max builds per branch. Defaults to
1
.- path_
filters Sequence[BuildDefinition Ci Trigger Override Path Filter] Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.
- polling_
interval int How often the external repository is polled. Defaults to
0
.- polling_
job_ strid 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 you set batch to 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. Defaults to
true
.- branch
Filters List<Property Map> The branches to include and exclude from the trigger.
- max
Concurrent NumberBuilds Per Branch The number of max builds per branch. Defaults to
1
.- path
Filters List<Property Map> Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.
- polling
Interval Number How often the external repository is polled. Defaults to
0
.- polling
Job StringId This is the ID of the polling job that polls the external repository. Once the build definition is saved/updated, this value is set.
BuildDefinitionCiTriggerOverrideBranchFilter
BuildDefinitionCiTriggerOverridePathFilter
BuildDefinitionPullRequestTrigger
- Forks
Pulumi.
Azure Dev Ops. Inputs. Build Definition Pull Request Trigger Forks Set permissions for Forked repositories.
- Comment
Required string - Initial
Branch string - Override
Pulumi.
Azure Dev Ops. Inputs. Build Definition Pull Request Trigger Override Override the azure-pipeline file and use this configuration for all builds.
- Use
Yaml bool Use the azure-pipeline file for the build configuration. Defaults to
false
.
- Forks
Build
Definition Pull Request Trigger Forks Set permissions for Forked repositories.
- Comment
Required string - Initial
Branch string - Override
Build
Definition Pull Request Trigger Override Override the azure-pipeline file and use this configuration for all builds.
- Use
Yaml bool Use the azure-pipeline file for the build configuration. Defaults to
false
.
- forks
Build
Definition Pull Request Trigger Forks Set permissions for Forked repositories.
- comment
Required String - initial
Branch String - override
Build
Definition Pull Request Trigger Override Override the azure-pipeline file and use this configuration for all builds.
- use
Yaml Boolean Use the azure-pipeline file for the build configuration. Defaults to
false
.
- forks
Build
Definition Pull Request Trigger Forks Set permissions for Forked repositories.
- comment
Required string - initial
Branch string - override
Build
Definition Pull Request Trigger Override Override the azure-pipeline file and use this configuration for all builds.
- use
Yaml boolean Use the azure-pipeline file for the build configuration. Defaults to
false
.
- forks
Build
Definition Pull Request Trigger Forks Set permissions for Forked repositories.
- comment_
required str - initial_
branch str - override
Build
Definition Pull Request Trigger Override Override the azure-pipeline file and use this configuration for all builds.
- use_
yaml bool Use the azure-pipeline file for the build configuration. Defaults to
false
.
- forks Property Map
Set permissions for Forked repositories.
- comment
Required String - initial
Branch String - override Property Map
Override the azure-pipeline file and use this configuration for all builds.
- use
Yaml Boolean Use the azure-pipeline file for the build configuration. Defaults to
false
.
BuildDefinitionPullRequestTriggerForks
- Enabled bool
Build pull requests form forms of this repository.
- bool
Make secrets available to builds of forks.
- Enabled bool
Build pull requests form forms of this repository.
- bool
Make secrets available to builds of forks.
- enabled Boolean
Build pull requests form forms of this repository.
- Boolean
Make secrets available to builds of forks.
- enabled boolean
Build pull requests form forms of this repository.
- boolean
Make secrets available to builds of forks.
- enabled bool
Build pull requests form forms of this repository.
- bool
Make secrets available to builds of forks.
- enabled Boolean
Build pull requests form forms of this repository.
- Boolean
Make secrets available to builds of forks.
BuildDefinitionPullRequestTriggerOverride
- Auto
Cancel bool . Defaults to
true
.- Branch
Filters List<Pulumi.Azure Dev Ops. Inputs. Build Definition Pull Request Trigger Override Branch Filter> The branches to include and exclude from the trigger.
- Path
Filters List<Pulumi.Azure Dev Ops. Inputs. Build Definition Pull Request Trigger Override Path Filter> Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.
- Auto
Cancel bool . Defaults to
true
.- Branch
Filters []BuildDefinition Pull Request Trigger Override Branch Filter The branches to include and exclude from the trigger.
- Path
Filters []BuildDefinition Pull Request Trigger Override Path Filter Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.
- auto
Cancel Boolean . Defaults to
true
.- branch
Filters List<BuildDefinition Pull Request Trigger Override Branch Filter> The branches to include and exclude from the trigger.
- path
Filters List<BuildDefinition Pull Request Trigger Override Path Filter> Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.
- auto
Cancel boolean . Defaults to
true
.- branch
Filters BuildDefinition Pull Request Trigger Override Branch Filter[] The branches to include and exclude from the trigger.
- path
Filters BuildDefinition Pull Request Trigger Override Path Filter[] Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.
- auto_
cancel bool . Defaults to
true
.- branch_
filters Sequence[BuildDefinition Pull Request Trigger Override Branch Filter] The branches to include and exclude from the trigger.
- path_
filters Sequence[BuildDefinition Pull Request Trigger Override Path Filter] Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.
- auto
Cancel Boolean . Defaults to
true
.- branch
Filters List<Property Map> The branches to include and exclude from the trigger.
- path
Filters List<Property Map> Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.
BuildDefinitionPullRequestTriggerOverrideBranchFilter
BuildDefinitionPullRequestTriggerOverridePathFilter
BuildDefinitionRepository
- Repo
Id string The id of the repository. For
TfsGit
repos, this is simply the ID of the repository. ForGithub
repos, this will take the form of<GitHub Org>/<Repo Name>
. ForBitbucket
repos, this will take the form of<Workspace ID>/<Repo Name>
.- Repo
Type string The repository type. Valid values:
GitHub
orTfsGit
orBitbucket
orGitHub Enterprise
. Defaults toGitHub
. Ifrepo_type
isGitHubEnterprise
, must use existing project and GitHub Enterprise service connection.- Yml
Path string The path of the Yaml file describing the build definition.
- Branch
Name string The branch name for which builds are triggered. Defaults to
master
.- Github
Enterprise stringUrl The Github Enterprise URL. Used if
repo_type
isGithubEnterprise
.- Report
Build boolStatus Report build status. Default is true.
- Service
Connection stringId The service connection ID. Used if the
repo_type
isGitHub
orGitHubEnterprise
.
- Repo
Id string The id of the repository. For
TfsGit
repos, this is simply the ID of the repository. ForGithub
repos, this will take the form of<GitHub Org>/<Repo Name>
. ForBitbucket
repos, this will take the form of<Workspace ID>/<Repo Name>
.- Repo
Type string The repository type. Valid values:
GitHub
orTfsGit
orBitbucket
orGitHub Enterprise
. Defaults toGitHub
. Ifrepo_type
isGitHubEnterprise
, must use existing project and GitHub Enterprise service connection.- Yml
Path string The path of the Yaml file describing the build definition.
- Branch
Name string The branch name for which builds are triggered. Defaults to
master
.- Github
Enterprise stringUrl The Github Enterprise URL. Used if
repo_type
isGithubEnterprise
.- Report
Build boolStatus Report build status. Default is true.
- Service
Connection stringId The service connection ID. Used if the
repo_type
isGitHub
orGitHubEnterprise
.
- repo
Id String The id of the repository. For
TfsGit
repos, this is simply the ID of the repository. ForGithub
repos, this will take the form of<GitHub Org>/<Repo Name>
. ForBitbucket
repos, this will take the form of<Workspace ID>/<Repo Name>
.- repo
Type String The repository type. Valid values:
GitHub
orTfsGit
orBitbucket
orGitHub Enterprise
. Defaults toGitHub
. Ifrepo_type
isGitHubEnterprise
, must use existing project and GitHub Enterprise service connection.- yml
Path String The path of the Yaml file describing the build definition.
- branch
Name String The branch name for which builds are triggered. Defaults to
master
.- github
Enterprise StringUrl The Github Enterprise URL. Used if
repo_type
isGithubEnterprise
.- report
Build BooleanStatus Report build status. Default is true.
- service
Connection StringId The service connection ID. Used if the
repo_type
isGitHub
orGitHubEnterprise
.
- repo
Id string The id of the repository. For
TfsGit
repos, this is simply the ID of the repository. ForGithub
repos, this will take the form of<GitHub Org>/<Repo Name>
. ForBitbucket
repos, this will take the form of<Workspace ID>/<Repo Name>
.- repo
Type string The repository type. Valid values:
GitHub
orTfsGit
orBitbucket
orGitHub Enterprise
. Defaults toGitHub
. Ifrepo_type
isGitHubEnterprise
, must use existing project and GitHub Enterprise service connection.- yml
Path string The path of the Yaml file describing the build definition.
- branch
Name string The branch name for which builds are triggered. Defaults to
master
.- github
Enterprise stringUrl The Github Enterprise URL. Used if
repo_type
isGithubEnterprise
.- report
Build booleanStatus Report build status. Default is true.
- service
Connection stringId The service connection ID. Used if the
repo_type
isGitHub
orGitHubEnterprise
.
- repo_
id str The id of the repository. For
TfsGit
repos, this is simply the ID of the repository. ForGithub
repos, this will take the form of<GitHub Org>/<Repo Name>
. ForBitbucket
repos, this will take the form of<Workspace ID>/<Repo Name>
.- repo_
type str The repository type. Valid values:
GitHub
orTfsGit
orBitbucket
orGitHub Enterprise
. Defaults toGitHub
. Ifrepo_type
isGitHubEnterprise
, must use existing project and GitHub Enterprise service connection.- yml_
path str The path of the Yaml file describing the build definition.
- branch_
name str The branch name for which builds are triggered. Defaults to
master
.- github_
enterprise_ strurl The Github Enterprise URL. Used if
repo_type
isGithubEnterprise
.- report_
build_ boolstatus Report build status. Default is true.
- service_
connection_ strid The service connection ID. Used if the
repo_type
isGitHub
orGitHubEnterprise
.
- repo
Id String The id of the repository. For
TfsGit
repos, this is simply the ID of the repository. ForGithub
repos, this will take the form of<GitHub Org>/<Repo Name>
. ForBitbucket
repos, this will take the form of<Workspace ID>/<Repo Name>
.- repo
Type String The repository type. Valid values:
GitHub
orTfsGit
orBitbucket
orGitHub Enterprise
. Defaults toGitHub
. Ifrepo_type
isGitHubEnterprise
, must use existing project and GitHub Enterprise service connection.- yml
Path String The path of the Yaml file describing the build definition.
- branch
Name String The branch name for which builds are triggered. Defaults to
master
.- github
Enterprise StringUrl The Github Enterprise URL. Used if
repo_type
isGithubEnterprise
.- report
Build BooleanStatus Report build status. Default is true.
- service
Connection StringId The service connection ID. Used if the
repo_type
isGitHub
orGitHubEnterprise
.
BuildDefinitionSchedule
- Days
To List<string>Builds - Branch
Filters List<Pulumi.Azure Dev Ops. Inputs. Build Definition Schedule Branch Filter> block supports the following:
- Schedule
Job stringId The ID of the schedule job
- Schedule
Only boolWith Changes - Start
Hours int - Start
Minutes int - Time
Zone string
- Days
To []stringBuilds - Branch
Filters []BuildDefinition Schedule Branch Filter block supports the following:
- Schedule
Job stringId The ID of the schedule job
- Schedule
Only boolWith Changes - Start
Hours int - Start
Minutes int - Time
Zone string
- days
To List<String>Builds - branch
Filters List<BuildDefinition Schedule Branch Filter> block supports the following:
- schedule
Job StringId The ID of the schedule job
- schedule
Only BooleanWith Changes - start
Hours Integer - start
Minutes Integer - time
Zone String
- days
To string[]Builds - branch
Filters BuildDefinition Schedule Branch Filter[] block supports the following:
- schedule
Job stringId The ID of the schedule job
- schedule
Only booleanWith Changes - start
Hours number - start
Minutes number - time
Zone string
- days_
to_ Sequence[str]builds - branch_
filters Sequence[BuildDefinition Schedule Branch Filter] block supports the following:
- schedule_
job_ strid The ID of the schedule job
- schedule_
only_ boolwith_ changes - start_
hours int - start_
minutes int - time_
zone str
- days
To List<String>Builds - branch
Filters List<Property Map> block supports the following:
- schedule
Job StringId The ID of the schedule job
- schedule
Only BooleanWith Changes - start
Hours Number - start
Minutes Number - time
Zone String
BuildDefinitionScheduleBranchFilter
BuildDefinitionVariable
- Name string
The name of the variable.
- Allow
Override bool True if the variable can be overridden. Defaults to
true
.- Is
Secret bool True if the variable is a secret. Defaults to
false
.- Secret
Value string The secret value of the variable. Used when
is_secret
set totrue
.- Value string
The value of the variable.
- Name string
The name of the variable.
- Allow
Override bool True if the variable can be overridden. Defaults to
true
.- Is
Secret bool True if the variable is a secret. Defaults to
false
.- Secret
Value string The secret value of the variable. Used when
is_secret
set totrue
.- Value string
The value of the variable.
- name String
The name of the variable.
- allow
Override Boolean True if the variable can be overridden. Defaults to
true
.- is
Secret Boolean True if the variable is a secret. Defaults to
false
.- secret
Value String The secret value of the variable. Used when
is_secret
set totrue
.- value String
The value of the variable.
- name string
The name of the variable.
- allow
Override boolean True if the variable can be overridden. Defaults to
true
.- is
Secret boolean True if the variable is a secret. Defaults to
false
.- secret
Value string The secret value of the variable. Used when
is_secret
set totrue
.- value string
The value of the variable.
- name str
The name of the variable.
- allow_
override bool True if the variable can be overridden. Defaults to
true
.- is_
secret bool True if the variable is a secret. Defaults to
false
.- secret_
value str The secret value of the variable. Used when
is_secret
set totrue
.- value str
The value of the variable.
- name String
The name of the variable.
- allow
Override Boolean True if the variable can be overridden. Defaults to
true
.- is
Secret Boolean True if the variable is a secret. Defaults to
false
.- secret
Value String The secret value of the variable. Used when
is_secret
set totrue
.- value String
The value of the variable.
Import
Azure DevOps Build Definitions can be imported using the project name/definitions Id or by the project Guid/definitions Id, e.g.
$ pulumi import azuredevops:index/buildDefinition:BuildDefinition example "Example Project"/10
or
$ pulumi import azuredevops:index/buildDefinition:BuildDefinition example 00000000-0000-0000-0000-000000000000/0
Package Details
- Repository
- Azure DevOps pulumi/pulumi-azuredevops
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azuredevops
Terraform Provider.