@pulumi/azuredevops
Version:
A Pulumi package for creating and managing Azure DevOps.
158 lines • 6.09 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.BuildFolderPermissions = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Manages permissions for a Build Folder
*
* > **Note** Permissions can be assigned to group principals and not to single user principals.
*
* ## Example Usage
*
* ### Set specific folder permissions
*
* ```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_readers = azuredevops.getGroupOutput({
* projectId: example.id,
* name: "Readers",
* });
* const exampleBuildFolder = new azuredevops.BuildFolder("example", {
* projectId: example.id,
* path: "\\ExampleFolder",
* description: "ExampleFolder description",
* });
* const exampleBuildFolderPermissions = new azuredevops.BuildFolderPermissions("example", {
* projectId: example.id,
* path: "\\ExampleFolder",
* principal: example_readers.apply(example_readers => example_readers.id),
* permissions: {
* ViewBuilds: "Allow",
* EditBuildQuality: "Allow",
* RetainIndefinitely: "Allow",
* DeleteBuilds: "Deny",
* ManageBuildQualities: "Deny",
* DestroyBuilds: "Deny",
* UpdateBuildInformation: "Deny",
* QueueBuilds: "Allow",
* ManageBuildQueue: "Deny",
* StopBuilds: "Allow",
* ViewBuildDefinition: "Allow",
* EditBuildDefinition: "Deny",
* DeleteBuildDefinition: "Deny",
* AdministerBuildPermissions: "NotSet",
* },
* });
* ```
* ### Set root folder permissions
* ```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_readers = azuredevops.getGroupOutput({
* projectId: example.id,
* name: "Readers",
* });
* const exampleBuildFolderPermissions = new azuredevops.BuildFolderPermissions("example", {
* projectId: example.id,
* path: "\\",
* principal: example_readers.apply(example_readers => example_readers.id),
* permissions: {
* RetainIndefinitely: "Allow",
* },
* });
* ```
*
* ## Relevant Links
*
* * [Azure DevOps Service REST API 7.0 - Security](https://docs.microsoft.com/en-us/rest/api/azure/devops/security/?view=azure-devops-rest-7.0)
*
* ## PAT Permissions Required
*
* - **Project & Team**: vso.security_manage - Grants the ability to read, write, and manage security permissions.
*
* ## Import
*
* The resource does not support import.
*/
class BuildFolderPermissions extends pulumi.CustomResource {
/**
* Get an existing BuildFolderPermissions 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 BuildFolderPermissions(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of BuildFolderPermissions. 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'] === BuildFolderPermissions.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["path"] = state?.path;
resourceInputs["permissions"] = state?.permissions;
resourceInputs["principal"] = state?.principal;
resourceInputs["projectId"] = state?.projectId;
resourceInputs["replace"] = state?.replace;
}
else {
const args = argsOrState;
if (args?.path === undefined && !opts.urn) {
throw new Error("Missing required property 'path'");
}
if (args?.permissions === undefined && !opts.urn) {
throw new Error("Missing required property 'permissions'");
}
if (args?.principal === undefined && !opts.urn) {
throw new Error("Missing required property 'principal'");
}
if (args?.projectId === undefined && !opts.urn) {
throw new Error("Missing required property 'projectId'");
}
resourceInputs["path"] = args?.path;
resourceInputs["permissions"] = args?.permissions;
resourceInputs["principal"] = args?.principal;
resourceInputs["projectId"] = args?.projectId;
resourceInputs["replace"] = args?.replace;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(BuildFolderPermissions.__pulumiType, name, resourceInputs, opts);
}
}
exports.BuildFolderPermissions = BuildFolderPermissions;
/** @internal */
BuildFolderPermissions.__pulumiType = 'azuredevops:index/buildFolderPermissions:BuildFolderPermissions';
//# sourceMappingURL=buildFolderPermissions.js.map