1. Packages
  2. Spectrocloud Provider
  3. API Docs
  4. getWorkspace
spectrocloud 0.23.5 published on Sunday, Apr 20, 2025 by spectrocloud

spectrocloud.getWorkspace

Explore with Pulumi AI

spectrocloud logo
spectrocloud 0.23.5 published on Sunday, Apr 20, 2025 by spectrocloud

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as spectrocloud from "@pulumi/spectrocloud";
    
    const exampleWorkspace = spectrocloud.getWorkspace({
        name: "my-workspace",
    });
    export const workspaceName = exampleWorkspace.then(exampleWorkspace => exampleWorkspace.id);
    
    import pulumi
    import pulumi_spectrocloud as spectrocloud
    
    example_workspace = spectrocloud.get_workspace(name="my-workspace")
    pulumi.export("workspaceName", example_workspace.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/spectrocloud/spectrocloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleWorkspace, err := spectrocloud.LookupWorkspace(ctx, &spectrocloud.LookupWorkspaceArgs{
    			Name: "my-workspace",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("workspaceName", exampleWorkspace.Id)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Spectrocloud = Pulumi.Spectrocloud;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleWorkspace = Spectrocloud.GetWorkspace.Invoke(new()
        {
            Name = "my-workspace",
        });
    
        return new Dictionary<string, object?>
        {
            ["workspaceName"] = exampleWorkspace.Apply(getWorkspaceResult => getWorkspaceResult.Id),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.spectrocloud.SpectrocloudFunctions;
    import com.pulumi.spectrocloud.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 exampleWorkspace = SpectrocloudFunctions.getWorkspace(GetWorkspaceArgs.builder()
                .name("my-workspace")
                .build());
    
            ctx.export("workspaceName", exampleWorkspace.applyValue(getWorkspaceResult -> getWorkspaceResult.id()));
        }
    }
    
    variables:
      exampleWorkspace:
        fn::invoke:
          function: spectrocloud:getWorkspace
          arguments:
            name: my-workspace
    outputs:
      # Output the retrieved workspace id
      workspaceName: ${exampleWorkspace.id}
    

    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,
                      name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
    def get_workspace_output(id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]
    func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
    func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput

    > Note: This function is named LookupWorkspace 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: spectrocloud:index/getWorkspace:getWorkspace
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Id string
    The ID of this resource.
    Name string
    Id string
    The ID of this resource.
    name String
    id String
    The ID of this resource.
    name string
    id string
    The ID of this resource.
    name str
    id str
    The ID of this resource.
    name String
    id String
    The ID of this resource.

    getWorkspace Result

    The following output properties are available:

    Id string
    The ID of this resource.
    Name string
    Id string
    The ID of this resource.
    Name string
    id String
    The ID of this resource.
    name String
    id string
    The ID of this resource.
    name string
    id str
    The ID of this resource.
    name str
    id String
    The ID of this resource.
    name String

    Package Details

    Repository
    spectrocloud spectrocloud/terraform-provider-spectrocloud
    License
    Notes
    This Pulumi package is based on the spectrocloud Terraform Provider.
    spectrocloud logo
    spectrocloud 0.23.5 published on Sunday, Apr 20, 2025 by spectrocloud