azuredevops logo
Azure DevOps v2.7.0, Mar 27 23

azuredevops.ProjectPermissions

Explore with Pulumi AI

Manages permissions for a AzureDevOps project

Note Permissions can be assigned to group principals and not to single user principals.

PAT Permissions Required

  • Project & Team: vso.security_manage - Grants the ability to read, write, and manage security permissions.

Example Usage

using System.Collections.Generic;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var example = new AzureDevOps.Project("example", new()
    {
        Visibility = "private",
        VersionControl = "Git",
        WorkItemTemplate = "Agile",
        Description = "Managed by Terraform",
    });

    var example_readers = AzureDevOps.GetGroup.Invoke(new()
    {
        ProjectId = example.Id,
        Name = "Readers",
    });

    var example_permission = new AzureDevOps.ProjectPermissions("example-permission", new()
    {
        ProjectId = example.Id,
        Principal = example_readers.Apply(example_readers => example_readers.Apply(getGroupResult => getGroupResult.Id)),
        Permissions = 
        {
            { "DELETE", "Deny" },
            { "EDIT_BUILD_STATUS", "NotSet" },
            { "WORK_ITEM_MOVE", "Allow" },
            { "DELETE_TEST_RESULTS", "Deny" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuredevops.NewProject(ctx, "example", &azuredevops.ProjectArgs{
			Visibility:       pulumi.String("private"),
			VersionControl:   pulumi.String("Git"),
			WorkItemTemplate: pulumi.String("Agile"),
			Description:      pulumi.String("Managed by Terraform"),
		})
		if err != nil {
			return err
		}
		example_readers := azuredevops.LookupGroupOutput(ctx, azuredevops.GetGroupOutputArgs{
			ProjectId: example.ID(),
			Name:      pulumi.String("Readers"),
		}, nil)
		_, err = azuredevops.NewProjectPermissions(ctx, "example-permission", &azuredevops.ProjectPermissionsArgs{
			ProjectId: example.ID(),
			Principal: example_readers.ApplyT(func(example_readers azuredevops.GetGroupResult) (*string, error) {
				return &example_readers.Id, nil
			}).(pulumi.StringPtrOutput),
			Permissions: pulumi.StringMap{
				"DELETE":              pulumi.String("Deny"),
				"EDIT_BUILD_STATUS":   pulumi.String("NotSet"),
				"WORK_ITEM_MOVE":      pulumi.String("Allow"),
				"DELETE_TEST_RESULTS": pulumi.String("Deny"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Project;
import com.pulumi.azuredevops.ProjectArgs;
import com.pulumi.azuredevops.AzuredevopsFunctions;
import com.pulumi.azuredevops.inputs.GetGroupArgs;
import com.pulumi.azuredevops.ProjectPermissions;
import com.pulumi.azuredevops.ProjectPermissionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Project("example", ProjectArgs.builder()        
            .visibility("private")
            .versionControl("Git")
            .workItemTemplate("Agile")
            .description("Managed by Terraform")
            .build());

        final var example-readers = AzuredevopsFunctions.getGroup(GetGroupArgs.builder()
            .projectId(example.id())
            .name("Readers")
            .build());

        var example_permission = new ProjectPermissions("example-permission", ProjectPermissionsArgs.builder()        
            .projectId(example.id())
            .principal(example_readers.applyValue(example_readers -> example_readers.id()))
            .permissions(Map.ofEntries(
                Map.entry("DELETE", "Deny"),
                Map.entry("EDIT_BUILD_STATUS", "NotSet"),
                Map.entry("WORK_ITEM_MOVE", "Allow"),
                Map.entry("DELETE_TEST_RESULTS", "Deny")
            ))
            .build());

    }
}
import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.Project("example",
    visibility="private",
    version_control="Git",
    work_item_template="Agile",
    description="Managed by Terraform")
example_readers = azuredevops.get_group_output(project_id=example.id,
    name="Readers")
example_permission = azuredevops.ProjectPermissions("example-permission",
    project_id=example.id,
    principal=example_readers.id,
    permissions={
        "DELETE": "Deny",
        "EDIT_BUILD_STATUS": "NotSet",
        "WORK_ITEM_MOVE": "Allow",
        "DELETE_TEST_RESULTS": "Deny",
    })
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const example = new azuredevops.Project("example", {
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
    description: "Managed by Terraform",
});
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",
    },
});
resources:
  example:
    type: azuredevops:Project
    properties:
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Terraform
  example-permission:
    type: azuredevops:ProjectPermissions
    properties:
      projectId: ${example.id}
      principal: ${["example-readers"].id}
      permissions:
        DELETE: Deny
        EDIT_BUILD_STATUS: NotSet
        WORK_ITEM_MOVE: Allow
        DELETE_TEST_RESULTS: Deny
variables:
  example-readers:
    fn::invoke:
      Function: azuredevops:getGroup
      Arguments:
        projectId: ${example.id}
        name: Readers

Create ProjectPermissions Resource

new ProjectPermissions(name: string, args: ProjectPermissionsArgs, opts?: CustomResourceOptions);
@overload
def ProjectPermissions(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       permissions: Optional[Mapping[str, str]] = None,
                       principal: Optional[str] = None,
                       project_id: Optional[str] = None,
                       replace: Optional[bool] = None)
@overload
def ProjectPermissions(resource_name: str,
                       args: ProjectPermissionsArgs,
                       opts: Optional[ResourceOptions] = None)
func NewProjectPermissions(ctx *Context, name string, args ProjectPermissionsArgs, opts ...ResourceOption) (*ProjectPermissions, error)
public ProjectPermissions(string name, ProjectPermissionsArgs args, CustomResourceOptions? opts = null)
public ProjectPermissions(String name, ProjectPermissionsArgs args)
public ProjectPermissions(String name, ProjectPermissionsArgs args, CustomResourceOptions options)
type: azuredevops:ProjectPermissions
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ProjectPermissionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ProjectPermissionsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ProjectPermissionsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ProjectPermissionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ProjectPermissionsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ProjectPermissions Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ProjectPermissions resource accepts the following input properties:

Permissions Dictionary<string, string>

the permissions to assign. The following permissions are available

Principal string

The group principal to assign the permissions.

ProjectId string

The ID of the project to assign the permissions.

Replace bool

Replace (true) or merge (false) the permissions. Default: true

Permissions map[string]string

the permissions to assign. The following permissions are available

Principal string

The group principal to assign the permissions.

ProjectId string

The ID of the project to assign the permissions.

Replace bool

Replace (true) or merge (false) the permissions. Default: true

permissions Map<String,String>

the permissions to assign. The following permissions are available

principal String

The group principal to assign the permissions.

projectId String

The ID of the project to assign the permissions.

replace Boolean

Replace (true) or merge (false) the permissions. Default: true

permissions {[key: string]: string}

the permissions to assign. The following permissions are available

principal string

The group principal to assign the permissions.

projectId string

The ID of the project to assign the permissions.

replace boolean

Replace (true) or merge (false) the permissions. Default: true

permissions Mapping[str, str]

the permissions to assign. The following permissions are available

principal str

The group principal to assign the permissions.

project_id str

The ID of the project to assign the permissions.

replace bool

Replace (true) or merge (false) the permissions. Default: true

permissions Map<String>

the permissions to assign. The following permissions are available

principal String

The group principal to assign the permissions.

projectId String

The ID of the project to assign the permissions.

replace Boolean

Replace (true) or merge (false) the permissions. Default: true

Outputs

All input properties are implicitly available as output properties. Additionally, the ProjectPermissions resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing ProjectPermissions Resource

Get an existing ProjectPermissions resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ProjectPermissionsState, opts?: CustomResourceOptions): ProjectPermissions
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        permissions: Optional[Mapping[str, str]] = None,
        principal: Optional[str] = None,
        project_id: Optional[str] = None,
        replace: Optional[bool] = None) -> ProjectPermissions
func GetProjectPermissions(ctx *Context, name string, id IDInput, state *ProjectPermissionsState, opts ...ResourceOption) (*ProjectPermissions, error)
public static ProjectPermissions Get(string name, Input<string> id, ProjectPermissionsState? state, CustomResourceOptions? opts = null)
public static ProjectPermissions get(String name, Output<String> id, ProjectPermissionsState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Permissions Dictionary<string, string>

the permissions to assign. The following permissions are available

Principal string

The group principal to assign the permissions.

ProjectId string

The ID of the project to assign the permissions.

Replace bool

Replace (true) or merge (false) the permissions. Default: true

Permissions map[string]string

the permissions to assign. The following permissions are available

Principal string

The group principal to assign the permissions.

ProjectId string

The ID of the project to assign the permissions.

Replace bool

Replace (true) or merge (false) the permissions. Default: true

permissions Map<String,String>

the permissions to assign. The following permissions are available

principal String

The group principal to assign the permissions.

projectId String

The ID of the project to assign the permissions.

replace Boolean

Replace (true) or merge (false) the permissions. Default: true

permissions {[key: string]: string}

the permissions to assign. The following permissions are available

principal string

The group principal to assign the permissions.

projectId string

The ID of the project to assign the permissions.

replace boolean

Replace (true) or merge (false) the permissions. Default: true

permissions Mapping[str, str]

the permissions to assign. The following permissions are available

principal str

The group principal to assign the permissions.

project_id str

The ID of the project to assign the permissions.

replace bool

Replace (true) or merge (false) the permissions. Default: true

permissions Map<String>

the permissions to assign. The following permissions are available

principal String

The group principal to assign the permissions.

projectId String

The ID of the project to assign the permissions.

replace Boolean

Replace (true) or merge (false) the permissions. Default: true

Import

The resource does not support import.

Package Details

Repository
Azure DevOps pulumi/pulumi-azuredevops
License
Apache-2.0
Notes

This Pulumi package is based on the azuredevops Terraform Provider.