1. Packages
  2. Bitbucket Provider
  3. API Docs
  4. getProject
bitbucket 2.48.0 published on Thursday, Jul 10, 2025 by drfaust92

bitbucket.getProject

Explore with Pulumi AI

bitbucket logo
bitbucket 2.48.0 published on Thursday, Jul 10, 2025 by drfaust92

    Datasource to retrieve project information

    OAuth2 Scopes: project

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as bitbucket from "@pulumi/bitbucket";
    
    const test = bitbucket.getProject({
        key: "MYREPO",
        workspace: "{f772f004-c268-4698-b49f-9d8415981464}",
    });
    
    import pulumi
    import pulumi_bitbucket as bitbucket
    
    test = bitbucket.get_project(key="MYREPO",
        workspace="{f772f004-c268-4698-b49f-9d8415981464}")
    
    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.LookupProject(ctx, &bitbucket.LookupProjectArgs{
    			Key:       "MYREPO",
    			Workspace: "{f772f004-c268-4698-b49f-9d8415981464}",
    		}, nil)
    		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 test = Bitbucket.GetProject.Invoke(new()
        {
            Key = "MYREPO",
            Workspace = "{f772f004-c268-4698-b49f-9d8415981464}",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.bitbucket.BitbucketFunctions;
    import com.pulumi.bitbucket.inputs.GetProjectArgs;
    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) {
            final var test = BitbucketFunctions.getProject(GetProjectArgs.builder()
                .key("MYREPO")
                .workspace("{f772f004-c268-4698-b49f-9d8415981464}")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: bitbucket:getProject
          arguments:
            key: MYREPO
            workspace: '{f772f004-c268-4698-b49f-9d8415981464}'
    

    Using getProject

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
    function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>
    def get_project(description: Optional[str] = None,
                    id: Optional[str] = None,
                    is_private: Optional[bool] = None,
                    key: Optional[str] = None,
                    link: Optional[GetProjectLink] = None,
                    owners: Optional[Sequence[GetProjectOwner]] = None,
                    workspace: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetProjectResult
    def get_project_output(description: Optional[pulumi.Input[str]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    is_private: Optional[pulumi.Input[bool]] = None,
                    key: Optional[pulumi.Input[str]] = None,
                    link: Optional[pulumi.Input[GetProjectLinkArgs]] = None,
                    owners: Optional[pulumi.Input[Sequence[pulumi.Input[GetProjectOwnerArgs]]]] = None,
                    workspace: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]
    func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
    func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput

    > Note: This function is named LookupProject in the Go SDK.

    public static class GetProject 
    {
        public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
        public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
    public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
    
    fn::invoke:
      function: bitbucket:index/getProject:getProject
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Key string
    Project key
    Workspace string
    Project workspace slug or {UUID}
    Description string
    Project description
    Id string
    The ID of this resource.
    IsPrivate bool
    Project is private
    Link GetProjectLink
    Project link information
    Owners List<GetProjectOwner>
    Project owner information (see below for nested schema)
    Key string
    Project key
    Workspace string
    Project workspace slug or {UUID}
    Description string
    Project description
    Id string
    The ID of this resource.
    IsPrivate bool
    Project is private
    Link GetProjectLink
    Project link information
    Owners []GetProjectOwner
    Project owner information (see below for nested schema)
    key String
    Project key
    workspace String
    Project workspace slug or {UUID}
    description String
    Project description
    id String
    The ID of this resource.
    isPrivate Boolean
    Project is private
    link GetProjectLink
    Project link information
    owners List<GetProjectOwner>
    Project owner information (see below for nested schema)
    key string
    Project key
    workspace string
    Project workspace slug or {UUID}
    description string
    Project description
    id string
    The ID of this resource.
    isPrivate boolean
    Project is private
    link GetProjectLink
    Project link information
    owners GetProjectOwner[]
    Project owner information (see below for nested schema)
    key str
    Project key
    workspace str
    Project workspace slug or {UUID}
    description str
    Project description
    id str
    The ID of this resource.
    is_private bool
    Project is private
    link GetProjectLink
    Project link information
    owners Sequence[GetProjectOwner]
    Project owner information (see below for nested schema)
    key String
    Project key
    workspace String
    Project workspace slug or {UUID}
    description String
    Project description
    id String
    The ID of this resource.
    isPrivate Boolean
    Project is private
    link Property Map
    Project link information
    owners List<Property Map>
    Project owner information (see below for nested schema)

    getProject Result

    The following output properties are available:

    Description string
    HasPubliclyVisibleRepos bool
    Repositories are publicly visible
    Id string
    The ID of this resource.
    IsPrivate bool
    Key string
    Name string
    Project name
    Uuid string
    Owner UUID
    Workspace string
    Link GetProjectLink
    Owners List<GetProjectOwner>
    Project owner information (see below for nested schema)
    Description string
    HasPubliclyVisibleRepos bool
    Repositories are publicly visible
    Id string
    The ID of this resource.
    IsPrivate bool
    Key string
    Name string
    Project name
    Uuid string
    Owner UUID
    Workspace string
    Link GetProjectLink
    Owners []GetProjectOwner
    Project owner information (see below for nested schema)
    description String
    hasPubliclyVisibleRepos Boolean
    Repositories are publicly visible
    id String
    The ID of this resource.
    isPrivate Boolean
    key String
    name String
    Project name
    uuid String
    Owner UUID
    workspace String
    link GetProjectLink
    owners List<GetProjectOwner>
    Project owner information (see below for nested schema)
    description string
    hasPubliclyVisibleRepos boolean
    Repositories are publicly visible
    id string
    The ID of this resource.
    isPrivate boolean
    key string
    name string
    Project name
    uuid string
    Owner UUID
    workspace string
    link GetProjectLink
    owners GetProjectOwner[]
    Project owner information (see below for nested schema)
    description str
    has_publicly_visible_repos bool
    Repositories are publicly visible
    id str
    The ID of this resource.
    is_private bool
    key str
    name str
    Project name
    uuid str
    Owner UUID
    workspace str
    link GetProjectLink
    owners Sequence[GetProjectOwner]
    Project owner information (see below for nested schema)
    description String
    hasPubliclyVisibleRepos Boolean
    Repositories are publicly visible
    id String
    The ID of this resource.
    isPrivate Boolean
    key String
    name String
    Project name
    uuid String
    Owner UUID
    workspace String
    link Property Map
    owners List<Property Map>
    Project owner information (see below for nested schema)

    Supporting Types

    Avatar GetProjectLinkAvatar
    Avatar link information (see below for nested schema)
    Avatar GetProjectLinkAvatar
    Avatar link information (see below for nested schema)
    avatar GetProjectLinkAvatar
    Avatar link information (see below for nested schema)
    avatar GetProjectLinkAvatar
    Avatar link information (see below for nested schema)
    avatar GetProjectLinkAvatar
    Avatar link information (see below for nested schema)
    avatar Property Map
    Avatar link information (see below for nested schema)

    GetProjectLinkAvatar

    Href string
    URL link
    Href string
    URL link
    href String
    URL link
    href string
    URL link
    href str
    URL link
    href String
    URL link

    GetProjectOwner

    DisplayName string
    Owner display name
    Username string
    Owner username
    Uuid string
    Owner UUID
    DisplayName string
    Owner display name
    Username string
    Owner username
    Uuid string
    Owner UUID
    displayName String
    Owner display name
    username String
    Owner username
    uuid String
    Owner UUID
    displayName string
    Owner display name
    username string
    Owner username
    uuid string
    Owner UUID
    display_name str
    Owner display name
    username str
    Owner username
    uuid str
    Owner UUID
    displayName String
    Owner display name
    username String
    Owner username
    uuid String
    Owner UUID

    Package Details

    Repository
    bitbucket drfaust92/terraform-provider-bitbucket
    License
    Notes
    This Pulumi package is based on the bitbucket Terraform Provider.
    bitbucket logo
    bitbucket 2.48.0 published on Thursday, Jul 10, 2025 by drfaust92