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

volcengine.vmp.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 vmp workspaces

    Example Usage

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

const fooWorkspace = new volcengine.vmp.Workspace("fooWorkspace", {
    instanceTypeId: "vmp.standard.15d",
    deleteProtectionEnabled: false,
    description: "acc-test-1",
    username: "admin123",
    password: "*******",
});
const fooWorkspaces = volcengine.vmp.getWorkspacesOutput({
    ids: [fooWorkspace.id],
});

    import pulumi
import pulumi_volcengine as volcengine

foo_workspace = volcengine.vmp.Workspace("fooWorkspace",
    instance_type_id="vmp.standard.15d",
    delete_protection_enabled=False,
    description="acc-test-1",
    username="admin123",
    password="*******")
foo_workspaces = volcengine.vmp.get_workspaces_output(ids=[foo_workspace.id])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooWorkspace, err := vmp.NewWorkspace(ctx, "fooWorkspace", &vmp.WorkspaceArgs{
			InstanceTypeId:          pulumi.String("vmp.standard.15d"),
			DeleteProtectionEnabled: pulumi.Bool(false),
			Description:             pulumi.String("acc-test-1"),
			Username:                pulumi.String("admin123"),
			Password:                pulumi.String("*******"),
		})
		if err != nil {
			return err
		}
		_ = vmp.GetWorkspacesOutput(ctx, vmp.GetWorkspacesOutputArgs{
			Ids: pulumi.StringArray{
				fooWorkspace.ID(),
			},
		}, nil)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var fooWorkspace = new Volcengine.Vmp.Workspace("fooWorkspace", new()
    {
        InstanceTypeId = "vmp.standard.15d",
        DeleteProtectionEnabled = false,
        Description = "acc-test-1",
        Username = "admin123",
        Password = "*******",
    });

    var fooWorkspaces = Volcengine.Vmp.GetWorkspaces.Invoke(new()
    {
        Ids = new[]
        {
            fooWorkspace.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.vmp.Workspace;
import com.pulumi.volcengine.vmp.WorkspaceArgs;
import com.pulumi.volcengine.vmp.VmpFunctions;
import com.pulumi.volcengine.vmp.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) {
        var fooWorkspace = new Workspace("fooWorkspace", WorkspaceArgs.builder()        
            .instanceTypeId("vmp.standard.15d")
            .deleteProtectionEnabled(false)
            .description("acc-test-1")
            .username("admin123")
            .password("*******")
            .build());

        final var fooWorkspaces = VmpFunctions.getWorkspaces(GetWorkspacesArgs.builder()
            .ids(fooWorkspace.id())
            .build());

    }
}

    resources:
  fooWorkspace:
    type: volcengine:vmp:Workspace
    properties:
      instanceTypeId: vmp.standard.15d
      deleteProtectionEnabled: false
      description: acc-test-1
      username: admin123
      password: '*******'
variables:
  fooWorkspaces:
    fn::invoke:
      Function: volcengine:vmp:getWorkspaces
      Arguments:
        ids:
          - ${fooWorkspace.id}

    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,
                   instance_type_ids: Optional[Sequence[str]] = None,
                   name: Optional[str] = None,
                   output_file: Optional[str] = None,
                   project_name: Optional[str] = None,
                   statuses: Optional[Sequence[str]] = None,
                   tags: Optional[Sequence[GetWorkspacesTag]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetWorkspacesResult
def get_workspaces_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   instance_type_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   output_file: Optional[pulumi.Input[str]] = None,
                   project_name: Optional[pulumi.Input[str]] = None,
                   statuses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetWorkspacesTagArgs]]]] = 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:vmp/getWorkspaces:getWorkspaces
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of Workspace IDs.
    InstanceTypeIds List<string>
    A list of Instance Type IDs.
    Name string
    The name of workspace.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name of vmp workspace.
    Statuses List<string>
    A list of Workspace status.
    Tags List<GetWorkspacesTag>
    The tags of vmp workspace.
    Ids []string
    A list of Workspace IDs.
    InstanceTypeIds []string
    A list of Instance Type IDs.
    Name string
    The name of workspace.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name of vmp workspace.
    Statuses []string
    A list of Workspace status.
    Tags []GetWorkspacesTag
    The tags of vmp workspace.
    ids List<String>
    A list of Workspace IDs.
    instanceTypeIds List<String>
    A list of Instance Type IDs.
    name String
    The name of workspace.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name of vmp workspace.
    statuses List<String>
    A list of Workspace status.
    tags List<GetWorkspacesTag>
    The tags of vmp workspace.
    ids string[]
    A list of Workspace IDs.
    instanceTypeIds string[]
    A list of Instance Type IDs.
    name string
    The name of workspace.
    outputFile string
    File name where to save data source results.
    projectName string
    The project name of vmp workspace.
    statuses string[]
    A list of Workspace status.
    tags GetWorkspacesTag[]
    The tags of vmp workspace.
    ids Sequence[str]
    A list of Workspace IDs.
    instance_type_ids Sequence[str]
    A list of Instance Type IDs.
    name str
    The name of workspace.
    output_file str
    File name where to save data source results.
    project_name str
    The project name of vmp workspace.
    statuses Sequence[str]
    A list of Workspace status.
    tags Sequence[GetWorkspacesTag]
    The tags of vmp workspace.
    ids List<String>
    A list of Workspace IDs.
    instanceTypeIds List<String>
    A list of Instance Type IDs.
    name String
    The name of workspace.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name of vmp workspace.
    statuses List<String>
    A list of Workspace status.
    tags List<Property Map>
    The tags of vmp workspace.

    getWorkspaces Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    Workspaces List<GetWorkspacesWorkspace>
    The collection of query.
    Ids List<string>
    InstanceTypeIds List<string>
    Name string
    The name of workspace.
    OutputFile string
    ProjectName string
    The project name of vmp workspace.
    Statuses List<string>
    Tags List<GetWorkspacesTag>
    Tags.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    Workspaces []GetWorkspacesWorkspace
    The collection of query.
    Ids []string
    InstanceTypeIds []string
    Name string
    The name of workspace.
    OutputFile string
    ProjectName string
    The project name of vmp workspace.
    Statuses []string
    Tags []GetWorkspacesTag
    Tags.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    workspaces List<GetWorkspacesWorkspace>
    The collection of query.
    ids List<String>
    instanceTypeIds List<String>
    name String
    The name of workspace.
    outputFile String
    projectName String
    The project name of vmp workspace.
    statuses List<String>
    tags List<GetWorkspacesTag>
    Tags.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    workspaces GetWorkspacesWorkspace[]
    The collection of query.
    ids string[]
    instanceTypeIds string[]
    name string
    The name of workspace.
    outputFile string
    projectName string
    The project name of vmp workspace.
    statuses string[]
    tags GetWorkspacesTag[]
    Tags.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    workspaces Sequence[GetWorkspacesWorkspace]
    The collection of query.
    ids Sequence[str]
    instance_type_ids Sequence[str]
    name str
    The name of workspace.
    output_file str
    project_name str
    The project name of vmp workspace.
    statuses Sequence[str]
    tags Sequence[GetWorkspacesTag]
    Tags.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    workspaces List<Property Map>
    The collection of query.
    ids List<String>
    instanceTypeIds List<String>
    name String
    The name of workspace.
    outputFile String
    projectName String
    The project name of vmp workspace.
    statuses List<String>
    tags List<Property Map>
    Tags.

    Supporting Types

    GetWorkspacesTag

    Key string
    The Key of Tags.
    Values List<string>
    The Value of Tags.
    Key string
    The Key of Tags.
    Values []string
    The Value of Tags.
    key String
    The Key of Tags.
    values List<String>
    The Value of Tags.
    key string
    The Key of Tags.
    values string[]
    The Value of Tags.
    key str
    The Key of Tags.
    values Sequence[str]
    The Value of Tags.
    key String
    The Key of Tags.
    values List<String>
    The Value of Tags.

    GetWorkspacesWorkspace

    CreateTime string
    The create time of workspace.
    DeleteProtectionEnabled bool
    Whether enable delete protection.
    Description string
    The description of workspace.
    Id string
    The ID of workspace.
    InstanceTypeId string
    The id of instance type.
    Name string
    The name of workspace.
    OverdueReclaimTime string
    The overdue reclaim time.
    ProjectName string
    The project name of vmp workspace.
    PrometheusPushIntranetEndpoint string
    The prometheus push intranet endpoint.
    PrometheusQueryIntranetEndpoint string
    The prometheus query intranet endpoint.
    PrometheusWriteIntranetEndpoint string
    The prometheus write intranet endpoint.
    Status string
    The status of workspace.
    Tags List<GetWorkspacesWorkspaceTag>
    The tags of vmp workspace.
    Username string
    The username of workspace.
    CreateTime string
    The create time of workspace.
    DeleteProtectionEnabled bool
    Whether enable delete protection.
    Description string
    The description of workspace.
    Id string
    The ID of workspace.
    InstanceTypeId string
    The id of instance type.
    Name string
    The name of workspace.
    OverdueReclaimTime string
    The overdue reclaim time.
    ProjectName string
    The project name of vmp workspace.
    PrometheusPushIntranetEndpoint string
    The prometheus push intranet endpoint.
    PrometheusQueryIntranetEndpoint string
    The prometheus query intranet endpoint.
    PrometheusWriteIntranetEndpoint string
    The prometheus write intranet endpoint.
    Status string
    The status of workspace.
    Tags []GetWorkspacesWorkspaceTag
    The tags of vmp workspace.
    Username string
    The username of workspace.
    createTime String
    The create time of workspace.
    deleteProtectionEnabled Boolean
    Whether enable delete protection.
    description String
    The description of workspace.
    id String
    The ID of workspace.
    instanceTypeId String
    The id of instance type.
    name String
    The name of workspace.
    overdueReclaimTime String
    The overdue reclaim time.
    projectName String
    The project name of vmp workspace.
    prometheusPushIntranetEndpoint String
    The prometheus push intranet endpoint.
    prometheusQueryIntranetEndpoint String
    The prometheus query intranet endpoint.
    prometheusWriteIntranetEndpoint String
    The prometheus write intranet endpoint.
    status String
    The status of workspace.
    tags List<GetWorkspacesWorkspaceTag>
    The tags of vmp workspace.
    username String
    The username of workspace.
    createTime string
    The create time of workspace.
    deleteProtectionEnabled boolean
    Whether enable delete protection.
    description string
    The description of workspace.
    id string
    The ID of workspace.
    instanceTypeId string
    The id of instance type.
    name string
    The name of workspace.
    overdueReclaimTime string
    The overdue reclaim time.
    projectName string
    The project name of vmp workspace.
    prometheusPushIntranetEndpoint string
    The prometheus push intranet endpoint.
    prometheusQueryIntranetEndpoint string
    The prometheus query intranet endpoint.
    prometheusWriteIntranetEndpoint string
    The prometheus write intranet endpoint.
    status string
    The status of workspace.
    tags GetWorkspacesWorkspaceTag[]
    The tags of vmp workspace.
    username string
    The username of workspace.
    create_time str
    The create time of workspace.
    delete_protection_enabled bool
    Whether enable delete protection.
    description str
    The description of workspace.
    id str
    The ID of workspace.
    instance_type_id str
    The id of instance type.
    name str
    The name of workspace.
    overdue_reclaim_time str
    The overdue reclaim time.
    project_name str
    The project name of vmp workspace.
    prometheus_push_intranet_endpoint str
    The prometheus push intranet endpoint.
    prometheus_query_intranet_endpoint str
    The prometheus query intranet endpoint.
    prometheus_write_intranet_endpoint str
    The prometheus write intranet endpoint.
    status str
    The status of workspace.
    tags Sequence[GetWorkspacesWorkspaceTag]
    The tags of vmp workspace.
    username str
    The username of workspace.
    createTime String
    The create time of workspace.
    deleteProtectionEnabled Boolean
    Whether enable delete protection.
    description String
    The description of workspace.
    id String
    The ID of workspace.
    instanceTypeId String
    The id of instance type.
    name String
    The name of workspace.
    overdueReclaimTime String
    The overdue reclaim time.
    projectName String
    The project name of vmp workspace.
    prometheusPushIntranetEndpoint String
    The prometheus push intranet endpoint.
    prometheusQueryIntranetEndpoint String
    The prometheus query intranet endpoint.
    prometheusWriteIntranetEndpoint String
    The prometheus write intranet endpoint.
    status String
    The status of workspace.
    tags List<Property Map>
    The tags of vmp workspace.
    username String
    The username of workspace.

    GetWorkspacesWorkspaceTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    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