getSpaces

octopusdeploy 0.43.3, Jan 8 26

Viewing docs for octopusdeploy 0.43.3
published on Thursday, Jan 8, 2026 by octopusdeploylabs

Schema (JSON)

octopusdeploylabs/terraform-provider-octopusdeploy

Viewing docs for octopusdeploy 0.43.3
published on Thursday, Jan 8, 2026 by octopusdeploylabs

Schema (JSON)

octopusdeploylabs/terraform-provider-octopusdeploy

Example Usage

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

const spaces = octopusdeploy.getSpaces({
    ids: [
        "Spaces-123",
        "Spaces-321",
    ],
    partialName: "Defau",
    skip: 5,
    take: 100,
});

import pulumi
import pulumi_octopusdeploy as octopusdeploy

spaces = octopusdeploy.get_spaces(ids=[
        "Spaces-123",
        "Spaces-321",
    ],
    partial_name="Defau",
    skip=5,
    take=100)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/octopusdeploy/octopusdeploy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := octopusdeploy.GetSpaces(ctx, &octopusdeploy.GetSpacesArgs{
			Ids: []string{
				"Spaces-123",
				"Spaces-321",
			},
			PartialName: pulumi.StringRef("Defau"),
			Skip:        pulumi.Float64Ref(5),
			Take:        pulumi.Float64Ref(100),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var spaces = Octopusdeploy.GetSpaces.Invoke(new()
    {
        Ids = new[]
        {
            "Spaces-123",
            "Spaces-321",
        },
        PartialName = "Defau",
        Skip = 5,
        Take = 100,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.OctopusdeployFunctions;
import com.pulumi.octopusdeploy.inputs.GetSpacesArgs;
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 spaces = OctopusdeployFunctions.getSpaces(GetSpacesArgs.builder()
            .ids(            
                "Spaces-123",
                "Spaces-321")
            .partialName("Defau")
            .skip(5)
            .take(100)
            .build());

    }
}

variables:
  spaces:
    fn::invoke:
      function: octopusdeploy:getSpaces
      arguments:
        ids:
          - Spaces-123
          - Spaces-321
        partialName: Defau
        skip: 5
        take: 100

Using getSpaces

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 getSpaces(args: GetSpacesArgs, opts?: InvokeOptions): Promise<GetSpacesResult>
function getSpacesOutput(args: GetSpacesOutputArgs, opts?: InvokeOptions): Output<GetSpacesResult>

def get_spaces(ids: Optional[Sequence[str]] = None,
               partial_name: Optional[str] = None,
               skip: Optional[float] = None,
               take: Optional[float] = None,
               opts: Optional[InvokeOptions] = None) -> GetSpacesResult
def get_spaces_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               partial_name: Optional[pulumi.Input[str]] = None,
               skip: Optional[pulumi.Input[float]] = None,
               take: Optional[pulumi.Input[float]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSpacesResult]

func GetSpaces(ctx *Context, args *GetSpacesArgs, opts ...InvokeOption) (*GetSpacesResult, error)
func GetSpacesOutput(ctx *Context, args *GetSpacesOutputArgs, opts ...InvokeOption) GetSpacesResultOutput

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

public static class GetSpaces 
{
    public static Task<GetSpacesResult> InvokeAsync(GetSpacesArgs args, InvokeOptions? opts = null)
    public static Output<GetSpacesResult> Invoke(GetSpacesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSpacesResult> getSpaces(GetSpacesArgs args, InvokeOptions options)
public static Output<GetSpacesResult> getSpaces(GetSpacesArgs args, InvokeOptions options)

fn::invoke:
  function: octopusdeploy:index/getSpaces:getSpaces
  arguments:
    # arguments dictionary

The following arguments are supported:

Ids List<string>: A filter to search by a list of IDs.
PartialName string: A filter to search by a partial name.
Skip double: A filter to specify the number of items to skip in the response.
Take double: A filter to specify the number of items to take (or return) in the response.

Ids []string: A filter to search by a list of IDs.
PartialName string: A filter to search by a partial name.
Skip float64: A filter to specify the number of items to skip in the response.
Take float64: A filter to specify the number of items to take (or return) in the response.

ids List<String>: A filter to search by a list of IDs.
partialName String: A filter to search by a partial name.
skip Double: A filter to specify the number of items to skip in the response.
take Double: A filter to specify the number of items to take (or return) in the response.

ids string[]: A filter to search by a list of IDs.
partialName string: A filter to search by a partial name.
skip number: A filter to specify the number of items to skip in the response.
take number: A filter to specify the number of items to take (or return) in the response.

ids Sequence[str]: A filter to search by a list of IDs.
partial_name str: A filter to search by a partial name.
skip float: A filter to specify the number of items to skip in the response.
take float: A filter to specify the number of items to take (or return) in the response.

ids List<String>: A filter to search by a list of IDs.
partialName String: A filter to search by a partial name.
skip Number: A filter to specify the number of items to skip in the response.
take Number: A filter to specify the number of items to take (or return) in the response.

getSpaces Result

The following output properties are available:

Id string: The unique ID for this resource.
Spaces List<GetSpacesSpace>
Ids List<string>: A filter to search by a list of IDs.
PartialName string: A filter to search by a partial name.
Skip double: A filter to specify the number of items to skip in the response.
Take double: A filter to specify the number of items to take (or return) in the response.

Id string: The unique ID for this resource.
Spaces []GetSpacesSpace
Ids []string: A filter to search by a list of IDs.
PartialName string: A filter to search by a partial name.
Skip float64: A filter to specify the number of items to skip in the response.
Take float64: A filter to specify the number of items to take (or return) in the response.

id String: The unique ID for this resource.
spaces List<GetSpacesSpace>
ids List<String>: A filter to search by a list of IDs.
partialName String: A filter to search by a partial name.
skip Double: A filter to specify the number of items to skip in the response.
take Double: A filter to specify the number of items to take (or return) in the response.

id string: The unique ID for this resource.
spaces GetSpacesSpace[]
ids string[]: A filter to search by a list of IDs.
partialName string: A filter to search by a partial name.
skip number: A filter to specify the number of items to skip in the response.
take number: A filter to specify the number of items to take (or return) in the response.

id str: The unique ID for this resource.
spaces Sequence[GetSpacesSpace]
ids Sequence[str]: A filter to search by a list of IDs.
partial_name str: A filter to search by a partial name.
skip float: A filter to specify the number of items to skip in the response.
take float: A filter to specify the number of items to take (or return) in the response.

id String: The unique ID for this resource.
spaces List<Property Map>
ids List<String>: A filter to search by a list of IDs.
partialName String: A filter to search by a partial name.
skip Number: A filter to specify the number of items to skip in the response.
take Number: A filter to specify the number of items to take (or return) in the response.

Supporting Types

GetSpacesSpace

Description string: The description of this space.
Id string: The unique ID for this resource.
IsDefault bool: Specifies if this space is the default space in Octopus.
IsTaskQueueStopped bool: Specifies the status of the task queue for this space.
Name string: The name of this resource, no more than 20 characters long
Slug string: The unique slug of this space
SpaceManagersTeamMembers List<string>: A list of user IDs designated to be managers of this space.
SpaceManagersTeams List<string>: A list of team IDs designated to be managers of this space.

Description string: The description of this space.
Id string: The unique ID for this resource.
IsDefault bool: Specifies if this space is the default space in Octopus.
IsTaskQueueStopped bool: Specifies the status of the task queue for this space.
Name string: The name of this resource, no more than 20 characters long
Slug string: The unique slug of this space
SpaceManagersTeamMembers []string: A list of user IDs designated to be managers of this space.
SpaceManagersTeams []string: A list of team IDs designated to be managers of this space.

description String: The description of this space.
id String: The unique ID for this resource.
isDefault Boolean: Specifies if this space is the default space in Octopus.
isTaskQueueStopped Boolean: Specifies the status of the task queue for this space.
name String: The name of this resource, no more than 20 characters long
slug String: The unique slug of this space
spaceManagersTeamMembers List<String>: A list of user IDs designated to be managers of this space.
spaceManagersTeams List<String>: A list of team IDs designated to be managers of this space.

description string: The description of this space.
id string: The unique ID for this resource.
isDefault boolean: Specifies if this space is the default space in Octopus.
isTaskQueueStopped boolean: Specifies the status of the task queue for this space.
name string: The name of this resource, no more than 20 characters long
slug string: The unique slug of this space
spaceManagersTeamMembers string[]: A list of user IDs designated to be managers of this space.
spaceManagersTeams string[]: A list of team IDs designated to be managers of this space.

description str: The description of this space.
id str: The unique ID for this resource.
is_default bool: Specifies if this space is the default space in Octopus.
is_task_queue_stopped bool: Specifies the status of the task queue for this space.
name str: The name of this resource, no more than 20 characters long
slug str: The unique slug of this space
space_managers_team_members Sequence[str]: A list of user IDs designated to be managers of this space.
space_managers_teams Sequence[str]: A list of team IDs designated to be managers of this space.

description String: The description of this space.
id String: The unique ID for this resource.
isDefault Boolean: Specifies if this space is the default space in Octopus.
isTaskQueueStopped Boolean: Specifies the status of the task queue for this space.
name String: The name of this resource, no more than 20 characters long
slug String: The unique slug of this space
spaceManagersTeamMembers List<String>: A list of user IDs designated to be managers of this space.
spaceManagersTeams List<String>: A list of team IDs designated to be managers of this space.