1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. getProjectGroups
Viewing docs for octopusdeploy 0.43.3
published on Thursday, Jan 8, 2026 by octopusdeploylabs
Schema (JSON)
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.getProjectGroups

octopusdeploy logo
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 example = octopusdeploy.getProjectGroups({
    ids: [
        "ProjectGroups-123",
        "ProjectGroups-321",
    ],
    partialName: "Defau",
    skip: 5,
    take: 100,
});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.get_project_groups(ids=[
        "ProjectGroups-123",
        "ProjectGroups-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.GetProjectGroups(ctx, &octopusdeploy.GetProjectGroupsArgs{
			Ids: []string{
				"ProjectGroups-123",
				"ProjectGroups-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 example = Octopusdeploy.GetProjectGroups.Invoke(new()
    {
        Ids = new[]
        {
            "ProjectGroups-123",
            "ProjectGroups-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.GetProjectGroupsArgs;
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 = OctopusdeployFunctions.getProjectGroups(GetProjectGroupsArgs.builder()
            .ids(            
                "ProjectGroups-123",
                "ProjectGroups-321")
            .partialName("Defau")
            .skip(5)
            .take(100)
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: octopusdeploy:getProjectGroups
      arguments:
        ids:
          - ProjectGroups-123
          - ProjectGroups-321
        partialName: Defau
        skip: 5
        take: 100

    Using getProjectGroups

    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 getProjectGroups(args: GetProjectGroupsArgs, opts?: InvokeOptions): Promise<GetProjectGroupsResult>
function getProjectGroupsOutput(args: GetProjectGroupsOutputArgs, opts?: InvokeOptions): Output<GetProjectGroupsResult>
    def get_project_groups(ids: Optional[Sequence[str]] = None,
                       partial_name: Optional[str] = None,
                       skip: Optional[float] = None,
                       space_id: Optional[str] = None,
                       take: Optional[float] = None,
                       opts: Optional[InvokeOptions] = None) -> GetProjectGroupsResult
def get_project_groups_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       partial_name: Optional[pulumi.Input[str]] = None,
                       skip: Optional[pulumi.Input[float]] = None,
                       space_id: Optional[pulumi.Input[str]] = None,
                       take: Optional[pulumi.Input[float]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetProjectGroupsResult]
    func GetProjectGroups(ctx *Context, args *GetProjectGroupsArgs, opts ...InvokeOption) (*GetProjectGroupsResult, error)
func GetProjectGroupsOutput(ctx *Context, args *GetProjectGroupsOutputArgs, opts ...InvokeOption) GetProjectGroupsResultOutput

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

    public static class GetProjectGroups 
{
    public static Task<GetProjectGroupsResult> InvokeAsync(GetProjectGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectGroupsResult> Invoke(GetProjectGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetProjectGroupsResult> getProjectGroups(GetProjectGroupsArgs args, InvokeOptions options)
public static Output<GetProjectGroupsResult> getProjectGroups(GetProjectGroupsArgs args, InvokeOptions options)

    fn::invoke:
  function: octopusdeploy:index/getProjectGroups:getProjectGroups
  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.
    SpaceId string
    The space ID associated with this project group.
    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.
    SpaceId string
    The space ID associated with this project group.
    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.
    spaceId String
    The space ID associated with this project group.
    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.
    spaceId string
    The space ID associated with this project group.
    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.
    space_id str
    The space ID associated with this project group.
    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.
    spaceId String
    The space ID associated with this project group.
    take Number
    A filter to specify the number of items to take (or return) in the response.

    getProjectGroups Result

    The following output properties are available:

    Id string
    The unique ID for this resource.
    ProjectGroups List<GetProjectGroupsProjectGroup>
    A list of project groups that match the filter(s).
    SpaceId string
    The space ID associated with this project group.
    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.
    ProjectGroups []GetProjectGroupsProjectGroup
    A list of project groups that match the filter(s).
    SpaceId string
    The space ID associated with this project group.
    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.
    projectGroups List<GetProjectGroupsProjectGroup>
    A list of project groups that match the filter(s).
    spaceId String
    The space ID associated with this project group.
    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.
    projectGroups GetProjectGroupsProjectGroup[]
    A list of project groups that match the filter(s).
    spaceId string
    The space ID associated with this project group.
    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.
    project_groups Sequence[GetProjectGroupsProjectGroup]
    A list of project groups that match the filter(s).
    space_id str
    The space ID associated with this project group.
    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.
    projectGroups List<Property Map>
    A list of project groups that match the filter(s).
    spaceId String
    The space ID associated with this project group.
    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

    GetProjectGroupsProjectGroup

    Description string
    The description of this project group.
    Id string
    The unique ID for this resource.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this project group.
    Description string
    The description of this project group.
    Id string
    The unique ID for this resource.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this project group.
    description String
    The description of this project group.
    id String
    The unique ID for this resource.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this project group.
    description string
    The description of this project group.
    id string
    The unique ID for this resource.
    name string
    The name of this resource.
    spaceId string
    The space ID associated with this project group.
    description str
    The description of this project group.
    id str
    The unique ID for this resource.
    name str
    The name of this resource.
    space_id str
    The space ID associated with this project group.
    description String
    The description of this project group.
    id String
    The unique ID for this resource.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this project group.

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    Viewing docs for octopusdeploy 0.43.3
    published on Thursday, Jan 8, 2026 by octopusdeploylabs
    Schema (JSON)
    octopusdeploylabs/terraform-provider-octopusdeploy
      Try Pulumi Cloud free. Your team will thank you.