Module Core

This page documents the language specification for the azuredevops package. If you're looking for help working with the inputs, outputs, or functions of azuredevops resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Resource Project

class Project extends CustomResource

Manages a project within Azure DevOps.

Example Usage

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

const project = new azuredevops.Core.Project("project", {
    description: "Test Project Description",
    features: {
        artifacts: "disabled",
        testplans: "disabled",
    },
    projectName: "Test Project",
    versionControl: "Git",
    visibility: "private",
    workItemTemplate: "Agile",
});

Relevant Links

Azure DevOps Service REST API 5.1 - Projects

PAT Permissions Required

Project & Team: Read, Write, & Manage

constructor

new Project(name: string, args: ProjectArgs, opts?: pulumi.CustomResourceOptions)

Create a Project resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectState, opts?: pulumi.CustomResourceOptions): Project

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Project

Returns true if the given object is an instance of Project. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

The Description of the Project.

property features

public features: pulumi.Output<{[key: string]: string} | undefined>;

Defines the status (enabled, disabled) of the project features. Valid features boards, repositories, pipelines, testplans, artifacts

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property processTemplateId

public processTemplateId: pulumi.Output<string>;

The Process Template ID used by the Project.

property projectName

public projectName: pulumi.Output<string>;

The Project Name.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property versionControl

public versionControl: pulumi.Output<string | undefined>;

Specifies the version control system. Valid values: Git or Tfvc. Defaults to Git.

property visibility

public visibility: pulumi.Output<string | undefined>;

Specifies the visibility of the Project. Valid values: private or public. Defaults to private.

property workItemTemplate

public workItemTemplate: pulumi.Output<string | undefined>;

Specifies the work item template. Defaults to Agile.

Resource ProjectFeatures

class ProjectFeatures extends CustomResource

Manages features for Azure DevOps projects

Example Usage

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

const tf-project-test-001 = azuredevops.Core.getProject({
    projectName: "Test Project",
});
const my_project_features = new azuredevops.Core.ProjectFeatures("my-project-features", {
    projectId: tf_project_test_001.then(tf_project_test_001 => tf_project_test_001.id),
    features: {
        testplans: "disabled",
        artifacts: "enabled",
    },
});

Relevant Links

No official documentation available

PAT Permissions Required

Project & Team: Read, Write, & Manage

constructor

new ProjectFeatures(name: string, args: ProjectFeaturesArgs, opts?: pulumi.CustomResourceOptions)

Create a ProjectFeatures resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectFeaturesState, opts?: pulumi.CustomResourceOptions): ProjectFeatures

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectFeatures

Returns true if the given object is an instance of ProjectFeatures. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property features

public features: pulumi.Output<{[key: string]: string}>;

Defines the status (enabled, disabled) of the project features. Valid features boards, repositories, pipelines, testplans, artifacts

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property projectId

public projectId: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getClientConfig

getClientConfig(opts?: pulumi.InvokeOptions): Promise<GetClientConfigResult>

Use this data source to access information about the Azure DevOps organization configured for the provider.

Example Usage

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

const clientConfig = azuredevops.Core.getClientConfig({});
export const orgUrl = clientConfig.then(clientConfig => clientConfig.organizationUrl);

Function getProject

