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

bitbucket.getWorkspace

Explore with Pulumi AI

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

    Provides a way to fetch data on a workspace.

    OAuth2 Scopes: none

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as bitbucket from "@pulumi/bitbucket";
    
    const example = bitbucket.getWorkspace({
        workspace: "gob",
    });
    
    import pulumi
    import pulumi_bitbucket as bitbucket
    
    example = bitbucket.get_workspace(workspace="gob")
    
    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.GetWorkspace(ctx, &bitbucket.GetWorkspaceArgs{
    			Workspace: "gob",
    		}, 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 example = Bitbucket.GetWorkspace.Invoke(new()
        {
            Workspace = "gob",
        });
    
    });
    
    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.GetWorkspaceArgs;
    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 example = BitbucketFunctions.getWorkspace(GetWorkspaceArgs.builder()
                .workspace("gob")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: bitbucket:getWorkspace
          arguments:
            workspace: gob
    

    Using getWorkspace

    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 getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
    function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceResult>
    def get_workspace(id: Optional[str] = None,
                      workspace: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
    def get_workspace_output(id: Optional[pulumi.Input[str]] = None,
                      workspace: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]
    func GetWorkspace(ctx *Context, args *GetWorkspaceArgs, opts ...InvokeOption) (*GetWorkspaceResult, error)
    func GetWorkspaceOutput(ctx *Context, args *GetWorkspaceOutputArgs, opts ...InvokeOption) GetWorkspaceResultOutput

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

    public static class GetWorkspace 
    {
        public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
        public static Output<GetWorkspaceResult> Invoke(GetWorkspaceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
    public static Output<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
    
    fn::invoke:
      function: bitbucket:index/getWorkspace:getWorkspace
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Workspace string
    This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces
    Id string
    The workspace's immutable id.
    Workspace string
    This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces
    Id string
    The workspace's immutable id.
    workspace String
    This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces
    id String
    The workspace's immutable id.
    workspace string
    This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces
    id string
    The workspace's immutable id.
    workspace str
    This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces
    id str
    The workspace's immutable id.
    workspace String
    This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces
    id String
    The workspace's immutable id.

    getWorkspace Result

    The following output properties are available:

    Id string
    The workspace's immutable id.
    IsPrivate bool
    Indicates whether the workspace is publicly accessible, or whether it is private to the members and consequently only visible to members.
    Name string
    The name of the workspace.
    Slug string
    The short label that identifies this workspace.
    Workspace string
    Id string
    The workspace's immutable id.
    IsPrivate bool
    Indicates whether the workspace is publicly accessible, or whether it is private to the members and consequently only visible to members.
    Name string
    The name of the workspace.
    Slug string
    The short label that identifies this workspace.
    Workspace string
    id String
    The workspace's immutable id.
    isPrivate Boolean
    Indicates whether the workspace is publicly accessible, or whether it is private to the members and consequently only visible to members.
    name String
    The name of the workspace.
    slug String
    The short label that identifies this workspace.
    workspace String
    id string
    The workspace's immutable id.
    isPrivate boolean
    Indicates whether the workspace is publicly accessible, or whether it is private to the members and consequently only visible to members.
    name string
    The name of the workspace.
    slug string
    The short label that identifies this workspace.
    workspace string
    id str
    The workspace's immutable id.
    is_private bool
    Indicates whether the workspace is publicly accessible, or whether it is private to the members and consequently only visible to members.
    name str
    The name of the workspace.
    slug str
    The short label that identifies this workspace.
    workspace str
    id String
    The workspace's immutable id.
    isPrivate Boolean
    Indicates whether the workspace is publicly accessible, or whether it is private to the members and consequently only visible to members.
    name String
    The name of the workspace.
    slug String
    The short label that identifies this workspace.
    workspace String

    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