1. Packages
  2. Bitbucket Provider
  3. API Docs
  4. RepositoryGroupPermission
bitbucket 2.46.0 published on Monday, Apr 14, 2025 by drfaust92

bitbucket.RepositoryGroupPermission

Explore with Pulumi AI

bitbucket logo
bitbucket 2.46.0 published on Monday, Apr 14, 2025 by drfaust92

    Provides a Bitbucket Repository Group Permission Resource.

    This allows you set explicit group permission for a repository.

    OAuth2 Scopes: repository:admin

    Note: can only be used when authenticating with Bitbucket Cloud using an app password. Authenticating via an OAuth flow gives a 403 error due to a restriction in the Bitbucket Cloud API.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as bitbucket from "@pulumi/bitbucket";
    
    const example = new bitbucket.RepositoryGroupPermission("example", {
        workspace: "example",
        repoSlug: bitbucket_repository.example.name,
        groupSlug: bitbucket_group.example.slug,
        permission: "read",
    });
    
    import pulumi
    import pulumi_bitbucket as bitbucket
    
    example = bitbucket.RepositoryGroupPermission("example",
        workspace="example",
        repo_slug=bitbucket_repository["example"]["name"],
        group_slug=bitbucket_group["example"]["slug"],
        permission="read")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/bitbucket/v2/bitbucket"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := bitbucket.NewRepositoryGroupPermission(ctx, "example", &bitbucket.RepositoryGroupPermissionArgs{
    			Workspace:  pulumi.String("example"),
    			RepoSlug:   pulumi.Any(bitbucket_repository.Example.Name),
    			GroupSlug:  pulumi.Any(bitbucket_group.Example.Slug),
    			Permission: pulumi.String("read"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Bitbucket = Pulumi.Bitbucket;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Bitbucket.RepositoryGroupPermission("example", new()
        {
            Workspace = "example",
            RepoSlug = bitbucket_repository.Example.Name,
            GroupSlug = bitbucket_group.Example.Slug,
            Permission = "read",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.bitbucket.RepositoryGroupPermission;
    import com.pulumi.bitbucket.RepositoryGroupPermissionArgs;
    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 RepositoryGroupPermission("example", RepositoryGroupPermissionArgs.builder()
                .workspace("example")
                .repoSlug(bitbucket_repository.example().name())
                .groupSlug(bitbucket_group.example().slug())
                .permission("read")
                .build());
    
        }
    }
    
    resources:
      example:
        type: bitbucket:RepositoryGroupPermission
        properties:
          workspace: example
          repoSlug: ${bitbucket_repository.example.name}
          groupSlug: ${bitbucket_group.example.slug}
          permission: read
    

    Create RepositoryGroupPermission Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RepositoryGroupPermission(name: string, args: RepositoryGroupPermissionArgs, opts?: CustomResourceOptions);
    @overload
    def RepositoryGroupPermission(resource_name: str,
                                  args: RepositoryGroupPermissionArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def RepositoryGroupPermission(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  group_slug: Optional[str] = None,
                                  permission: Optional[str] = None,
                                  repo_slug: Optional[str] = None,
                                  workspace: Optional[str] = None,
                                  repository_group_permission_id: Optional[str] = None)
    func NewRepositoryGroupPermission(ctx *Context, name string, args RepositoryGroupPermissionArgs, opts ...ResourceOption) (*RepositoryGroupPermission, error)
    public RepositoryGroupPermission(string name, RepositoryGroupPermissionArgs args, CustomResourceOptions? opts = null)
    public RepositoryGroupPermission(String name, RepositoryGroupPermissionArgs args)
    public RepositoryGroupPermission(String name, RepositoryGroupPermissionArgs args, CustomResourceOptions options)
    
    type: bitbucket:RepositoryGroupPermission
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var repositoryGroupPermissionResource = new Bitbucket.RepositoryGroupPermission("repositoryGroupPermissionResource", new()
    {
        GroupSlug = "string",
        Permission = "string",
        RepoSlug = "string",
        Workspace = "string",
        RepositoryGroupPermissionId = "string",
    });
    
    example, err := bitbucket.NewRepositoryGroupPermission(ctx, "repositoryGroupPermissionResource", &bitbucket.RepositoryGroupPermissionArgs{
    	GroupSlug:                   pulumi.String("string"),
    	Permission:                  pulumi.String("string"),
    	RepoSlug:                    pulumi.String("string"),
    	Workspace:                   pulumi.String("string"),
    	RepositoryGroupPermissionId: pulumi.String("string"),
    })
    
    var repositoryGroupPermissionResource = new RepositoryGroupPermission("repositoryGroupPermissionResource", RepositoryGroupPermissionArgs.builder()
        .groupSlug("string")
        .permission("string")
        .repoSlug("string")
        .workspace("string")
        .repositoryGroupPermissionId("string")
        .build());
    
    repository_group_permission_resource = bitbucket.RepositoryGroupPermission("repositoryGroupPermissionResource",
        group_slug="string",
        permission="string",
        repo_slug="string",
        workspace="string",
        repository_group_permission_id="string")
    
    const repositoryGroupPermissionResource = new bitbucket.RepositoryGroupPermission("repositoryGroupPermissionResource", {
        groupSlug: "string",
        permission: "string",
        repoSlug: "string",
        workspace: "string",
        repositoryGroupPermissionId: "string",
    });
    
    type: bitbucket:RepositoryGroupPermission
    properties:
        groupSlug: string
        permission: string
        repoSlug: string
        repositoryGroupPermissionId: string
        workspace: string
    

    RepositoryGroupPermission Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RepositoryGroupPermission resource accepts the following input properties:

    GroupSlug string
    Slug of the requested group.
    Permission string
    Permissions can be one of read, write, and admin.
    RepoSlug string
    The repository slug.
    Workspace string
    The workspace id.
    RepositoryGroupPermissionId string
    GroupSlug string
    Slug of the requested group.
    Permission string
    Permissions can be one of read, write, and admin.
    RepoSlug string
    The repository slug.
    Workspace string
    The workspace id.
    RepositoryGroupPermissionId string
    groupSlug String
    Slug of the requested group.
    permission String
    Permissions can be one of read, write, and admin.
    repoSlug String
    The repository slug.
    workspace String
    The workspace id.
    repositoryGroupPermissionId String
    groupSlug string
    Slug of the requested group.
    permission string
    Permissions can be one of read, write, and admin.
    repoSlug string
    The repository slug.
    workspace string
    The workspace id.
    repositoryGroupPermissionId string
    group_slug str
    Slug of the requested group.
    permission str
    Permissions can be one of read, write, and admin.
    repo_slug str
    The repository slug.
    workspace str
    The workspace id.
    repository_group_permission_id str
    groupSlug String
    Slug of the requested group.
    permission String
    Permissions can be one of read, write, and admin.
    repoSlug String
    The repository slug.
    workspace String
    The workspace id.
    repositoryGroupPermissionId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RepositoryGroupPermission 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 RepositoryGroupPermission Resource

    Get an existing RepositoryGroupPermission 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?: RepositoryGroupPermissionState, opts?: CustomResourceOptions): RepositoryGroupPermission
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            group_slug: Optional[str] = None,
            permission: Optional[str] = None,
            repo_slug: Optional[str] = None,
            repository_group_permission_id: Optional[str] = None,
            workspace: Optional[str] = None) -> RepositoryGroupPermission
    func GetRepositoryGroupPermission(ctx *Context, name string, id IDInput, state *RepositoryGroupPermissionState, opts ...ResourceOption) (*RepositoryGroupPermission, error)
    public static RepositoryGroupPermission Get(string name, Input<string> id, RepositoryGroupPermissionState? state, CustomResourceOptions? opts = null)
    public static RepositoryGroupPermission get(String name, Output<String> id, RepositoryGroupPermissionState state, CustomResourceOptions options)
    resources:  _:    type: bitbucket:RepositoryGroupPermission    get:      id: ${id}
    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:
    GroupSlug string
    Slug of the requested group.
    Permission string
    Permissions can be one of read, write, and admin.
    RepoSlug string
    The repository slug.
    RepositoryGroupPermissionId string
    Workspace string
    The workspace id.
    GroupSlug string
    Slug of the requested group.
    Permission string
    Permissions can be one of read, write, and admin.
    RepoSlug string
    The repository slug.
    RepositoryGroupPermissionId string
    Workspace string
    The workspace id.
    groupSlug String
    Slug of the requested group.
    permission String
    Permissions can be one of read, write, and admin.
    repoSlug String
    The repository slug.
    repositoryGroupPermissionId String
    workspace String
    The workspace id.
    groupSlug string
    Slug of the requested group.
    permission string
    Permissions can be one of read, write, and admin.
    repoSlug string
    The repository slug.
    repositoryGroupPermissionId string
    workspace string
    The workspace id.
    group_slug str
    Slug of the requested group.
    permission str
    Permissions can be one of read, write, and admin.
    repo_slug str
    The repository slug.
    repository_group_permission_id str
    workspace str
    The workspace id.
    groupSlug String
    Slug of the requested group.
    permission String
    Permissions can be one of read, write, and admin.
    repoSlug String
    The repository slug.
    repositoryGroupPermissionId String
    workspace String
    The workspace id.

    Import

    Repository Group Permissions can be imported using their workspace:repo-slug:group-slug ID, e.g.

    $ pulumi import bitbucket:index/repositoryGroupPermission:RepositoryGroupPermission example workspace:repo-slug:group-slug
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    bitbucket drfaust92/terraform-provider-bitbucket
    License
    Notes
    This Pulumi package is based on the bitbucket Terraform Provider.
    bitbucket logo
    bitbucket 2.46.0 published on Monday, Apr 14, 2025 by drfaust92