getProject(args: GetProjectArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectResult>

Use this data source to access information about an existing Project within Azure DevOps.

Example Usage

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

const project = azuredevops.Core.getProject({
    projectName: "Sample Project",
});
export const id = project.then(project => project.id);
export const projectName = project.then(project => project.projectName);
export const visibility = project.then(project => project.visibility);
export const versionControl = project.then(project => project.versionControl);
export const workItemTemplate = project.then(project => project.workItemTemplate);
export const processTemplateId = project.then(project => project.processTemplateId);

Relevant Links

Azure DevOps Service REST API 5.1 - Projects - Get

Function getProjects

getProjects(args?: GetProjectsArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectsResult>

Use this data source to access information about existing Projects within Azure DevOps.

Example Usage

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

const test = azuredevops.Core.getProjects({
    projectName: "contoso",
    state: "wellFormed",
});
export const projectId = test.then(test => test.projects.map(__item => __item.projectId));
export const projectName = test.then(test => test.projects.map(__item => __item.name));
export const projectUrl = test.then(test => test.projects.map(__item => __item.projectUrl));
export const state = test.then(test => test.projects.map(__item => __item.state));

Relevant Links

Azure DevOps Service REST API 5.1 - Projects - Get

Others

interface GetClientConfigResult

interface GetClientConfigResult

A collection of values returned by getClientConfig.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property organizationUrl

organizationUrl: string;

interface GetProjectArgs

interface GetProjectArgs

A collection of arguments for invoking getProject.

property projectName

projectName: string;

interface GetProjectResult

interface GetProjectResult

A collection of values returned by getProject.

property description

description: string;

property features

features: {[key: string]: any};

property id

id: string;

The provider-assigned unique ID for this managed resource.

property processTemplateId

processTemplateId: string;

property projectName

projectName: string;

property versionControl

versionControl: string;

property visibility

visibility: string;

property workItemTemplate

workItemTemplate: string;

interface GetProjectsArgs

interface GetProjectsArgs

A collection of arguments for invoking getProjects.

property projectName

projectName?: undefined | string;

property state

state?: undefined | string;

interface GetProjectsResult

interface GetProjectsResult

A collection of values returned by getProjects.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property projectName

projectName?: undefined | string;

property projects

projects: GetProjectsProject[];

property state

state?: undefined | string;

interface ProjectArgs

interface ProjectArgs

The set of arguments for constructing a Project resource.

property description

description?: pulumi.Input<string>;

The Description of the Project.

property features

features?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Defines the status (enabled, disabled) of the project features. Valid features boards, repositories, pipelines, testplans, artifacts

property projectName

projectName: pulumi.Input<string>;

The Project Name.

property versionControl

versionControl?: pulumi.Input<string>;

Specifies the version control system. Valid values: Git or Tfvc. Defaults to Git.

property visibility

visibility?: pulumi.Input<string>;

Specifies the visibility of the Project. Valid values: private or public. Defaults to private.

property workItemTemplate

workItemTemplate?: pulumi.Input<string>;

Specifies the work item template. Defaults to Agile.

interface ProjectFeaturesArgs

interface ProjectFeaturesArgs

The set of arguments for constructing a ProjectFeatures resource.

property features

features: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Defines the status (enabled, disabled) of the project features. Valid features boards, repositories, pipelines, testplans, artifacts

property projectId

projectId: pulumi.Input<string>;

interface ProjectFeaturesState

interface ProjectFeaturesState

Input properties used for looking up and filtering ProjectFeatures resources.

property features

features?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Defines the status (enabled, disabled) of the project features. Valid features boards, repositories, pipelines, testplans, artifacts

property projectId

projectId?: pulumi.Input<string>;

interface ProjectState

interface ProjectState

Input properties used for looking up and filtering Project resources.

property description

description?: pulumi.Input<string>;

The Description of the Project.

property features

features?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Defines the status (enabled, disabled) of the project features. Valid features boards, repositories, pipelines, testplans, artifacts

property processTemplateId

processTemplateId?: pulumi.Input<string>;

The Process Template ID used by the Project.

property projectName

projectName?: pulumi.Input<string>;

The Project Name.

property versionControl

versionControl?: pulumi.Input<string>;

Specifies the version control system. Valid values: Git or Tfvc. Defaults to Git.

property visibility

visibility?: pulumi.Input<string>;

Specifies the visibility of the Project. Valid values: private or public. Defaults to private.

property workItemTemplate

workItemTemplate?: pulumi.Input<string>;

Specifies the work item template. Defaults to Agile.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module Core

Resources

Functions

Others

Resources

Example Usage

Relevant Links

PAT Permissions Required

Example Usage

Relevant Links

PAT Permissions Required

Functions

Example Usage

Example Usage

Relevant Links

Example Usage

Relevant Links

Others