UNPKG

@pulumi/azuredevops

Version:

A Pulumi package for creating and managing Azure DevOps.

221 lines (220 loc) 11.8 kB
import * as pulumi from "@pulumi/pulumi"; /** * Manages permissions for a AzureDevOps project * * > **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", * visibility: "private", * versionControl: "Git", * workItemTemplate: "Agile", * description: "Managed by Pulumi", * }); * const example_readers = azuredevops.getGroupOutput({ * projectId: example.id, * name: "Readers", * }); * const example_permission = new azuredevops.ProjectPermissions("example-permission", { * projectId: example.id, * principal: example_readers.apply(example_readers => example_readers.id), * permissions: { * DELETE: "Deny", * EDIT_BUILD_STATUS: "NotSet", * WORK_ITEM_MOVE: "Allow", * DELETE_TEST_RESULTS: "Deny", * }, * }); * ``` * * ## 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. */ export declare class ProjectPermissions extends pulumi.CustomResource { /** * Get an existing ProjectPermissions 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: string, id: pulumi.Input<pulumi.ID>, state?: ProjectPermissionsState, opts?: pulumi.CustomResourceOptions): ProjectPermissions; /** * Returns true if the given object is an instance of ProjectPermissions. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is ProjectPermissions; /** * the permissions to assign. The following permissions are available * * | Permission | Description | * |------------------------------|----------------------------------------------| * | GENERIC_READ | View project-level information | * | GENERIC_WRITE | Edit project-level information | * | DELETE | Delete team project | * | PUBLISH_TEST_RESULTS | Create test runs | * | ADMINISTER_BUILD | Administer a build | * | START_BUILD | Start a build | * | EDIT_BUILD_STATUS | Edit build quality | * | UPDATE_BUILD | Write to build operational store | * | DELETE_TEST_RESULTS | Delete test runs | * | VIEW_TEST_RESULTS | View test runs | * | MANAGE_TEST_ENVIRONMENTS | Manage test environments | * | MANAGE_TEST_CONFIGURATIONS | Manage test configurations | * | WORK_ITEM_DELETE | Delete and restore work items | * | WORK_ITEM_MOVE | Move work items out of this project | * | WORK_ITEM_PERMANENTLY_DELETE | Permanently delete work items | * | RENAME | Rename team project | * | MANAGE_PROPERTIES | Manage project properties | * | MANAGE_SYSTEM_PROPERTIES | Manage system project properties | * | BYPASS_PROPERTY_CACHE | Bypass project property cache | * | BYPASS_RULES | Bypass rules on work item updates | * | SUPPRESS_NOTIFICATIONS | Suppress notifications for work item updates | * | UPDATE_VISIBILITY | Update project visibility | * | CHANGE_PROCESS | Change process of team project. | * | AGILETOOLS_BACKLOG | Agile backlog management. | * | AGILETOOLS_PLANS | Agile plans. | */ readonly permissions: pulumi.Output<{ [key: string]: string; }>; /** * The `group` principal to assign the permissions. */ readonly principal: pulumi.Output<string>; /** * The ID of the project to assign the permissions. */ readonly projectId: pulumi.Output<string>; /** * Replace (`true`) or merge (`false`) the permissions. Default: `true` */ readonly replace: pulumi.Output<boolean | undefined>; /** * Create a ProjectPermissions resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ProjectPermissionsArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ProjectPermissions resources. */ export interface ProjectPermissionsState { /** * the permissions to assign. The following permissions are available * * | Permission | Description | * |------------------------------|----------------------------------------------| * | GENERIC_READ | View project-level information | * | GENERIC_WRITE | Edit project-level information | * | DELETE | Delete team project | * | PUBLISH_TEST_RESULTS | Create test runs | * | ADMINISTER_BUILD | Administer a build | * | START_BUILD | Start a build | * | EDIT_BUILD_STATUS | Edit build quality | * | UPDATE_BUILD | Write to build operational store | * | DELETE_TEST_RESULTS | Delete test runs | * | VIEW_TEST_RESULTS | View test runs | * | MANAGE_TEST_ENVIRONMENTS | Manage test environments | * | MANAGE_TEST_CONFIGURATIONS | Manage test configurations | * | WORK_ITEM_DELETE | Delete and restore work items | * | WORK_ITEM_MOVE | Move work items out of this project | * | WORK_ITEM_PERMANENTLY_DELETE | Permanently delete work items | * | RENAME | Rename team project | * | MANAGE_PROPERTIES | Manage project properties | * | MANAGE_SYSTEM_PROPERTIES | Manage system project properties | * | BYPASS_PROPERTY_CACHE | Bypass project property cache | * | BYPASS_RULES | Bypass rules on work item updates | * | SUPPRESS_NOTIFICATIONS | Suppress notifications for work item updates | * | UPDATE_VISIBILITY | Update project visibility | * | CHANGE_PROCESS | Change process of team project. | * | AGILETOOLS_BACKLOG | Agile backlog management. | * | AGILETOOLS_PLANS | Agile plans. | */ permissions?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * The `group` principal to assign the permissions. */ principal?: pulumi.Input<string>; /** * The ID of the project to assign the permissions. */ projectId?: pulumi.Input<string>; /** * Replace (`true`) or merge (`false`) the permissions. Default: `true` */ replace?: pulumi.Input<boolean>; } /** * The set of arguments for constructing a ProjectPermissions resource. */ export interface ProjectPermissionsArgs { /** * the permissions to assign. The following permissions are available * * | Permission | Description | * |------------------------------|----------------------------------------------| * | GENERIC_READ | View project-level information | * | GENERIC_WRITE | Edit project-level information | * | DELETE | Delete team project | * | PUBLISH_TEST_RESULTS | Create test runs | * | ADMINISTER_BUILD | Administer a build | * | START_BUILD | Start a build | * | EDIT_BUILD_STATUS | Edit build quality | * | UPDATE_BUILD | Write to build operational store | * | DELETE_TEST_RESULTS | Delete test runs | * | VIEW_TEST_RESULTS | View test runs | * | MANAGE_TEST_ENVIRONMENTS | Manage test environments | * | MANAGE_TEST_CONFIGURATIONS | Manage test configurations | * | WORK_ITEM_DELETE | Delete and restore work items | * | WORK_ITEM_MOVE | Move work items out of this project | * | WORK_ITEM_PERMANENTLY_DELETE | Permanently delete work items | * | RENAME | Rename team project | * | MANAGE_PROPERTIES | Manage project properties | * | MANAGE_SYSTEM_PROPERTIES | Manage system project properties | * | BYPASS_PROPERTY_CACHE | Bypass project property cache | * | BYPASS_RULES | Bypass rules on work item updates | * | SUPPRESS_NOTIFICATIONS | Suppress notifications for work item updates | * | UPDATE_VISIBILITY | Update project visibility | * | CHANGE_PROCESS | Change process of team project. | * | AGILETOOLS_BACKLOG | Agile backlog management. | * | AGILETOOLS_PLANS | Agile plans. | */ permissions: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * The `group` principal to assign the permissions. */ principal: pulumi.Input<string>; /** * The ID of the project to assign the permissions. */ projectId: pulumi.Input<string>; /** * Replace (`true`) or merge (`false`) the permissions. Default: `true` */ replace?: pulumi.Input<boolean>; }