@pulumi/azuredevops/getIteration.js

A Pulumi package for creating and managing Azure DevOps.

"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getIterationOutput = exports.getIteration = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * Use this data source to access information about an existing Iteration (Sprint) within Azure DevOps.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuredevops from "@pulumi/azuredevops";
 *
 * const example = new azuredevops.Project("example", {
 *     name: "Example Project",
 *     workItemTemplate: "Agile",
 *     versionControl: "Git",
 *     visibility: "private",
 *     description: "Managed by Pulumi",
 * });
 * const example_root_iteration = azuredevops.getIterationOutput({
 *     projectId: example.id,
 *     path: "/",
 *     fetchChildren: true,
 * });
 * const example_child_iteration = azuredevops.getIterationOutput({
 *     projectId: example.id,
 *     path: "/Iteration 1",
 *     fetchChildren: true,
 * });
 * ```
 *
 * ## Relevant Links
 *
 * - [Azure DevOps Service REST API 7.0 - Classification Nodes - Get Classification Nodes](https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/classification-nodes/get-classification-nodes?view=azure-devops-rest-7.0)
 *
 * ## PAT Permissions Required
 *
 * - **Project & Team**: vso.work - Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks.
 */
function getIteration(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("azuredevops:index/getIteration:getIteration", {
        "fetchChildren": args.fetchChildren,
        "path": args.path,
        "projectId": args.projectId,
    }, opts);
}
exports.getIteration = getIteration;
/**
 * Use this data source to access information about an existing Iteration (Sprint) within Azure DevOps.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuredevops from "@pulumi/azuredevops";
 *
 * const example = new azuredevops.Project("example", {
 *     name: "Example Project",
 *     workItemTemplate: "Agile",
 *     versionControl: "Git",
 *     visibility: "private",
 *     description: "Managed by Pulumi",
 * });
 * const example_root_iteration = azuredevops.getIterationOutput({
 *     projectId: example.id,
 *     path: "/",
 *     fetchChildren: true,
 * });
 * const example_child_iteration = azuredevops.getIterationOutput({
 *     projectId: example.id,
 *     path: "/Iteration 1",
 *     fetchChildren: true,
 * });
 * ```
 *
 * ## Relevant Links
 *
 * - [Azure DevOps Service REST API 7.0 - Classification Nodes - Get Classification Nodes](https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/classification-nodes/get-classification-nodes?view=azure-devops-rest-7.0)
 *
 * ## PAT Permissions Required
 *
 * - **Project & Team**: vso.work - Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks.
 */
function getIterationOutput(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("azuredevops:index/getIteration:getIteration", {
        "fetchChildren": args.fetchChildren,
        "path": args.path,
        "projectId": args.projectId,
    }, opts);
}
exports.getIterationOutput = getIterationOutput;
//# sourceMappingURL=getIteration.js.map