Docs Packages
  1. Packages
  2. AzureDevOps
  3. API Docs
  4. BuildFolder
Azure DevOps v3.1.1 published on Monday, May 20, 2024 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.BuildFolder

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.1.1 published on Monday, May 20, 2024 by Pulumi
pulumi/pulumi-azuredevops

    Manages a Build Folder.

    Example Usage

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

const example = new azuredevops.Project("example", {
    name: "Example Project",
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
});
const exampleBuildFolder = new azuredevops.BuildFolder("example", {
    projectId: example.id,
    path: "\\ExampleFolder",
    description: "ExampleFolder description",
});

    import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.Project("example",
    name="Example Project",
    visibility="private",
    version_control="Git",
    work_item_template="Agile")
example_build_folder = azuredevops.BuildFolder("example",
    project_id=example.id,
    path="\\ExampleFolder",
    description="ExampleFolder description")

    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.NewProject(ctx, "example", &azuredevops.ProjectArgs{
			Name:             pulumi.String("Example Project"),
			Visibility:       pulumi.String("private"),
			VersionControl:   pulumi.String("Git"),
			WorkItemTemplate: pulumi.String("Agile"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewBuildFolder(ctx, "example", &azuredevops.BuildFolderArgs{
			ProjectId:   example.ID(),
			Path:        pulumi.String("\\ExampleFolder"),
			Description: pulumi.String("ExampleFolder description"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new AzureDevOps.Project("example", new()
    {
        Name = "Example Project",
        Visibility = "private",
        VersionControl = "Git",
        WorkItemTemplate = "Agile",
    });

    var exampleBuildFolder = new AzureDevOps.BuildFolder("example", new()
    {
        ProjectId = example.Id,
        Path = "\\ExampleFolder",
        Description = "ExampleFolder description",
    });

});

    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.BuildFolder;
import com.pulumi.azuredevops.BuildFolderArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Project("example", ProjectArgs.builder()        
            .name("Example Project")
            .visibility("private")
            .versionControl("Git")
            .workItemTemplate("Agile")
            .build());

        var exampleBuildFolder = new BuildFolder("exampleBuildFolder", BuildFolderArgs.builder()        
            .projectId(example.id())
            .path("\\ExampleFolder")
            .description("ExampleFolder description")
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
  exampleBuildFolder:
    type: azuredevops:BuildFolder
    name: example
    properties:
      projectId: ${example.id}
      path: \ExampleFolder
      description: ExampleFolder description

    Create BuildFolder Resource

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

    Constructor syntax

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

@overload
def BuildFolder(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                path: Optional[str] = None,
                project_id: Optional[str] = None,
                description: Optional[str] = None)
    func NewBuildFolder(ctx *Context, name string, args BuildFolderArgs, opts ...ResourceOption) (*BuildFolder, error)
    public BuildFolder(string name, BuildFolderArgs args, CustomResourceOptions? opts = null)
    public BuildFolder(String name, BuildFolderArgs args)
public BuildFolder(String name, BuildFolderArgs args, CustomResourceOptions options)

    type: azuredevops:BuildFolder
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BuildFolderArgs
    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 BuildFolderArgs
    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 BuildFolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BuildFolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BuildFolderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var buildFolderResource = new AzureDevOps.BuildFolder("buildFolderResource", new()
{
    Path = "string",
    ProjectId = "string",
    Description = "string",
});

    example, err := azuredevops.NewBuildFolder(ctx, "buildFolderResource", &azuredevops.BuildFolderArgs{
	Path:        pulumi.String("string"),
	ProjectId:   pulumi.String("string"),
	Description: pulumi.String("string"),
})

    var buildFolderResource = new BuildFolder("buildFolderResource", BuildFolderArgs.builder()
    .path("string")
    .projectId("string")
    .description("string")
    .build());

    build_folder_resource = azuredevops.BuildFolder("buildFolderResource",
    path="string",
    project_id="string",
    description="string")

    const buildFolderResource = new azuredevops.BuildFolder("buildFolderResource", {
    path: "string",
    projectId: "string",
    description: "string",
});

    type: azuredevops:BuildFolder
properties:
    description: string
    path: string
    projectId: string

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

    Path string
    The folder path.
    ProjectId string
    The ID of the project in which the folder will be created.
    Description string
    Folder Description.
    Path string
    The folder path.
    ProjectId string
    The ID of the project in which the folder will be created.
    Description string
    Folder Description.
    path String
    The folder path.
    projectId String
    The ID of the project in which the folder will be created.
    description String
    Folder Description.
    path string
    The folder path.
    projectId string
    The ID of the project in which the folder will be created.
    description string
    Folder Description.
    path str
    The folder path.
    project_id str
    The ID of the project in which the folder will be created.
    description str
    Folder Description.
    path String
    The folder path.
    projectId String
    The ID of the project in which the folder will be created.
    description String
    Folder Description.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BuildFolder Resource

    Get an existing BuildFolder 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?: BuildFolderState, opts?: CustomResourceOptions): BuildFolder
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        path: Optional[str] = None,
        project_id: Optional[str] = None) -> BuildFolder
    func GetBuildFolder(ctx *Context, name string, id IDInput, state *BuildFolderState, opts ...ResourceOption) (*BuildFolder, error)
    public static BuildFolder Get(string name, Input<string> id, BuildFolderState? state, CustomResourceOptions? opts = null)
    public static BuildFolder get(String name, Output<String> id, BuildFolderState 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.
    The following state arguments are supported:
    Description string
    Folder Description.
    Path string
    The folder path.
    ProjectId string
    The ID of the project in which the folder will be created.
    Description string
    Folder Description.
    Path string
    The folder path.
    ProjectId string
    The ID of the project in which the folder will be created.
    description String
    Folder Description.
    path String
    The folder path.
    projectId String
    The ID of the project in which the folder will be created.
    description string
    Folder Description.
    path string
    The folder path.
    projectId string
    The ID of the project in which the folder will be created.
    description str
    Folder Description.
    path str
    The folder path.
    project_id str
    The ID of the project in which the folder will be created.
    description String
    Folder Description.
    path String
    The folder path.
    projectId String
    The ID of the project in which the folder will be created.

    Import

    Build Folders can be imported using the project name/path or project id/path, e.g.

    $ pulumi import azuredevops:index/buildFolder:BuildFolder example "Example Project/\\ExampleFolder"

    or

    $ pulumi import azuredevops:index/buildFolder:BuildFolder example 00000000-0000-0000-0000-000000000000/\\ExampleFolder

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

    Package Details

    Repository
    Azure DevOps pulumi/pulumi-azuredevops
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuredevops Terraform Provider.
    azuredevops logo
    Azure DevOps v3.1.1 published on Monday, May 20, 2024 by Pulumi
    pulumi/pulumi-azuredevops