1. Packages
  2. Volcengine
  3. API Docs
  4. bioos
  5. getWorkspaces
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.bioos.getWorkspaces

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of bioos workspaces

    Example Usage

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

const default = volcengine.bioos.getWorkspaces({});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.bioos.get_workspaces()

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/bioos"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bioos.GetWorkspaces(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Bioos.GetWorkspaces.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.bioos.BioosFunctions;
import com.pulumi.volcengine.bioos.inputs.GetWorkspacesArgs;
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 default = BioosFunctions.getWorkspaces();

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:bioos:getWorkspaces
      Arguments: {}

    Using getWorkspaces

    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 getWorkspaces(args: GetWorkspacesArgs, opts?: InvokeOptions): Promise<GetWorkspacesResult>
function getWorkspacesOutput(args: GetWorkspacesOutputArgs, opts?: InvokeOptions): Output<GetWorkspacesResult>
    def get_workspaces(ids: Optional[Sequence[str]] = None,
                   keyword: Optional[str] = None,
                   output_file: Optional[str] = None,
                   sort_by: Optional[str] = None,
                   sort_order: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetWorkspacesResult
def get_workspaces_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   keyword: Optional[pulumi.Input[str]] = None,
                   output_file: Optional[pulumi.Input[str]] = None,
                   sort_by: Optional[pulumi.Input[str]] = None,
                   sort_order: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetWorkspacesResult]
    func GetWorkspaces(ctx *Context, args *GetWorkspacesArgs, opts ...InvokeOption) (*GetWorkspacesResult, error)
func GetWorkspacesOutput(ctx *Context, args *GetWorkspacesOutputArgs, opts ...InvokeOption) GetWorkspacesResultOutput

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

    public static class GetWorkspaces 
{
    public static Task<GetWorkspacesResult> InvokeAsync(GetWorkspacesArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspacesResult> Invoke(GetWorkspacesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkspacesResult> getWorkspaces(GetWorkspacesArgs args, InvokeOptions options)
public static Output<GetWorkspacesResult> getWorkspaces(GetWorkspacesArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:bioos/getWorkspaces:getWorkspaces
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of workspace ids.
    Keyword string
    Keyword to filter by workspace name or description.
    OutputFile string
    File name where to save data source results.
    SortBy string
    Sort Field (Name CreateTime).
    SortOrder string
    The sort order.
    Ids []string
    A list of workspace ids.
    Keyword string
    Keyword to filter by workspace name or description.
    OutputFile string
    File name where to save data source results.
    SortBy string
    Sort Field (Name CreateTime).
    SortOrder string
    The sort order.
    ids List<String>
    A list of workspace ids.
    keyword String
    Keyword to filter by workspace name or description.
    outputFile String
    File name where to save data source results.
    sortBy String
    Sort Field (Name CreateTime).
    sortOrder String
    The sort order.
    ids string[]
    A list of workspace ids.
    keyword string
    Keyword to filter by workspace name or description.
    outputFile string
    File name where to save data source results.
    sortBy string
    Sort Field (Name CreateTime).
    sortOrder string
    The sort order.
    ids Sequence[str]
    A list of workspace ids.
    keyword str
    Keyword to filter by workspace name or description.
    output_file str
    File name where to save data source results.
    sort_by str
    Sort Field (Name CreateTime).
    sort_order str
    The sort order.
    ids List<String>
    A list of workspace ids.
    keyword String
    Keyword to filter by workspace name or description.
    outputFile String
    File name where to save data source results.
    sortBy String
    Sort Field (Name CreateTime).
    sortOrder String
    The sort order.

    getWorkspaces Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetWorkspacesItem>
    A list of workspaces.
    TotalCount int
    The total count of Workspace query.
    Ids List<string>
    Keyword string
    OutputFile string
    SortBy string
    SortOrder string
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetWorkspacesItem
    A list of workspaces.
    TotalCount int
    The total count of Workspace query.
    Ids []string
    Keyword string
    OutputFile string
    SortBy string
    SortOrder string
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetWorkspacesItem>
    A list of workspaces.
    totalCount Integer
    The total count of Workspace query.
    ids List<String>
    keyword String
    outputFile String
    sortBy String
    sortOrder String
    id string
    The provider-assigned unique ID for this managed resource.
    items GetWorkspacesItem[]
    A list of workspaces.
    totalCount number
    The total count of Workspace query.
    ids string[]
    keyword string
    outputFile string
    sortBy string
    sortOrder string
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[GetWorkspacesItem]
    A list of workspaces.
    total_count int
    The total count of Workspace query.
    ids Sequence[str]
    keyword str
    output_file str
    sort_by str
    sort_order str
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    A list of workspaces.
    totalCount Number
    The total count of Workspace query.
    ids List<String>
    keyword String
    outputFile String
    sortBy String
    sortOrder String

    Supporting Types

    GetWorkspacesItem

    CoverDownloadUrl string
    The URL of the cover.
    CreateTime int
    The creation time of the workspace.
    Description string
    The description of the workspace.
    Id string
    The id of the workspace.
    Name string
    The name of the workspace.
    OwnerName string
    The name of the owner of the workspace.
    Role string
    The role of the user.
    S3Bucket string
    S3 bucket address.
    UpdateTime int
    The update time of the workspace.
    CoverDownloadUrl string
    The URL of the cover.
    CreateTime int
    The creation time of the workspace.
    Description string
    The description of the workspace.
    Id string
    The id of the workspace.
    Name string
    The name of the workspace.
    OwnerName string
    The name of the owner of the workspace.
    Role string
    The role of the user.
    S3Bucket string
    S3 bucket address.
    UpdateTime int
    The update time of the workspace.
    coverDownloadUrl String
    The URL of the cover.
    createTime Integer
    The creation time of the workspace.
    description String
    The description of the workspace.
    id String
    The id of the workspace.
    name String
    The name of the workspace.
    ownerName String
    The name of the owner of the workspace.
    role String
    The role of the user.
    s3Bucket String
    S3 bucket address.
    updateTime Integer
    The update time of the workspace.
    coverDownloadUrl string
    The URL of the cover.
    createTime number
    The creation time of the workspace.
    description string
    The description of the workspace.
    id string
    The id of the workspace.
    name string
    The name of the workspace.
    ownerName string
    The name of the owner of the workspace.
    role string
    The role of the user.
    s3Bucket string
    S3 bucket address.
    updateTime number
    The update time of the workspace.
    cover_download_url str
    The URL of the cover.
    create_time int
    The creation time of the workspace.
    description str
    The description of the workspace.
    id str
    The id of the workspace.
    name str
    The name of the workspace.
    owner_name str
    The name of the owner of the workspace.
    role str
    The role of the user.
    s3_bucket str
    S3 bucket address.
    update_time int
    The update time of the workspace.
    coverDownloadUrl String
    The URL of the cover.
    createTime Number
    The creation time of the workspace.
    description String
    The description of the workspace.
    id String
    The id of the workspace.
    name String
    The name of the workspace.
    ownerName String
    The name of the owner of the workspace.
    role String
    The role of the user.
    s3Bucket String
    S3 bucket address.
    updateTime Number
    The update time of the workspace.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate