@pulumi/azuredevops
Version:
A Pulumi package for creating and managing Azure DevOps.
116 lines • 4.29 kB
JavaScript
;
// *** 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.WorkitemqueryFolder = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Manages a Work Item Query Folder in Azure DevOps.
*
* Folders allow you to organize queries in a hierarchy beneath either the `Shared Queries` or `My Queries` root folder (area).
* You must provide exactly one of `area` (either `Shared Queries` or `My Queries`) or `parentId` (an existing folder's ID) when creating a folder.
*
* ## Example Usage
*
* ### Basic folder under Shared Queries
*
* ```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 teamFolder = new azuredevops.WorkitemqueryFolder("team_folder", {
* projectId: example.id,
* name: "Team",
* area: "Shared Queries",
* });
* ```
*
* ### Nested folder
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuredevops from "@pulumi/azuredevops";
*
* const parent = new azuredevops.WorkitemqueryFolder("parent", {
* projectId: example.id,
* name: "Parent",
* area: "Shared Queries",
* });
* const child = new azuredevops.WorkitemqueryFolder("child", {
* projectId: example.id,
* name: "Child",
* parentId: parent.id,
* });
* ```
*
* ## Relevant Links
*
* * [Azure DevOps REST API - Work Item Query (Queries)](https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/queries?view=azure-devops-rest-7.1)
*
* ## PAT Permissions Required
*
* * **Work Items**: Read & Write
*
* ## Import
*
* The resource does not support import.
*/
class WorkitemqueryFolder extends pulumi.CustomResource {
/**
* Get an existing WorkitemqueryFolder resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new WorkitemqueryFolder(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of WorkitemqueryFolder. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === WorkitemqueryFolder.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["area"] = state?.area;
resourceInputs["name"] = state?.name;
resourceInputs["parentId"] = state?.parentId;
resourceInputs["projectId"] = state?.projectId;
}
else {
const args = argsOrState;
if (args?.projectId === undefined && !opts.urn) {
throw new Error("Missing required property 'projectId'");
}
resourceInputs["area"] = args?.area;
resourceInputs["name"] = args?.name;
resourceInputs["parentId"] = args?.parentId;
resourceInputs["projectId"] = args?.projectId;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(WorkitemqueryFolder.__pulumiType, name, resourceInputs, opts);
}
}
exports.WorkitemqueryFolder = WorkitemqueryFolder;
/** @internal */
WorkitemqueryFolder.__pulumiType = 'azuredevops:index/workitemqueryFolder:WorkitemqueryFolder';
//# sourceMappingURL=workitemqueryFolder.js.map