@pulumi/azuredevops
Version:
A Pulumi package for creating and managing Azure DevOps.
140 lines (139 loc) • 4.14 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* Use this data source to access information about an existing Build Definition.
*
* ## Example Usage
*
* ```typescript
* 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);
* ```
*/
export declare function getBuildDefinition(args: GetBuildDefinitionArgs, opts?: pulumi.InvokeOptions): Promise<GetBuildDefinitionResult>;
/**
* A collection of arguments for invoking getBuildDefinition.
*/
export interface GetBuildDefinitionArgs {
/**
* The name of this Build Definition.
*/
name: string;
/**
* The path of the build definition. Default to `\`.
*/
path?: string;
/**
* The ID of the project.
*/
projectId: string;
}
/**
* A collection of values returned by getBuildDefinition.
*/
export interface GetBuildDefinitionResult {
/**
* The agent pool that should execute the build.
*/
readonly agentPoolName: string;
/**
* The Agent Specification to run the pipelines. Example: `windows-2019`, `windows-latest`, `macos-13` etc.
*/
readonly agentSpecification: string;
/**
* A `ciTrigger` block as defined below.
*/
readonly ciTriggers: outputs.GetBuildDefinitionCiTrigger[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The job authorization scope for builds queued against this definition.
*/
readonly jobAuthorizationScope: string;
/**
* A `jobs` blocks as documented below.
*/
readonly jobs: outputs.GetBuildDefinitionJob[];
/**
* The name of the variable.
*/
readonly name: string;
readonly path?: string;
readonly projectId: string;
/**
* A `pullRequestTrigger` block as defined below.
*/
readonly pullRequestTriggers: outputs.GetBuildDefinitionPullRequestTrigger[];
/**
* The queue status of the build definition.
*/
readonly queueStatus: string;
/**
* A `repository` block as defined below.
*/
readonly repositories: outputs.GetBuildDefinitionRepository[];
/**
* The revision of the build definition.
*/
readonly revision: number;
/**
* A `schedules` block as defined below.
*/
readonly schedules: outputs.GetBuildDefinitionSchedule[];
/**
* A list of variable group IDs.
*/
readonly variableGroups: number[];
/**
* A `variable` block as defined below.
*/
readonly variables: outputs.GetBuildDefinitionVariable[];
}
/**
* Use this data source to access information about an existing Build Definition.
*
* ## Example Usage
*
* ```typescript
* 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);
* ```
*/
export declare function getBuildDefinitionOutput(args: GetBuildDefinitionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetBuildDefinitionResult>;
/**
* A collection of arguments for invoking getBuildDefinition.
*/
export interface GetBuildDefinitionOutputArgs {
/**
* The name of this Build Definition.
*/
name: pulumi.Input<string>;
/**
* The path of the build definition. Default to `\`.
*/
path?: pulumi.Input<string>;
/**
* The ID of the project.
*/
projectId: pulumi.Input<string>;
}