@pulumi/azuredevops
Version:
A Pulumi package for creating and managing Azure DevOps.
137 lines • 5.71 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.BuildDefinitionPermissions = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Manages permissions for a Build Definition
*
* > **Note** Permissions can be assigned to group principals and not to single user principals.
*
* ## 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_readers = azuredevops.getGroupOutput({
* projectId: example.id,
* name: "Readers",
* });
* const exampleGit = new azuredevops.Git("example", {
* projectId: example.id,
* name: "Example Repository",
* initialization: {
* initType: "Clean",
* },
* });
* const exampleBuildDefinition = new azuredevops.BuildDefinition("example", {
* projectId: example.id,
* name: "Example Build Definition",
* path: "\\ExampleFolder",
* ciTrigger: {
* useYaml: true,
* },
* repository: {
* repoType: "TfsGit",
* repoId: exampleGit.id,
* branchName: exampleGit.defaultBranch,
* ymlPath: "azure-pipelines.yml",
* },
* });
* const exampleBuildDefinitionPermissions = new azuredevops.BuildDefinitionPermissions("example", {
* projectId: example.id,
* principal: example_readers.apply(example_readers => example_readers.id),
* buildDefinitionId: exampleBuildDefinition.id,
* permissions: {
* ViewBuilds: "Allow",
* EditBuildQuality: "Deny",
* DeleteBuilds: "Deny",
* StopBuilds: "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 BuildDefinitionPermissions extends pulumi.CustomResource {
/**
* Get an existing BuildDefinitionPermissions 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 BuildDefinitionPermissions(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of BuildDefinitionPermissions. 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'] === BuildDefinitionPermissions.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["buildDefinitionId"] = state ? state.buildDefinitionId : undefined;
resourceInputs["permissions"] = state ? state.permissions : undefined;
resourceInputs["principal"] = state ? state.principal : undefined;
resourceInputs["projectId"] = state ? state.projectId : undefined;
resourceInputs["replace"] = state ? state.replace : undefined;
}
else {
const args = argsOrState;
if ((!args || args.buildDefinitionId === undefined) && !opts.urn) {
throw new Error("Missing required property 'buildDefinitionId'");
}
if ((!args || args.permissions === undefined) && !opts.urn) {
throw new Error("Missing required property 'permissions'");
}
if ((!args || args.principal === undefined) && !opts.urn) {
throw new Error("Missing required property 'principal'");
}
if ((!args || args.projectId === undefined) && !opts.urn) {
throw new Error("Missing required property 'projectId'");
}
resourceInputs["buildDefinitionId"] = args ? args.buildDefinitionId : undefined;
resourceInputs["permissions"] = args ? args.permissions : undefined;
resourceInputs["principal"] = args ? args.principal : undefined;
resourceInputs["projectId"] = args ? args.projectId : undefined;
resourceInputs["replace"] = args ? args.replace : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(BuildDefinitionPermissions.__pulumiType, name, resourceInputs, opts);
}
}
exports.BuildDefinitionPermissions = BuildDefinitionPermissions;
/** @internal */
BuildDefinitionPermissions.__pulumiType = 'azuredevops:index/buildDefinitionPermissions:BuildDefinitionPermissions';
//# sourceMappingURL=buildDefinitionPermissions.js.map