AzureDevOps

v2.5.0 published on Monday, Jul 25, 2022 by Pulumi

AreaPermissions

Manages permissions for an Area (Component)

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

Permission levels

Permission for Areas within Azure DevOps can be applied on two different levels. Those levels are reflected by specifying (or omitting) values for the arguments project_id and path.

Relevant Links

Azure DevOps Service REST API 6.0 - Security

PAT Permissions Required

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

Example Usage

using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new AzureDevOps.Project("example", new AzureDevOps.ProjectArgs
        {
            WorkItemTemplate = "Agile",
            VersionControl = "Git",
            Visibility = "private",
            Description = "Managed by Terraform",
        });
        var example_project_readers = AzureDevOps.GetGroup.Invoke(new AzureDevOps.GetGroupInvokeArgs
        {
            ProjectId = example.Id,
            Name = "Readers",
        });
        var example_root_permissions = new AzureDevOps.AreaPermissions("example-root-permissions", new AzureDevOps.AreaPermissionsArgs
        {
            ProjectId = example.Id,
            Principal = example_project_readers.Apply(example_project_readers => example_project_readers.Id),
            Path = "/",
            Permissions = 
            {
                { "CREATE_CHILDREN", "Deny" },
                { "GENERIC_READ", "Allow" },
                { "DELETE", "Deny" },
                { "WORK_ITEM_READ", "Allow" },
            },
        });
    }

}

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{
			WorkItemTemplate: pulumi.String("Agile"),
			VersionControl:   pulumi.String("Git"),
			Visibility:       pulumi.String("private"),
			Description:      pulumi.String("Managed by Terraform"),
		})
		if err != nil {
			return err
		}
		example_project_readers := azuredevops.LookupGroupOutput(ctx, GetGroupOutputArgs{
			ProjectId: example.ID(),
			Name:      pulumi.String("Readers"),
		}, nil)
		_, err = azuredevops.NewAreaPermissions(ctx, "example-root-permissions", &azuredevops.AreaPermissionsArgs{
			ProjectId: example.ID(),
			Principal: example_project_readers.ApplyT(func(example_project_readers GetGroupResult) (string, error) {
				return example_project_readers.Id, nil
			}).(pulumi.StringOutput),
			Path: pulumi.String("/"),
			Permissions: pulumi.StringMap{
				"CREATE_CHILDREN": pulumi.String("Deny"),
				"GENERIC_READ":    pulumi.String("Allow"),
				"DELETE":          pulumi.String("Deny"),
				"WORK_ITEM_READ":  pulumi.String("Allow"),
			},
		})
		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.Identities.inputs.GetGroupArgs;
import com.pulumi.azuredevops.AreaPermissions;
import com.pulumi.azuredevops.AreaPermissionsArgs;
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()        
            .workItemTemplate("Agile")
            .versionControl("Git")
            .visibility("private")
            .description("Managed by Terraform")
            .build());

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

        var example_root_permissions = new AreaPermissions("example-root-permissions", AreaPermissionsArgs.builder()        
            .projectId(example.id())
            .principal(example_project_readers.applyValue(example_project_readers -> example_project_readers.id()))
            .path("/")
            .permissions(Map.ofEntries(
                Map.entry("CREATE_CHILDREN", "Deny"),
                Map.entry("GENERIC_READ", "Allow"),
                Map.entry("DELETE", "Deny"),
                Map.entry("WORK_ITEM_READ", "Allow")
            ))
            .build());

    }
}

import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.Project("example",
    work_item_template="Agile",
    version_control="Git",
    visibility="private",
    description="Managed by Terraform")
example_project_readers = azuredevops.get_group_output(project_id=example.id,
    name="Readers")
example_root_permissions = azuredevops.AreaPermissions("example-root-permissions",
    project_id=example.id,
    principal=example_project_readers.id,
    path="/",
    permissions={
        "CREATE_CHILDREN": "Deny",
        "GENERIC_READ": "Allow",
        "DELETE": "Deny",
        "WORK_ITEM_READ": "Allow",
    })

import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const example = new azuredevops.Project("example", {
    workItemTemplate: "Agile",
    versionControl: "Git",
    visibility: "private",
    description: "Managed by Terraform",
});
const example-project-readers = azuredevops.getGroupOutput({
    projectId: example.id,
    name: "Readers",
});
const example_root_permissions = new azuredevops.AreaPermissions("example-root-permissions", {
    projectId: example.id,
    principal: example_project_readers.apply(example_project_readers => example_project_readers.id),
    path: "/",
    permissions: {
        CREATE_CHILDREN: "Deny",
        GENERIC_READ: "Allow",
        DELETE: "Deny",
        WORK_ITEM_READ: "Allow",
    },
});

resources:
  example:
    type: azuredevops:Project
    properties:
      workItemTemplate: Agile
      versionControl: Git
      visibility: private
      description: Managed by Terraform
  example-root-permissions:
    type: azuredevops:AreaPermissions
    properties:
      projectId: ${example.id}
      principal: ${["example-project-readers"].id}
      path: /
      permissions:
        CREATE_CHILDREN: Deny
        GENERIC_READ: Allow
        DELETE: Deny
        WORK_ITEM_READ: Allow
variables:
  example-project-readers:
    Fn::Invoke:
      Function: azuredevops:getGroup
      Arguments:
        projectId: ${example.id}
        name: Readers

Create a AreaPermissions Resource

new AreaPermissions(name: string, args: AreaPermissionsArgs, opts?: CustomResourceOptions);

@overload
def AreaPermissions(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    path: Optional[str] = None,
                    permissions: Optional[Mapping[str, str]] = None,
                    principal: Optional[str] = None,
                    project_id: Optional[str] = None,
                    replace: Optional[bool] = None)
@overload
def AreaPermissions(resource_name: str,
                    args: AreaPermissionsArgs,
                    opts: Optional[ResourceOptions] = None)

func NewAreaPermissions(ctx *Context, name string, args AreaPermissionsArgs, opts ...ResourceOption) (*AreaPermissions, error)

public AreaPermissions(string name, AreaPermissionsArgs args, CustomResourceOptions? opts = null)

public AreaPermissions(String name, AreaPermissionsArgs args)
public AreaPermissions(String name, AreaPermissionsArgs args, CustomResourceOptions options)

type: azuredevops:AreaPermissions
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AreaPermissionsArgs: 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 AreaPermissionsArgs: 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 AreaPermissionsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AreaPermissionsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AreaPermissionsArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

AreaPermissions 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 AreaPermissions 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.
Path string: The name of the branch 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.
Path string: The name of the branch 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.
path String: The name of the branch 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.
path string: The name of the branch 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.
path str: The name of the branch 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.
path String: The name of the branch 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 AreaPermissions 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 an Existing AreaPermissions Resource

Get an existing AreaPermissions 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?: AreaPermissionsState, opts?: CustomResourceOptions): AreaPermissions

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        path: Optional[str] = None,
        permissions: Optional[Mapping[str, str]] = None,
        principal: Optional[str] = None,
        project_id: Optional[str] = None,
        replace: Optional[bool] = None) -> AreaPermissions

func GetAreaPermissions(ctx *Context, name string, id IDInput, state *AreaPermissionsState, opts ...ResourceOption) (*AreaPermissions, error)

public static AreaPermissions Get(string name, Input<string> id, AreaPermissionsState? state, CustomResourceOptions? opts = null)

public static AreaPermissions get(String name, Output<String> id, AreaPermissionsState 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:

Path string: The name of the branch to assign the permissions.
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.

Path string: The name of the branch to assign the permissions.
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.

path String: The name of the branch to assign the permissions.
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.

path string: The name of the branch to assign the permissions.
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.

path str: The name of the branch to assign the permissions.
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.

path String: The name of the branch to assign the permissions.
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: https://github.com/pulumi/pulumi-azuredevops
License: Apache-2.0
Notes: This Pulumi package is based on the azuredevops Terraform Provider.